Skip to main content

ID Verification

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.

Configuration Options

NameTypeDescription
reservationIdStringThe Autohost ID of the reservation.
callbacksIDVCallbacksAn object defining callbacks to be fired when certain events occur. See the IDV Component page for more information.
primaryColor (optional)StringThe colour to use as the primary colour for all UI components.
locale (optional)LocalesThe language to display the component in.

IDVCallbacks

NameParametersEvent
onDoctypeSelecteddocType: 'passport', 'id', 'selfie'User has selected their document type.
onIDVCompletecard: CardUser has succesfully completed ID Verification.
onStartImageUploadstep: StepsUser has submitted an image.
onImageUploadCompletestep: StepsThe image has been accepted and verified.
onImageUploadFailedstep: Steps, errorMessage: stringThe 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.
onIDScannerOpenedUser has opened the mobile ID Scanner.
onIDScannerClosedThe mobile ID scanner has been closed.
onSkippedIDVUser 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.
onRemoteSessionStartedUser has started a remote camera session.
onRemoteSessionUpdateupdate: RemoteScanUpdateUser has completed a step with the remote camera.
onRemoteSessionCompleteUser has completed ID verification with the remote camera. onIDVComplete will also be called at this time.

Card

Nametype
addressstring
birth_datestring
country_codestring
document_numberstring
document_typestring
expiry_datestring
first_namestring
full_namestring
issue_datestring
last_namestring
processing_statusstring
recognition_statusstring
sexstring

Steps

Step Name
scan
front
back
selfie

RemoteScanUpdate

Nametype
stepSteps
statusScanStatuses
resultUploadImageResponse

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

Nametype
card (optional)Card
codestring
summarystring