API Reference

Upload a file

Upload a file and get an upload_ref to be used for Identity Document Check or Documents checks.


Maximum file size is at most 20Mo but may vary depending on the usage afterward.

The upload_ref is valid for about 1 day.

The accepted file formats are:

  • Image files:
    • .avif: AVIF image (image/avif)
    • .bmp: Windows OS/2 Bitmap Graphics (image/bmp)
    • .gif: Graphics Interchange Format (GIF, image/gif)
    • .jpeg, .jpg: JPEG images (image/jpeg)
    • .png: Portable Network Graphics (image/png)
    • .svg: Scalable Vector Graphics (SVG, image/svg+xml)
    • .tif, .tiff: Tagged Image File Format (TIFF, image/tiff)
    • .webp: WEBP image (image/webp)
  • Office files:
    • .doc: Microsoft Word (application/msword)
    • .docx: Microsoft Word (OpenXML, application/vnd.openxmlformats-officedocument.wordprocessingml.document)
    • .odp: OpenDocument presentation document (application/vnd.oasis.opendocument.presentation)
    • .ods: OpenDocument spreadsheet document (application/vnd.oasis.opendocument.spreadsheet)
    • .odt: OpenDocument text document (application/vnd.oasis.opendocument.text)
    • .pdf: Adobe Portable Document Format (PDF, application/pdf)
    • .ppt: Microsoft PowerPoint (application/vnd.ms-powerpoint)
    • .pptx: Microsoft PowerPoint (OpenXML, application/vnd.openxmlformats-officedocument.presentationml.presentation)
    • .vsd: Microsoft Visio (application/vnd.visio)
    • .xls: Microsoft Excel (application/vnd.ms-excel)
    • .xlsx: Microsoft Excel (OpenXML, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet)
  • Text files:
    • .csv: Comma-separated values (CSV, text/csv)
    • .json: JSON format (application/json)
    • .jsonld: JSON-LD format (application/ld+json)
    • .rtf: Rich Text Format (RTF, application/rtf)
    • .txt: Text, (generally ASCII or ISO 8859-n, text/plain)
  • Archive files:
    • .arc: Archive document (multiple files embedded, application/x-freearc)
    • .bz: BZip archive (application/x-bzip)
    • .bz2: BZip2 archive (application/x-bzip2)
    • .gz: GZip Compressed Archive (application/gzip)
    • .rar: RAR archive (application/vnd.rar)
    • .tar: Tape Archive (TAR, application/x-tar)
    • .zip: ZIP archive (application/zip)
    • .7z: 7-zip archive (application/x-7z-compressed)

See also

Learn more about Files

Language
Authorization
Header
Click Try It! to start a request and see the response here!