Skip to main

API Technical Specs

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

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

FieldData TypeRequiredDescription
AccountIdstringYesThe Account ID that is provided to you when establishing your Service Account.
ServiceKeystringYesThe Service key that is provided to access your account.

GetAccountInfoResponse

FieldData TypeDescription
CodestringA 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
SubCodestringA 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
MessagestringThis message further describes the subcode providing additional detail.
CreditsUsedintegerThe total number of credits that have been executed for the account.
CreditsRemainingdecimalThe number of credits that remain for the specified account.
ExpirationDatestringThe expiration date for the account.
MaximumConcurrentRequestsintegerThe 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.