Retrieve a document
GET/documents/:id
Retrieve a document.
Request
Path Parameters
Identifies the resource.
Responses
200: Successful response
- application/json
- Schema
- Example (from schema)
Schema
data
object
Identifies the resource.
Identifies the type of the resource.
ISO 8601 formatted date-time indicating when the resource was created.
ISO 8601 formatted date-time indicating when the resource was updated.
The document's content_type.
size
object
Indicates the document's filesize
Identifies the unit
The number of bytes
Indicates the document's filesize
Possible values: [pending
, verified
, denied
]
Indicates the current document reviewing status
The document's SHA256 hash provided for optional verification purposes.
The filename of the document.
Optional reference string for customer tracking.
{
"data": {
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"record_type": true,
"created_at": "2018-02-02T22:25:27.521Z",
"updated_at": "2018-02-02T22:25:27.521Z",
"content_type": "application/pdf",
"size": {
"unit": "bytes",
"amount": 123456
},
"status": "pending",
"sha256": "08a96c641c3a74e44eb59afb61a24f2cb9f4d7188748e76ba4bb5edfa3cb7d1c",
"filename": "test-document.pdf",
"customer_reference": "MY REF 001"
}
}
default: Unexpected error
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
errors
Error[]
source
object
JSON pointer (RFC6901) to the offending entity.
Indicates which query parameter caused the error.
{
"errors": [
{
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string"
},
"meta": {}
}
]
}