Skip to main content
POST
/
api
/
documents
Upload Document
curl --request POST \
  --url https://app.sphinxhq.com/api/documents/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "file": "<string>",
  "original_name": "<string>",
  "case_id": 123,
  "check_id": 123,
  "delete_after": 123
}
'
{
  "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.

Body

Write serializer for Document upload.

​
file
string<uri>
required

Base64 encoded file content. Allowed file types: PDF, PNG, JPG, CSV, XLSX, DOCX, MD.

​
original_name
string
required
Maximum string length: 255
​
case_id
integer

ID of the case

​
check_id
integer

ID of the check

​
delete_after
integer

Number of days until deletion. Use 0 for immediate deletion, or -1 for indefinite retention (never delete). Defaults to -1.

Response

201 - 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