Skip to main content
POST
/
api
/
v3
/
upload
/
{applicant_id}
Upload document
curl --request POST \
  --url https://api.dataspike.io/api/v3/upload/{applicant_id} \
  --header 'Content-Type: multipart/form-data' \
  --header 'ds-api-token: <api-key>' \
  --form file='@example-file' \
  --form document_type=undefined \
  --form side=front \
  --form issued_country=AAA
{
  "document_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
  "detected_document_type": "passport",
  "detected_document_side": "front",
  "detected_two_side_document": true,
  "detected_country": "FI"
}

Authorizations

​
ds-api-token
string
header
required

Path Parameters

​
applicant_id
string<uuid>
required

Existing Applicant Id

Example:

"01827ed4-c928-7a3c-9a30-7ab7cc169d11"

Body

​
file
file
required
Example:

"@passport_photo.jpeg"

​
document_type
enum<string>
required

Possible document type

​
side
enum<string>

Possible document side

Available options:
front,
back
​
issued_country
string<ISO 3166-1 alpha-3>

Country issued document in ISO 3166-1 alpha-3 format.

Example:

"AAA"

Response

Document Id for an uploaded file

​
document_id
string<uuid>
Example:

"01827ed4-c928-7a3c-9a30-7ab7cc169d11"

​
detected_document_type
enum<string> | null

Possible document type

Available options:
passport,
id_card,
residence_permit,
driver_license,
poa,
selfie,
liveness_photo,
kyb_certificate_of_incorporation,
kyb_ownership_document
​
detected_document_side
enum<string> | null

Possible document side

Available options:
front,
back
​
detected_two_side_document
boolean
​
detected_country
string

Country in ISO 31661-1 alpha-2 code

Example:

"FI"