This topic describes how to capture image files and also lists the image requirements (see also the OpenAPI documentation).
Images are an important part of an eIDV flow. End-users must provide images of their ID document and, in some cases, also provide/capture selfie images of themselves.
The way these images are sent to the provider may vary but those images are always kept as part of the process. The next sections provide detail on how to use images in identity proofing processes.
# Capturing ID images
This table summarises the available approaches for each provider:
|eIDV provider||Direct upload using Assure (backend)||Web SDK (frontend)*||iOS SDK (frontend)*||Android SDK (frontend)*|
* Available only for the
documentSelfie process types.
** Must always be combined with iOS/Android SDK to capture the face map (for more details, see
facetecEnrollment in the OpenAPI docs).
# Why aren’t all options available for all providers?
Each provider has specific requirements for how the images are captured. This means that some providers accept methods that others don’t. For example, Electronic IDentification requires that a video is recorded during image capturing and ReadID requires that images are captured by an NFC capable device.
Still, the Assure API integrates with all available options for each provider.
# Why should I use the provider’s SDK to capture the images?
The providers’ SDKs help and guide the end-user with capturing the images. This improves the image quality and, by consequence, the quality of the final result.
Tip: For this reason, we highly encourage using the provider’s SDK for capturing the ID images.
# Using direct upload
To directly upload images through the Assure API you must use the Set images service. Check the section below for details on how to use that service.
# Using provider’s SDK
To use the provider’s SDK you can either use the eIDV alternative flow services (if you are in a web context) or you must integrate with the provider’s SDK.
# Image requirements
Regardless the images are uploaded directly to the provider or captured using their SDK, each provider has requirements and guidelines for the ID images:
|Provider||Supported image formats (for direct upload)||Image size (for direct upload)||Details regarding images|
|Onfido||JPEG, PNG||Between 32KB and 10MB|
|Signicat Paper||JPEG, PNG|| ||If you use Signicat Paper as a Connect method these requirements apply.|
|ReadID||N/A||N/A||ReadID does their own capture of the images, i.e. you cannot upload them directly to them.|
|FaceTec||JPEG, PNG|| |