Skip to main

API Technical Specs

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

Index a Resume

POST /v10/index/(indexId)/resume/(documentId)

Adds a single resume to an index.

  • You can try this endpoint out at our Swagger page ( US Data Center | EU Data Center )
  • Documents parsed by an account without AI Matching enabled will never be able to be used for matching/searching. For more information on enabling AI Matching reach out to

Path Parameters

ParameterData TypeDescription
indexIdstringThe id for the index where the document should be added (case-insensitive).
documentIdstringThe id to assign to the new document. This is restricted to alphanumeric with dashes and underscores. All values will be converted to lower-case.

Request Body

Parsed ResumeData from the Sovren Resume Parser. See Parse a Resume
The user-defined tags you want the document to have.

Sample Request

{ ... 
ResumeData :  "...",[ ... 

Response Body

Information explaining the outcome of the transaction.
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

Unauthorized - Your account doesn't have permission to perform this operation

DataNotFound - Data with the specified name wasn't found
This message further describes the code providing additional detail.
The (GUID) id for a specific API transaction. Use this when contacting about issues.
The version of the parsing/matching engine running under-the-hood.
The version of the API.
How long the transaction took on Sovren's server, in milliseconds. If the transaction takes longer to complete on the client side, that extra duration is solely network latency.
How many credits the transaction costs.How many credits the transaction costs.
Information about the customer who made the API call.
The AccountId for the account.
The customer name on the account.
The client IP Address where the API call originated.
The region for the account, also known as the 'Data Center'.
The number of credits remaining to be used by the account.
The number of credits used by the account.
The number of requests that can be made at one time.
The date that the current credits expire.

Sample Response

{ ... 
{ ... 
Code :  "string",Message :  "string",TransactionId :  "string",EngineVersion :  "string",ApiVersion :  "string",TotalElapsedMilliseconds :  0,TransactionCost :  0,{ ... 
AccountId :  "string",Name :  "string",IPAddress :  "string",Region :  "string",CreditsRemaining :  0,CreditsUsed :  0,ExpirationDate :  "2021-12-31",MaximumConcurrentRequests :  0,