Skip to main

API Technical Specs

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

Index a Document

POST /v9/index/(indexId)/documents/(documentId)

Adds a single document to an index.

Notes

  • 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 sales@sovren.com

Request Body

ParsedDocumentrequiredstring
Parsed JSON from the Sovren Resume or Job Order Parser.
CustomIdsrequiredstring[]
The custom ids you want the document to have.

Sample Request

{ ... 
ParsedDocument :  "",[ ... 
"",
],
}

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

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

DataNotFound - Data with the specified name wasn't found
Info.Messagestring
This message further describes the code providing additional detail.
Valueobject
An empty object.

Sample Response

{ ... 
{ ... 
Code :  "",Message :  "",
},
{ ... 
},
}