Uploads an image (and specifies the type of the image that is being uploaded) for a specific sessionId = {id}
- Only one image file can be uploaded with one request
- Veriff supports .jpg, .jpeg, .png, .heif, .heic, .webp and .pdf file formats in uploads
- The image file is defined as
base64
encoded image string inside a JSON body object - To avoid issues with upload, keep the image smaller than:
- Image files: 24MB in base64 encoding (approx 17MB in image files format)
- PDFs: 20 MB in pdf format
- Make sure the longer side of the uploaded image is max 1920px
Make sure that you upload all the images before setting the status to "submitted" using the PATCH /sessions/{sessionId} endpoint. If you try to upload media after you have submitted the session, you may encounter the 409 - conflict
error.
Note: always ensure that you use the correct API URL to send requests. See the API URL section for more info.
Note about different context types
Veriff expects you to define the context
of the uploaded media, which should indicate what has been captured on the uploaded image. See the Context types section[↗] for more information about different context types.
Note about PDF support
Veriff supports PDF file uploads for Identity and Document Verification (IDV) documents and Proof of Address (PoA) documents.
Please contact your Solutions Engineer before starting to upload PDF files.
Identity and Document Verification Feature
In IDV, document images can be uploaded in following configurations:
- Two PDF files, where one file contains document front image and the other file contains document back image
- Single PDF file, which has both document sides on different pages
- Single PDF file, which has both document sides on single page
Veriff processes first 5 pages of uploaded PDF file. System removes empty pages from the PDF.
Proof of Address Verification
The file that is uploaded for Proof of Address flow must contain only one PoA document. Max document size in 20MB.
Your integration's API key (occasionally referred to the "Token", "API public key" or "Publishable key")
Request body signed with the shared secret key
Session id
Context of the uploaded media, i.e., what the uploaded image was taken of. Veriff captures multiple images, therefore the image with the -pre
suffix is the first one, and the one without is the second image.
The media file to be uploaded, as base64 encoded image (.jpg, .jpeg, .png, .heif, .heic, .webp and .pdf formats are supported)
Timestamp of the upload
Upload status
UUID v4 which identifies the uploaded media
Name which identifies the uploaded media
Context type of the uploaded media
*Always returns None/null
Size of the uploaded media, in bytes
File type of the uploaded media, one of .jpg, .jpeg, .png, .heif, .heic, .webp or .pdf
Download URL of the media
UUID v4 of the verification session the uploaded media belongs to
Bad request
Unauthorized
Session not found
Internal server error
Article Versioning
Date | Description |
---|---|
May 2, 2025 | Updated the info about PDF files support for Proof of Address Verification flow to match the logic of Proof of Address Verification solution Note about multiple PDF uploads for PoA solution moved to the legacy Proof of Address Extraction documentation. |
Apr 21, 2025 | Added a note about the max length of the longer side of an image |
Mar 12, 2025 | Documentation published |