Get a Document🔗︎

HTTP Verb	Path
GET	/v9/index/(indexId)/documents/(documentId)

Retrieves a single document from an index.

Info

You can try this endpoint out at our Swagger page ( US Data Center | EU Data Center | AU 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.

Parameter	Data Type	Description
indexId	string	The id for the index that contains the document (case-insensitive).
documentId	string	The id of the document to retrieve (case-insensitive).

Response Body🔗︎

Info 🔗︎ object

Information explaining the outcome of the transaction.

Info properties

Code 🔗︎ string

Code	Description
`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

Message 🔗︎ string

This message further describes the code providing additional detail.

Value 🔗︎ string

The JSON document in string format.

Sample JSON

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