Get Account Info🔗︎

HTTP Verb	Path
GET	/v9/account

Retrieve your account's current information. See Standard Transaction Cost

Info

You can try this endpoint out at our Swagger page ( US Data Center | EU Data Center | AU Data Center )
You should only call this endpoint if you are batch parsing.

Response Body🔗︎

Info 🔗︎ object

Info🔗︎

Information explaining the outcome of the transaction.

Info properties

Code 🔗︎ string

Message🔗︎

This message further describes the code providing additional detail.

Value 🔗︎ object

Value🔗︎

Contains response data for the transaction.

Value properties

CreditsRemaining 🔗︎ decimal

CreditsRemaining🔗︎

The total number of credits remaining for the account.

CreditsUsed 🔗︎ decimal

CreditsUsed🔗︎

The total number of credits that have been executed for the account.

MaximumConcurrentRequests 🔗︎ integer

MaximumConcurrentRequests🔗︎

The maximum amount of bulk concurrent requests that your account is allowed to submit to the web service. This doesn't pertain to parsing transactions initiated by an end user ("Ad Hoc Transaction"), but is intended to limit concurrent transactions when a batch of documents need to be parsed in a background process that is controlled by developers ("Batch Transaction"). If you need to process a batch with more concurrent requests reach out to sales@textkernel.com. More details can be found in the Acceptable Use Policy

ExpirationDate 🔗︎ string

ExpirationDate🔗︎

The expiration date for the account.

Sample JSON

{
  "Info": {
    "Code": "",
    "Message": ""
  },
  "Value": {
    "CreditsRemaining": 0,
    "CreditsUsed": 0,
    "MaximumConcurrentRequests": 0,
    "ExpirationDate": ""
  }
}

Code	Description
`Success`	Successful transaction
`MissingParameter`	A required parameter wasn't provided
`InvalidParameter`	A parameter was incorrectly specified
`AuthenticationError`	An error occurred with the credentials provided