Create Sub-Account

API Technical Specs Policies FAQs Documents Release Notes

POST https://accounts.resumeparsing.com/api

Create a new SaaS Sub-Account

Request Body

AccountNamerequiredstring

A name for the new sub-account. Names must be less than 100 characters.

Regionrequiredstring

The Data Center this account will be located in. See Endpoints. One of:

MatchingEnabledoptionalbool

If AI Matching should be enabled on the account. If not specified, this defaults to false. Note: This will increase all parsing transaction costs. See Standard Transaction Cost

CreditsToAddoptionaldecimal

How many SaaS Credits to allocate to this account. If this is not set, Unrestricted must be true

Unrestrictedoptionalbool

If the account should have unrestricted access to your SaaS Credits. If this is not set, CreditsToAdd must have a value greater than 0.

Sample Request

{ ...
"AccountName" : "string","Region" : "string","MatchingEnabled" : false,"CreditsToAdd" : 1000,"Unrestricted" : false}

Response Body

AccountIdstring

The AccountId of the new account to be used when authenticating with the SaaS API.

ServiceKeystring

The ServiceKey of the new account to be used when authenticating with the SaaS API.

AccountNamestring

The name of the new account. This will match the value used in the request.

Regionstring

The Sovren Data Center the new account belongs to. This will match the value used in the request.

MatchingEnabledbool

If AI Matching is enabled on the new account. This will match the value used in the request.

Activebool

The new account's status. This will always be true for new accounts.

ErrorMessagestring

If an error occured, this will give a detailed message on what happened. If no error occured, this will be empty.

Sample Response

{ ...
"AccountId" : "string","ServiceKey" : "string","AccountName" : "string","Region" : "string","MatchingEnabled" : false,"Active" : true,"ErrorMessage" : "string"}