Skip to content

Create document

Request

Create a new document object in our system

Security
API-Key
Bodyapplication/json
One of:

A government-issued internal identity document that certifies a citizen residency and regulates their movement within a country. It serves as a proof of identity and residence for administrative purposes and may be required for accessing certain services or permissions.

⚠️ Only one document with any of:

  • DOMESTIC_PASSPORT
  • DRIVERS_LICENSE
  • FOREIGN_CITIZEN_PASSPORT
  • GOVERNMENT_ID
  • PASSPORT
  • PERMANENT_RESIDENCE_PERMIT
  • REFUGEE_CARD

document type may be associated with one applicant object via applicant_id.

⚠️ After a verification was created, a new document may be added for the same applicant object via applicant_id, replacing the one added before.

applicant_idstring, = 36 charactersrequired

A unique identifier of an applicant, that is assigned by our system after an applicant object was created with a “Create an applicant” request

Example:"27c5caea93ee4656881ef9a30fadd21a3768"
typestringrequired
Default:"DOMESTIC_PASSPORT"
Example:"DOMESTIC_PASSPORT"
document_numberstring or null, <= 50 characters

A number of a document

Example:"TH703318A"
additional_numberstring or null, <= 50 characters

An additional number located on a document (e.g. tax ID number located on an ID card)

Example:"E2100007T-5"
issue_datestring or null, (date), <= 10 characters

An issue date of a document in YYYY-MM-DD format

Example:"2020-11-04"
expiry_datestring or null, (date), <= 10 characters

The date of document expiration, formatted according to ISO 8601

Example:"2028-11-04"
issuing_authoritystring or null, <= 255 characters

A name of a govenment entity that issues official documents

Example:"Social Security Administration"
front_side_idstring or null, = 36 characters

A unique identifier of a document file, that is assigned by our system after a file object was created with a “Create a file” request for a specific side (page) of a document

Example:"27c5caea93ee4656881ef9a30fadd21a3768"
back_side_idstring or null, = 36 characters

A unique identifier of a document file, that is assigned by our system after a file object was created with a “Create a file” request for a specific side (page) of a document

Example:"27c5caea93ee4656881ef9a30fadd21a3768"
other_side_1_idstring or null, = 36 characters

A unique identifier of a document file, that is assigned by our system after a file object was created with a “Create a file” request for a specific side (page) of a document

Example:"27c5caea93ee4656881ef9a30fadd21a3768"
other_side_2_idstring or null, = 36 characters

A unique identifier of a document file, that is assigned by our system after a file object was created with a “Create a file” request for a specific side (page) of a document

Example:"27c5caea93ee4656881ef9a30fadd21a3768"
other_side_3_idstring or null, = 36 characters

A unique identifier of a document file, that is assigned by our system after a file object was created with a “Create a file” request for a specific side (page) of a document

Example:"27c5caea93ee4656881ef9a30fadd21a3768"
{
  "applicant_id": "27c5caea93ee4656881ef9a30fadd21a3768",
  "type": "DOMESTIC_PASSPORT",
  "document_number": "TH703318A",
  "additional_number": "E2100007T-5",
  "issue_date": "2020-11-04",
  "expiry_date": "2028-11-04",
  "issuing_authority": "Social Security Administration",
  "front_side_id": "27c5caea93ee4656881ef9a30fadd21a3768",
  "back_side_id": "27c5caea93ee4656881ef9a30fadd21a3768",
  "other_side_1_id": "27c5caea93ee4656881ef9a30fadd21a3768",
  "other_side_2_id": "27c5caea93ee4656881ef9a30fadd21a3768",
  "other_side_3_id": "27c5caea93ee4656881ef9a30fadd21a3768"
}

Responses

OK

The request was successful, and our system returned an expected response.

Bodyapplication/json
document_idstring, = 36 characters

A unique identifier of a document, that is assigned by our system after a document object was created with a “Create a document” request

Example:"27c5caea93ee4656881ef9a30fadd21a3768"
Response
{
  "document_id": "27c5caea93ee4656881ef9a30fadd21a3768"
}