API Technical Specs
Learn how to configure and leverage our services to achieve your toughest recruiting needs.
Get Account Info
The GetAccountInfo() web service method retrieves your account's current information.
This is the web method signature:
GetAccountInfoResult GetAccountInfo(string accountId, string serviceKey)
GetAccountInfoRequest
Field | Data Type | Required | Description |
---|---|---|---|
AccountId | string | Yes | The Account ID that is provided to you when establishing your Service Account. |
ServiceKey | string | Yes | The Service key that is provided to access your account. |
GetAccountInfoResponse
Field | Data Type | Description |
---|---|---|
Code | string | A response code indicating the success or failure of the operation. The following is a list of codes that can be returned by the service: Success – Successful transaction Error - The document wasn't parsed because of an error |
SubCode | string | A response subcode elaborating on the 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 |
Message | string | This message further describes the subcode providing additional detail. |
CreditsUsed | integer | The total number of credits that have been executed for the account. |
CreditsRemaining | decimal | The number of credits that remain for the specified account. |
ExpirationDate | string | The expiration date for the account. |
MaximumConcurrentRequests | integer | 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@sovren.com. More details can be found in Sovren's Acceptable Use Policy. |