Skip to content

Files

A file is an image, a PDF or a video that you upload for a verification: a photo of a document side or page, a selfie, a video.

A file is not linked to an applicant when you create it. To use a file in a verification, add its file_id to a document: in the front_side_id, back_side_id, or other_side_1_id–other_side_3_id parameter of a Create document or Update a document request. Our system checks only the files that are linked to documents.

Typical flow

  1. Upload a file with the Create a file request and get file_id.
  2. Add file_id to a document of the applicant.
  3. Create a verification.

File requirements

RequirementValue
FormatsJPG, JPEG, PNG, HEIC, WEBP, BMP, GIF, PDF, MP4, WEBM
Maximum file size50 MB
Minimum image resolution440 px on the shortest side
Maximum image resolution100 megapixels

Our system detects the file format from the file content, not from the file name or extension. The file name is not stored.

What you can do

  • Upload a file
  • Replace the content of a file
Operations

Create a file

Request

Upload a file of a document side (page), a selfie, or a video. The response returns a file_id. Use it in the front_side_id, back_side_id, or other_side_1_id–other_side_3_id parameter of a Create document or Update a document request.

Send the file in the file field of a multipart/form-data body. See the file requirements in the Files section overview.

Image processing

Our system converts uploaded images to JPEG. If the longer side of an image is larger than 4096 px, our system reduces it to 4096 px. PDF and video files are not converted on upload.

Security
API-Key
Bodymultipart/form-datarequired
filestring, (binary)required

The file to upload, as binary data. Send one file per request.

{
  "file": "string"
}

Responses

OK

The request was successful, and our system created the file.

Bodyapplication/json
file_idstring, = 36 characters^[a-f0-9-]{36}$

The file unique identifier. Our system returns it in the response to the Create a file request. Use it in the front_side_id, back_side_id, or other_side_1_id–other_side_3_id parameter of a document.

Example:"3c4d5e6f7a8b3c4d5e6f7a8b3c4d5e6f7a8b"
Response
{
  "file_id": "3c4d5e6f7a8b3c4d5e6f7a8b3c4d5e6f7a8b"
}