ngrok
to forward the requests to your local development server.VERIFICATION_COMPLETED
: The Verification has completed processing and is ready to be reviewed in your developer dashboard.VERIFICATION_REVIEWED
: The Verification has been approved
or declined
in your developer dashboard. DATAPOINT_UPDATED
: The Verification has one or more data points updated post processing.WATCHLIST_MONITORING
: The Identity returns as not clean from the adverse media and / or watchlist check.IDENTITY_AUTHENTICATED
: The Authentication has successfully been approved
through Biometric Authentication. VERIFICATION_REVIEWED
event, VERIFICATION_COMPLETED
has fired as well.VERIFICATION_COMPLETED
event is triggered when a Verification has completed processing and awaits to be reviewed (accepted or declined) either manually or automatically through our Automated Thresholds feature. The value of the status property can either be pending
if the verification lands in manual review, or approved
or, declined
if you have automated thresholds enabled.pending
, this is the default status of a VERIFICATION_COMPLETED
event if there are no automated thresholds enabled in your developer dashboard. The Verification is now displayed in your developer dashboard and ready to be reviewed.approved
, this is the status when a Verification passed the auto-review threshold set in your developer dashboard.declined
, this is the status when a Verification failed to pass the auto-review threshold set in your developer dashboard.VERIFICATION_COMPLETED
webhook event will display a status of approved
or declined
even if the Verification returns a dirty watchlist check and is a status of pending
within the developer dashboard. Click here to learn more.event
string
key
string
status
string
created
integer
updated
integer
processed
integer
VERIFICATION_REVIEWED
event is triggered when a Verification status has changed. This will happen if the Verification has been approved or declined in your dashboard, or the automation has automatically approved or declined based on a threshold set by you (e.g. >80%). The value of the status property can be approved
, declined
or pending
. The status will only be pending
if a verification was previously approved
then returned a not clean watchlist check.key
. Please take a look at the API section and integration best practices for more information.approved
, this is the status when you approve a Verification manually in your developer dashboard or when it passed the auto-review threshold.declined
, this is the status when you decline a Verification manually in your developer dashboard or when it failed to pass the auto-review threshold.pending
, this is the status when a Verification was previously approved or declined but returns a not clean watchlist check results and is therefore rolled back to pending state for manual review.VERIFICATION_REVIEWED
webhook event will display a status of approved
or declined
even if the Verification returns a dirty watchlist check and is a status of pending
within the developer dashboard. Click here to learn more.event
string
key
string
status
string
created
integer
updated
integer
processed
integer
DATAPOINT_UPDATED
event is triggered when an Identity's data points have been updated. This will happen if the Verification has already been processed, and one or more data points, including liveness score, facematch score, or id authenticity score, are updated. The webhook payload will include the type
and value
of the updated data points.key
. Please take a look at the API section and integration best practices for more information.event
string
key
string
resource_key
string
type
string
value
string
created
integer
updated
integer
WATCHLIST_MONITORING
webhook event is only available within the developer dashboard if the Watchlist Check feature is enabled. Click here to learn more.WATCHLIST_MONITORING
event will be triggered when an Identity's AML Profile is returns as not clean from the adverse media and / or watchlist check. The value of the clean property will default tofalse
.key
. Please take a look at the API section and integration best practices for more information.false
, this is the default value of the WATCHLIST_MONITORING
event.event
string
key
string
clean
boolean
types
array
created
integer
updated
integer
IDENTITY_AUTHENTICATED
webhook event is only available within the developer dashboard if the Biometric Authentication feature is enabled. Click here to learn more.IDENTITY_AUTHENTICATED
event will be triggered when an Authentication is created indicating an Identity has successfully authenticated through the Biometric Authentication feature. key
. Please take a look at the API section and integration best practices for more information.approved
, this is the default status of the IDENTITY_AUTHENTICATED
event.event
string
key
string
status
string
created
integer
updated
integer
processed
integer
request_body
is the response you received via the webhook. The cipher initialization vector will be sent over in the first 16 bytes of the response.POST
endpoint of a server, like in the example below:widgets/webhooks
: