Skip to main content
GET
/
api
/
documents
/
{id}
Get Document
curl --request GET \
  --url https://app.sphinxhq.com/api/documents/{id}/ \
  --header 'Authorization: Bearer <token>'
{
  "id": 123,
  "check": 123,
  "file": "<string>",
  "original_name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "case": 123,
  "delete_after": -1
}

Authorizations

​
Authorization
string
header
required

OAuth2 access token obtained from POST /api/oauth/token/ using client credentials.

Path Parameters

​
id
integer
required

A unique integer value identifying this checks document.

Response

200 - application/json

Read-only serializer for Document.

​
id
integer
required
​
check
integer
required
​
file
string
required

Base64 encoded file content.

​
original_name
string
required
Maximum string length: 255
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
case
integer | null
​
delete_after
integer

Days until deletion. -1 means never delete.

Required range: -2147483648 <= x <= 2147483647