Skip to main content
GET
/
documents
/
{document_id}
Returns all documents for a user entry
curl --request GET \
  --url https://api.sandbox.goteal.co/documents/{document_id} \
  --header 'X-API-KEY: <api-key>'
{
  "document_id": "95a0e70b-fe02-4f47-aef9-2efff279df71",
  "file_name": "payslip1.pdf",
  "type": "Payslip",
  "upload_time": "2019-05-17T00:00:00.000Z",
  "file_contents": "JVBERi0xLjQKJdPr6eEKMSAwIG9iago8PC9UaXRsZSAoS...",
  "document_external_id": "payslip123456"
}

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
document_id
string
required

The id of the file

Response

Document response

​
document_id
string<uuid>
required

A unique document identifier

Example:

"95a0e70b-fe02-4f47-aef9-2efff279df71"

​
file_name
string
required

Name of the file

Example:

"payslip1.pdf"

​
type
string
required

The type of document

Example:

"Payslip"

​
upload_time
string<date-time>
required
Example:

"2019-05-17T00:00:00.000Z"

​
file_contents
string
required

Base-64 encoded string containing file contents

Example:

"JVBERi0xLjQKJdPr6eEKMSAwIG9iago8PC9UaXRsZSAoS..."

​
document_external_id
string

A string coming from the parameters of the uploaded payslip1.pdf either the form field name or external_document_id header for the file part. It might not be unique and depends on what's passed when uploading.

Example:

"payslip123456"