IDV Tickets
1. Event Types
Our webhook service supports two events, which describe the status of a flow. Those are:
ticket.verification.in_progress: your flow has completed a number of steps (subprocesses) and is waiting for user's intervention to continue to next steps or to retry previous failed one.
ticket.verification.completed: your flow has completed its processing. It has been either
ACCEPTED
orREJECTED
.
1.1 Verification - In Progress event
The ticket.verification.in_progress event is triggered when a Verification has completed a number of steps (subprocesses) and it's waiting for user-intervention to continue if it's appropriate. Notification payload specifies a set of properties as shown on following JSON. It will contain its ticket, so it can be tracked by your processes. Also, it holds its event, and its sub_event, which will be explained later. The property flow_status determines ticket's current state. The value of the disposition property can either be PASSED
, FAILED
or RETRY
, which determines last executed subprocess' state. It also specifies how many attempts can be done on property remaining_attempts if disposition has been set as RETRY
. Property data contains suprocesses results, which we'll take a look afterwards.
In Progress Event disposition statuses
PASSED:
all subprocesses were executed correctly and their results have been considered as OK.RETRY
: this status is set when an exception has been raised, or any subprocess' result has been considered as unacceptable and has retries to attempt, eg. liveness detection process.FAILED
, this status is set when an exception has been raised, or any subprocess' result has been considered as unacceptable and no more retries can be atempted, eg. liveness detection process.
Subevents
In this property, we will receive one of both values: verification.liveness
and verification.id_proofing
verification.liveness subevent
This subevent is triggered when biometrical subprocesses were executed, which consist of Facial analysis
and Liveness detection
. In this subevent, property data contains biometrical subprocesses' results. An example is shown bellow:
verification.id_proofing subevent
This subevent is triggered when Identity verification subprocesses were executed, which consist of Document detection
, Id proofing
and Photo matching
. In this subevent, property data contains identity verification subprocesses' results. An example is shown bellow:
1.2 Verification - Completed event
The ticket.verification.completed event is triggered when a Verification has completed all of its subprocesses, or an error has been raised and there are no more retries to attempt. Notification payload specifies a set of properties as shown on following JSON. It will contain its ticket, so it can be tracked by your processes. Also, it holds its event. The flow_status specified ticket's current state, which can be either ACCEPTED
or REJECTED
, this value depends on confidence_score property. The value of the disposition property can be either PASSED
or FAILED
which determines last executed subprocess' state. It also gives final results of entire flow, such as risk_code and confidence_score.
Completed Event flow_status statuses
ACCEPTED
: all flow's subprocesses were executed correctly and confidence_score has got toACCEPTED
scoring threshold.REJECTED
: this status is set when an exception has been raised, or any subprocess' result has been considered as unacceptable and no more retries can be atempted and confidence_score has got toREJECTED
scoring threshold.
Completed Event disposition statuses
PASSED:
all flow's subprocesses were executed correctly and their results have been considered as OK, so ticket is set to COMPLETED state.FAILED
, this status is set when an exception has been raised, or any subprocess' result has been considered as unacceptable and no more retries can be atempted, eg. liveness detection process.
Here you find a further description of the response values below, it represents both event responses as these share the same response structure:
Last updated