Events Callback

When events occur for the User, AiPrise sends a callback (a Post Request) to the events_callback_url

There are two ways to set the events_callback_url

Set the events_callback_url at the template level. This can be set from the Dashboard > View Templates> {Template ID}
Set the events_callback_url in Additional Settings when running a new verification session for the user

Note

In case events_callback_url is passed as part of Additional Settings when doing a verification, it will take precedence over the one set at template level.

Type of Callback Events

VERIFICATION_SESSION_STARTED

Payload:

Key	Value
event_type	The type of event callback. Here, it will be `VERIFICATION_SESSION_STARTED`
verification_session_id	The ID associated with the verification session
client_reference_id	The ID provided as client_reference_id at the time of session creation

VERIFICATION_REQUEST_SUBMITTED

Payload:

Key	Value
event_type	The type of event callback. Here, it will be `VERIFICATION_REQUEST_SUBMITTED`
verification_session_id	The ID associated with the verification session
client_reference_id	The ID provided as client_reference_id at the time of session creation

CASE_STATUS_UPDATE

Payload:

Key	Value
event_type	The type of event callback. Here, it will be `CASE_STATUS_UPDATE`
verification_session_id	The ID associated with the verification session
verification_result	The result of the verification session
reason	Information about the reason due to which the case status was manually declined from the dashboard
reason.code	Selected reason code while declining the case
reason.message	Message associated with the reason for declining the case
author	Information about the person that updated the status
author.email	Email address of the person
client_reference_id	The ID provided as client_reference_id at the time of session creation

AML_MONITORING_UPDATE

Payload:

Key	Value
event_type	The type of event callback. Here, it will be `AML_MONITORING_UPDATE`
data	Data associated with the session
data.verification_session_id	The ID associated with the verification session
data.template_id	The ID associated with the template
data.aml_monitoring_update	New, Removed and Updated entity names against which a hit has occurred