Skip to main

API Technical Specs

Learn how to configure and leverage our services to achieve your toughest recruiting needs.
SaaS     |

Get Account Info

GET /v9/account

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

Notes

Response Body

Infoobject
Information explaining the outcome of the transaction.
Info.Codestring
A response code elaborating on the HTTP status code.
The following is a list of codes that can be returned by the service:

Success – Successful transaction

MissingParameter - A required parameter wasn't provided

InvalidParameter - A parameter was incorrectly specified

AuthenticationError - An error occurred with the credentials provided
Info.Messagestring
This message further describes the code providing additional detail.
Valueobject
Contains response data for the transaction.
Value.CreditsRemainingdecimal
The total number of credits remaining for the account.
Value.CreditsUseddecimal
The total number of credits that have been executed for the account.
Value.MaximumConcurrentRequestsinteger
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 tosales@sovren.com. More details can be found in Sovren's Acceptable Use Policy.
Value.ExpirationDatestring
The expiration date for the account.

Sample Response

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