User Profile Events Callback
When events occur on the User Profile, AiPrise sends a callback (a POST request) to the set events_callback_url
There are two ways to set the events_callback_url:
- Set the
events_callback_urlat the template level. This can be set from theDashboard > View Templates > {TemplateID}. - Set the
events_callback_urlURL with each create user profile request using the parameterevents_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 beUSER_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 beUSER_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 beRUN_USER_VERIFICATION |
| user_profile_id | The ID associated with the user profile |
| *** | Additionally, all fields from https://docs.aiprise.com/docs/verification-result-1 |
ADD_ADDITIONAL_MEDIA
Payload:
| Key | Value |
|---|---|
| user_profile_event_type | The type of event callback. Here, it will beADD_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 beDELETE_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 beCOMMENT |
| 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
Payload:
| Key | Value |
|---|---|
| user_profile_event_type | The type of event callback. Here, it will beRELATED_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 beVERIFICATION_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 beAML_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 |
Updated 13 days ago