Skip to main

API Technical Specs

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

Get a Document

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

Retrieves a single document from an index.

Notes

  • You can try this endpoint out at our Swagger page ( US Data Center | EU Data Center )
  • There should never be a need to call this endpoint. You should store/retrieve documents in your own database, since documents stored in indexes will have all PII redacted.

Path Parameters

ParameterData TypeDescription
indexIdstringThe id for the index that contains the document (case-insensitive).
documentIdstringThe id of the document to retrieve (case-insensitive).

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.
Valuestring
The JSON document in string format.

Sample Response

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