User Profile Events Callback

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 > {TemplateID}.
Set the events_callback_url URL with each create user profile request using the parameter events_callback_url.

📘
Note
In case events_callback_url is set in the create user profile request, it will take precedence over the one set at the template level.

Types of Events Callback

USER_PROFILE_CREATE

Payload:

Key	Value
user_profile_event_type	The type of event callback. Here, it will be`USER_PROFILE_CREATE`
user_profile_id	The ID associated with the user profile
author_id	The email of the User who created the profile or `SOURCE_API` if created via API Integration

USER_PROFILE_INFO_UPDATE

Payload:

Key	Value
user_profile_event_type	The type of event callback. Here, it will be`USER_PROFILE_INFO_UPDATE`
user_profile_id	The ID associated with the user profile
author_id	The email of the User who updated the profile or `SOURCE_API` if created via API Integration

RUN_USER_VERIFICATION

Payload:

Key	Value
user_profile_event_type	The type of event callback. Here, it will be`RUN_USER_VERIFICATION`
user_profile_id	The ID associated with the user profile
	Additionally, all fields from https://docs.aiprise.com/docs/verification-result-1
related_companies For customers with `Multi Level Business Profiles` enabled, where all Related Persons of the Business are represented by User Profiles, we send additional data that contains information of all Business Profiles that the business officer is related to	All fields from Related Companies V2

For customers with Multi Level Business Profiles enabled, where all Related Persons of the Business are represented by User Profiles, we send additional data that contains information of all Business Profiles that the business officer is related to

ADD_ADDITIONAL_MEDIA

Payload:

Key	Value
user_profile_event_type	The type of event callback. Here, it will be`ADD_ADDITIONAL_MEDIA`
user_profile_id	The ID associated with the user profile
file_uuid	Unique ID associated with the added media

DELETE_ADDITIONAL_MEDIA

Payload:

Key	Value
user_profile_event_type	The type of event callback. Here, it will be`DELETE_ADDITIONAL_MEDIA`
user_profile_id	The ID associated with the user profile
file_uuid	Unique ID associated with the added media

COMMENT

Payload:

Key	Value
user_profile_event_type	The type of event callback. Here, it will be`COMMENT`
user_profile_id	The ID associated with the user profile
comment	The comment made by the user
author	Information about the person that made the comment
author.email_address	Email address of the person
author_id	The Email of the person who made the comment

RELATED_CASE_STATUS_UPDATE

Sent when you update the status of a verification session which is linked to a User Profile

Payload:

Key	Value
user_profile_event_type	The type of event callback. Here, it will be`RELATED_CASE_STATUS_UPDATE`
user_profile_id	The ID associated with the user profile
author_id	The email of the User who updated the profile or `SOURCE_API` if created via API Integration

VERIFICATION_REQUEST_SUBMITTED

Payload:

Key	Value
user_profile_event_type	The type of event callback. Here, it will be`VERIFICATION_REQUEST_SUBMITTED`
user_profile_id	The ID associated with the user profile
author_id	The email of the User who updated the profile or `SOURCE_API` if created via API Integration

AML_MONITORING_UPDATE

Sent when there is an AML monitoring update on a verification session of the user itself

Payload:

Key	Value
user_profile_event_type	The type of event callback. Here, it will be`AML_MONITORING_UPDATE`
user_profile_id	The ID associated with the user profile
client_reference_id	The ID provided as client_reference_id at the time of related person session creation
verification_session_id	The session to which the monitoring update belongs to
aml_monitoring_update	The data of the monitoring update itself
aml_monitoring_update.new	List of entity hits that were added
aml_monitoring_update.updated	List of entity hits that were updated
aml_monitoring_update.removed	List of entity hits that were removed

RESULT_UPDATE

Sent when the result of a User Profile is updated

Payload:

Key	Value
user_profile_event_type	The type of event callback. Here, it will be `RESULT_UPDATE`
user_profile_id	The ID associated with the user profile
client_reference_id	The ID provided as client_reference_id at the time of session creation
updated_result	The Result of the User Profile
author_id	The email of the User who updated the result
applicable_reason	Reason for Result update (If any)