SDK ID Verification Component
Description
The ID Verification component requires a user to submit an image of their government-issued ID document, and a selfie. View the ID Verification page in the knowledge base to learn more.
Video Demo
Configuration Options
| Name | Type | Description |
|---|---|---|
| reservationId | String | The Autohost ID of the reservation. |
| callbacks | IDVCallbacks | An object defining callbacks to be fired when certain events occur. See the IDV Component page for more information. |
| primaryColor (optional) | String | The colour to use as the primary colour for all UI components. |
| locale (optional) | Locales | The language to display the component in. |
IDVCallbacks
| Name | Parameters | Event |
|---|---|---|
| onDoctypeSelected | docType: 'passport', 'id', 'selfie' | User has selected their document type. |
| onIDVComplete | card: Card | User has succesfully completed ID Verification. |
| onStartImageUpload | step: Steps | User has submitted an image. |
| onImageUploadComplete | step: Steps | The image has been accepted and verified. |
| onImageUploadFailed | step: Steps, errorMessage: string | The image has been rejected. This could be because it is illegible, not an image of an ID document, or a person for the selfie, or there is something else wrong with the image. |
| onIDScannerOpened | User has opened the mobile ID Scanner. | |
| onIDScannerClosed | The mobile ID scanner has been closed. | |
| onSkippedIDV | User has skipped ID verification. After two failed attempts, a user can skip uploading their ID document. Instead, they are prompted to take a selfie holding their ID, and the reservation is flagged for manual review. | |
| onRemoteSessionStarted | User has started a remote camera session. | |
| onRemoteSessionUpdate | update: RemoteScanUpdate | User has completed a step with the remote camera. |
| onRemoteSessionComplete | User has completed ID verification with the remote camera. onIDVComplete will also be called at this time. |
Card
| Name | type |
|---|---|
| address | string |
| birth_date | string |
| country_code | string |
| document_number | string |
| document_type | string |
| expiry_date | string |
| first_name | string |
| full_name | string |
| issue_date | string |
| last_name | string |
| processing_status | string |
| recognition_status | string |
| sex | string |
Steps
| Step Name |
|---|
| scan |
| front |
| back |
| selfie |
RemoteScanUpdate
| Name | type |
|---|---|
| step | Steps |
| status | ScanStatuses |
| result | UploadImageResponse |
ScanStatuses
| Status Name |
|---|
| STEP_1_REMOTE_CAMERA_IS_REQUESTED |
| STEP_2_EXCHANGE_LINK_IS_GENERATED |
| STEP_3_REMOTE_CAMERA_IS_PENDING |
| STEP_4_REMOTE_CAMERA_IS_OPEN |
| STEP_5_IMAGE_IS_UPLOADING |
| STEP_6_IMAGE_IS_PROCESSING |
| STEP_7_RESULT_IS_AVAILABLE |
| ERROR_HAPPENED |
UploadImageResponse
| Name | type |
|---|---|
| card (optional) | Card |
| code | string |
| summary | string |
