Profile - Event Callbacks
Endpoint Configuration: events_callback_url
Business profiles provide comprehensive events covering the entire lifecycle from creation to ongoing monitoring, including officer KYC and related company KYB.
Available Events
Lifecycle Events
| Event Type | Description |
|---|---|
BUSINESS_PROFILE_CREATE | Business profile created |
BUSINESS_PROFILE_INFO_UPDATE | Profile metadata updated |
VERIFICATION_REQUEST_SUBMITTED | Linked KYB session data submitted |
Verification Events
| Event Type | Description |
|---|---|
RUN_BUSINESS_VERIFICATION | Business verification linked to profile completes |
BUSINESS_OFFICER_RUN_KYC | Officer/UBO KYC completes |
RELATED_COMPANY_RUN_KYB | Related company KYB completes |
RUN_BUSINESS_DOCUMENT_CHECK | Document workflow completes |
MAKE_DECISION | Decisioning workflow completes |
RUN_RISK_SCORING | Risk-scoring workflow executes |
Officer/UBO Management
| Event Type | Description |
|---|---|
ADD_BUSINESS_OFFICER | Officer/UBO added to profile |
EDIT_BUSINESS_OFFICER | Officer/UBO information updated |
DELETE_BUSINESS_OFFICER | Officer/UBO removed |
BUSINESS_OFFICER_CREATE_SESSION_URL | KYC link generated for officer |
BUSINESS_OFFICER_EMAIL_SESSION_URL | KYC invitation emailed to officer |
Related Company Management
| Event Type | Description |
|---|---|
ADD_RELATED_COMPANY | Related company added |
EDIT_RELATED_COMPANY | Related company updated |
DELETE_RELATED_COMPANY | Related company removed |
Document Events
| Event Type | Description |
|---|---|
ADD_ADDITIONAL_MEDIA | Supporting document uploaded |
UPDATE_ADDITIONAL_MEDIA | Supporting document updated |
DELETE_ADDITIONAL_MEDIA | Supporting document removed |
Monitoring & Case Management
| Event Type | Description |
|---|---|
AML_MONITORING_UPDATE_BUSINESS_VERIFICATION | AML change for primary business |
AML_MONITORING_UPDATE_RELATED_BUSINESS_OFFICER | AML change for officer/UBO |
AML_MONITORING_UPDATE_RELATED_COMPANY | AML change for related company |
AML_MONITORING_TOGGLE | Monitoring enabled/disabled |
RELATED_CASE_STATUS_UPDATE | Linked session decision changes |
RELATED_PERSON_SECTION_INFO_UPDATE | Related person data updated |
COMMENT | Comment posted |
CREATE_TICKET | Ticket created |
TICKET_STATUS_UPDATE | Ticket status changes |
TICKET_REVIEWER_UPDATE | Ticket assignee changes |
TICKET_REVIEW_QUEUE_UPDATE | Ticket queue changes |
Administrative Events
| Event Type | Description |
|---|---|
FOLLOW_UP_CREATE_SESSION_URL | Follow-up link generated |
FOLLOW_UP_EMAIL_SESSION_URL | Follow-up link emailed |
RESULT_UPDATE | Profile decision changed manually |
TAGS_UPDATED | Tags updated |
SECTION_RESULT_UPDATE | Section-level decision updated |
AML_HIT_RESOLVED | Triggered when AML hit is resolved |
LIFECYCLE_STATUS_UPDATED | Business profile lifecycle status updated |
Event 1: BUSINESS_PROFILE_CREATE
Description: Triggered when a new business profile is created via API or dashboard.
Payload:
{
"business_profile_id": "bp_xyz123",
"business_profile_event_type": "BUSINESS_PROFILE_CREATE",
"client_reference_id": "our_business_id_456",
"client_reference_data": {},
"author_id": "api_key_abc"
}Event 2: BUSINESS_PROFILE_INFO_UPDATE
Description: Triggered when business profile information is updated
{
"business_profile_id": "bp_xyz123",
"business_profile_event_type": "BUSINESS_PROFILE_CREATE",
"client_reference_id": "our_business_id_456",
"client_reference_data": {},
"author_id": "api_key_abc"
}Event 3: VERIFICATION_REQUEST_SUBMITTED
Description: Triggered when a request for a Verification Session has been submitted for a business profile.
{
"business_profile_id": "bp_xyz123",
"business_profile_event_type": "BUSINESS_PROFILE_CREATE",
"client_reference_id": "our_business_id_456",
"client_reference_data": {},
"verification_session_id": "bvs_abc123"
}Event 4: RUN_BUSINESS_VERIFICATION
Description: Triggered when a business verification workflow linked to the profile completes. This is the profile equivalent of the decision callback for sessions.
Use Cases:
- Update business profile verification status
- Enable business account features
- Generate service agreements
- Set transaction limits based on verification outcome
- Notify business stakeholders
Payload:
{
"business_profile_id": "bp_xyz123",
"business_profile_event_type": "RUN_BUSINESS_VERIFICATION",
"client_reference_id": "our_business_id_456",
"author_id": "system",
// Embedded BusinessVerificationResultPayload
"verification_session_id": "bvs_abc123",
"template_id": "tmpl_kyb_standard",
"aiprise_summary": {
"decision": "APPROVED",
"status": "COMPLETED"
},
"business_input": { /* ... */ },
"business_info": { /* ... */ },
"registration_info": { /* ... */ },
"related_persons": [ /* ... */ ],
"related_companies": [ /* ... */ ]
// ... full KYB payload
}Event 5: BUSINESS_OFFICER_RUN_KYC
Description: Triggered when KYC verification completes for an officer, director, or UBO linked to the business profile.
Use Cases:
- Track officer verification progress
- Update ownership structure verification status
- Identify UBOs requiring additional checks
- Enable account access for verified officers
Payload:
{
"business_profile_id": "bp_xyz123",
"business_profile_event_type": "BUSINESS_OFFICER_RUN_KYC",
"client_reference_id": "our_business_id_456",
"person_reference_id": "person_ceo_001",
// Embedded UserVerificationResultPayload
"verification_session_id": "vs_officer_789",
"aiprise_summary": {
"decision": "APPROVED"
},
"id_info": { /* ... */ },
"face_match_info": { /* ... */ },
"aml_info": { /* ... */ }
// ... full KYC payload for the officer
}Event 6: RELATED_COMPANY_RUN_KYB
Description: Triggered when KYB verification completes for a related company (parent, subsidiary, etc.).
Use Cases:
- Verify ownership chain
- Assess group-level risk
- Complete Ultimate Beneficial Owner (UBO) identification
- Track corporate structure verification
Payload:
{
"business_profile_id": "bp_xyz123",
"business_profile_event_type": "RELATED_COMPANY_RUN_KYB",
"client_reference_id": "our_business_id_456",
"company_reference_id": "company_parent_001",
// Embedded BusinessVerificationResultPayload
"verification_session_id": "bvs_parent_456",
"aiprise_summary": {
"decision": "APPROVED"
},
"business_info": { /* ... */ },
"registration_info": { /* ... */ }
// ... full KYB payload for related company
}Event 7: RUN_BUSINESS_DOCUMENT_CHECK
Description: Triggered when Verification completed for a Business Document
{
"business_profile_id": "bp_xyz123",
"business_profile_event_type": "RELATED_COMPANY_RUN_KYB",
"client_reference_id": "our_business_id_456",
"file_uuid": "bpf_123",
// Embedded BusinessVerificationResultPayload
"verification_session_id": "bvs_parent_456",
"aiprise_summary": {
"decision": "APPROVED"
},
"business_info": { /* ... */ },
"registration_info": { /* ... */ }
// ... full KYB payload for related company
}Event 8: MAKE_DECISION
Description: Triggered when a Decisioning verification session completes for a Business Profile
Payload:
{
"business_profile_id": "bp_xyz123",
"business_profile_event_type": "MAKE_DECISION",
"business_profile_result": "APPROVED",
"status": "COMPLETED",
"client_reference_id": "our_business_id_456",
"author_id": "system",
// Embedded BusinessVerificationResultPayload
"verification_session_id": "bvs_abc123",
"template_id": "tmpl_kyb_standard",
"aiprise_summary": {
"verification_result": "APPROVED"
},
"business_input": { /* ... */ },
"business_info": { /* ... */ },
"registration_info": { /* ... */ },
"related_persons": [ /* ... */ ],
"related_companies": [ /* ... */ ]
// ... full KYB payload
}Event 9: ADD_BUSINESS_OFFICER
Description: Triggered when an officer, director, or UBO is added to the business profile.
Payload:
{
"business_profile_id": "bp_xyz123",
"business_profile_event_type": "ADD_BUSINESS_OFFICER",
"client_reference_id": "our_business_id_456",
"person_reference_id": "person_cfo_002",
"user_profile": {
"first_name": "Jane",
"last_name": "Doe",
"email": "[email protected]",
"phone": "+44 20 9876 5432"
},
"roles": ["CFO", "DIRECTOR", "AUTHORIZED_SIGNATORY"],
"ownership_percent": 30.0,
"shares_allocated": 3000,
"additional_fields": {
"appointment_date": "2023-01-15",
"department": "Finance",
"employment_type": "FULL_TIME"
}
}Event 10: EDIT_BUSINESS_OFFICER
Description: Triggered when an officer's, director, or UBO's information is updated on the Business Profile.
Payload:
{
"business_profile_id": "bp_xyz123",
"business_profile_event_type": "ADD_BUSINESS_OFFICER",
"client_reference_id": "our_business_id_456",
"person_reference_id": "person_cfo_002",
"user_profile": {
"first_name": "Jane",
"last_name": "Doe",
"email": "[email protected]",
"phone": "+44 20 9876 5432"
},
"roles": ["CFO", "DIRECTOR", "AUTHORIZED_SIGNATORY"],
"ownership_percent": 30.0,
"shares_allocated": 3000,
"additional_fields": {
"appointment_date": "2023-01-15",
"department": "Finance",
"employment_type": "FULL_TIME"
}
}Event 11: DELETE_BUSINESS_OFFICER
Description: Triggered when an officer, director or UBO is deleted from the Business Profile
Payload:
{
"business_profile_id": "bp_xyz123",
"business_profile_event_type": "ADD_BUSINESS_OFFICER",
"person_reference_id": "person_cfo_002",
"client_reference_id": "our_business_id_456",
"client_reference_data": {}
}Event 12: BUSINESS_OFFICER_EMAIL_SESSION_URL
Description: Hosted KYC capture link generated and shared on email to an officer/UBO
Payload:
{
"business_profile_id": "bp_xyz123",
"business_profile_event_type": "BUSINESS_OFFICER_EMAIL_SESSION_URL",
"client_reference_id": "our_business_id_456",
"person_reference_id": "person_cfo_002",
"email_address": "[email protected]",
"session_url": "https://verify.aiprise.com/officer/xyz123",
"expires_at": 1704067200000, // 7 days from now
"delivery_channel": "LINK"
}Event 13: BUSINESS_OFFICER_CREATE_SESSION_URL
Description: Hosted KYC capture link generated for an officer/UBO to complete their verification.
Use Cases:
- Send KYC link to new officers
- Track which officers need to complete verification
- Monitor link expiration and regenerate if needed
Payload:
{
"business_profile_id": "bp_xyz123",
"business_profile_event_type": "BUSINESS_OFFICER_CREATE_SESSION_URL",
"client_reference_id": "our_business_id_456",
"person_reference_id": "person_cfo_002",
"session_url": "https://verify.aiprise.com/officer/xyz123",
"expires_at": 1704067200000, // 7 days from now
"delivery_channel": "LINK"
}Event 14: ADD_RELATED_COMPANY
Description: Related company (parent, subsidiary, affiliate) added to the business profile.
Payload:
{
"business_profile_id": "bp_xyz123",
"business_profile_event_type": "ADD_RELATED_COMPANY",
"client_reference_id": "our_business_id_456",
"company_reference_id": "company_parent_001",
"legal_name": "Acme Holdings PLC",
"jurisdiction": "GB",
"relationship_type": "PARENT",
"ownership_percent": 100.0
}Event 15: EDIT_RELATED_COMPANY
Description: Related company (parent, subsidiary, affiliate) edited on the Business Profile
Payload:
{
"business_profile_id": "bp_xyz123",
"business_profile_event_type": "ADD_RELATED_COMPANY",
"client_reference_id": "our_business_id_456",
"company_reference_id": "company_parent_001",
"legal_name": "Acme Holdings PLC",
"jurisdiction": "GB",
"relationship_type": "PARENT",
"ownership_percent": 100.0
}Event 16: DELETE_RELATED_COMPANY
Description: Related company (parent, subsidiary, affiliate) deleted from the Business Profile
{
"business_profile_id": "bp_xyz123",
"business_profile_event_type": "DELETE_RELATED_COMPANY",
"client_reference_id": "our_business_id_456",
"client_reference_data": {},
"company_reference_id": "company_parent_001"
}Event 17: ADD_ADDITIONAL_MEDIA
Description: Adding a supporting document on the Business Profile
Payload:
{
"business_profile_id": "bp_xyz123",
"business_profile_event_type": "ADD_ADDITIONAL_MEDIA",
"client_reference_id": "our_business_id_456",
"client_reference_data": {},
"file_uuid": "bpf_123"
}Event 18: UPDATE_ADDITIONAL_MEDIA
Description: Updating a supporting document on the Business Profile
Payload:
{
"business_profile_id": "bp_xyz123",
"business_profile_event_type": "UPDATE_ADDITIONAL_MEDIA",
"client_reference_id": "our_business_id_456",
"client_reference_data": {},
"file_uuid": "bpf_123"
}Event 19: DELETE_ADDITIONAL_MEDIA
Description: Deleting a supporting document from the Business Profile
Payload:
{
"business_profile_id": "bp_xyz123",
"business_profile_event_type": "DELETE_ADDITIONAL_MEDIA",
"client_reference_id": "our_business_id_456",
"client_reference_data": {},
"file_uuid": "bpf_123"
}Event 20: AML_MONITORING_UPDATE_BUSINESS_VERIFICATION
Description: Ongoing AML monitoring detects a match or status change for the primary business entity.
Payload:
{
"business_profile_id": "bp_xyz123",
"business_profile_event_type": "AML_MONITORING_UPDATE_BUSINESS_VERIFICATION",
"client_reference_id": "our_business_id_456",
"verification_session_id": "bvs_abc123",
"aml_monitoring_update": {
"monitoring_run_id": "mon_daily_20240115",
"status": "MATCH_FOUND",
"matches": [
{
"list_name": "OFAC SDN",
"entity_name": "Acme Corporation Ltd",
"confidence": 0.94,
"reference_url": "https://sanctionslist..."
}
],
"previous_status": "CLEAR"
}
}Event 21: AML_MONITORING_UPDATE_RELATED_BUSINESS_OFFICER
Description: AML monitoring detects a change for an officer/UBO within the business profile.
Payload:
{
"business_profile_id": "bp_xyz123",
"business_profile_event_type": "AML_MONITORING_UPDATE_RELATED_BUSINESS_OFFICER",
"client_reference_id": "our_business_id_456",
"client_reference_data": {},
"person_reference_id": "person_ceo_001",
"verification_session_id": "vs_officer_789",
"aml_monitoring_update": {
"monitoring_run_id": "mon_daily_20240115",
"status": "MATCH_FOUND",
"matches": [
{
"list_name": "PEP Database",
"entity_name": "John Smith",
"confidence": 0.91,
"reference_url": "https://pep-database..."
}
],
"previous_status": "CLEAR"
}
}Event 22: AML_MONITORING_UPDATE_RELATED_COMPANY
Description: AML monitoring detects a change for related company (parent, subsidiary, etc.).
Payload:
{
"business_profile_id": "bp_xyz123",
"business_profile_event_type": "AML_MONITORING_UPDATE_RELATED_COMPANY",
"client_reference_id": "our_business_id_456",
"client_reference_data": {},
"company_reference_id": "company_parent_001",
"verification_session_id": "bvs_abc123",
"aml_monitoring_update": {
"monitoring_run_id": "mon_daily_20240115",
"status": "MATCH_FOUND",
"matches": [
{
"list_name": "OFAC SDN",
"entity_name": "Acme Corporation Ltd",
"confidence": 0.94,
"reference_url": "https://sanctionslist..."
}
],
"previous_status": "CLEAR"
}
}Event 23: RELATED_CASE_STATUS_UPDATE
Description: Decision changes for a linked verification session (business, officer, or related company).
Use Cases:
- Track decision overrides on any entity within business structure
- Update permissions for officers whose KYC status changed
- Handle appeals or manual review results
- Maintain audit trail of all decision changes
Payload:
{
"business_profile_id": "bp_xyz123",
"business_profile_event_type": "RELATED_CASE_STATUS_UPDATE",
"client_reference_id": "our_business_id_456",
"verification_session_id": "vs_officer_789",
"verification_result": "APPROVED",
"author": {
"email_address": "[email protected]"
},
"author_id": "[email protected]",
"reason": "Additional documentation provided and verified",
"person_reference_id": "person_cfo_002", // Present if officer/UBO case
"company_reference_id": null, // Present if related company case
"file_uuid": null // Present if document-specific
}Event 24: RELATED_PERSON_SECTION_INFO_UPDATE
Description: Triggered when a Relater Person's information has been updated on the Business Profile
Payload:
{
"business_profile_id": "bp_xyz123",
"business_profile_event_type": "RELATED_PERSON_SECTION_INFO_UPDATE",
"client_reference_id": "our_business_id_456",
"client_reference_data": {},
"verification_session_id": "vs_officer_789",
"person_reference_id": "person_cfo_002", // Present if officer/UBO case
"author": {
"email_address": "[email protected]"
},
"author_id": "[email protected]",
"data": {} // Information about updated fields
}Event 25: COMMENT
Description: Adding a comment on the Business Profile
Payload:
{
"business_profile_id": "bp_xyz123",
"business_profile_event_type": "COMMENT",
"client_reference_id": "our_business_id_456",
"client_reference_data": {},
"comment": "bp_comment_1",
"author": {
"email_address": "[email protected]"
},
"author_id": "[email protected]"
}Event 26: FOLLOW_UP_CREATE_SESSION_URL
Description: Follow up link generated for a Verification session
Payload:
{
"business_profile_id": "bp_xyz123",
"business_profile_event_type": "FOLLOW_UP_CREATE_SESSION_URL",
"client_reference_id": "our_business_id_456",
"client_reference_data": {},
"session_url": "https://verify.aiprise.com/officer/xyz123",
"expires_at": 1704067200000, // 7 days from now
"delivery_channel": "LINK",
"verification_session_id": "bvs_abc123"
}Event 27: FOLLOW_UP_EMAIL_SESSION_URL
Description: Follow up link created and shared on Email for a Verification Session
Payload:
{
"business_profile_id": "bp_xyz123",
"business_profile_event_type": "FOLLOW_UP_EMAIL_SESSION_URL",
"client_reference_id": "our_business_id_456",
"client_reference_data": {},
"session_url": "https://verify.aiprise.com/officer/xyz123",
"expires_at": 1704067200000, // 7 days from now
"delivery_channel": "LINK",
"verification_session_id": "bvs_abc123"
}Event 28: RESULT_UPDATE
Description: Business Profile result updated manually
Payload:
{
"business_profile_id": "bp_xyz123",
"business_profile_event_type": "RESULT_UPDATE",
"client_reference_id": "our_business_id_456",
"client_reference_data": {},
"business_profile_result": "APPROVED",
"author_id": "api_key_abc"
}Event 29: TAGS_UPDATED
Description: Triggered when tags are added, removed, or updated on the Business Profile. Includes both previous and current tags along with a diff of changes.
Payload:
{
"business_profile_id": "bp_xyz123",
"business_profile_event_type": "TAGS_UPDATED",
"client_reference_id": "our_business_id_456",
"client_reference_data": {},
"callback_event_id": "f02b33b9-5c72-42e7-a7b1-3884001f51b7",
"previous_tags": ["ONBOARDING", "PENDING_REVIEW"],
"current_tags": ["ONBOARDING", "APPROVED", "VIP_CLIENT"],
"changes": {
"added": ["APPROVED", "VIP_CLIENT"],
"removed": ["PENDING_REVIEW"]
}
}Event 30: SECTION_RESULT_UPDATE
Description: When the result of a section on the Business Profile is updated
Payload:
{
"business_profile_id": "bp_xyz123",
"business_profile_event_type": "SECTION_RESULT_UPDATE",
"client_reference_id": "our_business_id_456",
"client_reference_data": {},
"section_id": "bp_section_1",
"section_name": "RISK_INFO",
"existing_risk_level": "HIGH",
"updated_risk_level": "MEDIUM"
}Event 31: AML_HIT_RESOLVED
Description: Triggered when an AML hit is resolved or whitelisted on the Business Profile. Includes details about the resolved hit and the resolution action taken.
Payload:
{
"business_profile_id": "bp_xyz123",
"business_profile_event_type": "AML_HIT_RESOLVED",
"client_reference_id": "our_business_id_456",
"client_reference_data": {},
"callback_event_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"verification_session_id": "bvs_abc123",
"aml_hit": {
"entity_hit_id": "hit_001",
"entity_id": "external_entity_123",
"name": "Acme Corporation Ltd",
"entity_type": "ORGANISATION",
"hit_types": ["SANCTION", "ADVERSE_MEDIA"],
"name_match_score": 0.94,
"date_of_birth": null,
"also_known_as": ["Acme Corp", "ACME LLC"]
},
"resolution": {
"status": "RESOLVED",
"comment": "False positive - verified entity is a different company with similar name",
"resolved_by": "[email protected]"
}
}Event 32: LIFECYCLE_STATUS_UPDATED
Description: Triggered when a Business Profile's lifecycle status changes — either automatically by AiPrise's lifecycle engine based on verification outcomes, or manually by a reviewer in the backoffice. Use the source field to differentiate between the two.
Manual update payload (triggered by a reviewer):
{
"business_profile_id": "bp_xyz123",
"business_profile_event_type": "LIFECYCLE_STATUS_UPDATED",
"client_reference_id": "our_business_id_456",
"callback_event_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"client_reference_data": {},
"target_status": "APPROVED",
"source_status": "PENDING_REVIEW",
"reason": "All documents verified and risk assessment passed",
"tags": [],
"source": "[email protected]"
}Automatic update payload (triggered by AiPrise lifecycle engine):
{
"business_profile_id": "bp_xyz123",
"business_profile_event_type": "LIFECYCLE_STATUS_UPDATED",
"client_reference_id": "our_business_id_456",
"callback_event_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"client_reference_data": {},
"target_status": "PENDING_REVIEW",
"source": "SOURCE_AIPRISE"
}Ticket Events
You get ticket events only if ticket management is enabled for your company. All four carry the same ticket fields next to the envelope fields:
| Field | Description |
|---|---|
ticket_id | Unique ID of the ticket. |
target_id | ID of the business profile the ticket belongs to. |
target_id_type | Always BUSINESS for business profile tickets. |
ticket_status | OPEN or RESOLVED. |
trigger | The alert trigger that created the ticket: CASE_GOES_TO_REVIEW, AML_MONITORING_UPDATE, ID_EXPIRES, DOCUMENT_EXPIRES, WEBSITE_MONITORING_UPDATE or PERIODIC_REVIEW. No value when an alert did not create the ticket, for example when a reviewer created it by hand. |
review_queue | The ticket's review queue, with review_queue_id and name. No value when the ticket is not in a queue. |
assignee | The assigned reviewer, with email. No value when nobody is assigned. |
created_at | When the ticket was created, as a Unix timestamp in milliseconds. |
resolved_at | When the ticket was resolved, as a Unix timestamp in milliseconds. No value while the ticket is open. |
A field with no value is left out of the payload, so treat a missing field as null.
Event 33: CREATE_TICKET
Description: Sent whenever a ticket is created on the business profile, for example by an alert on the template or by a reviewer in the dashboard.
Payload:
{
"business_profile_id": "a4d2e8f1-3c5b-4f7a-8e9d-1b6c0f2a5e47",
"business_profile_event_type": "CREATE_TICKET",
"client_reference_id": "our_business_id_456",
"client_reference_data": {},
"callback_event_id": "0b6a1f52-8d3e-4c7a-9f21-3e5d7c9a1b40",
"ticket_id": "8c1e2f4a-5b6d-4e7f-9a0b-1c2d3e4f5a6b",
"target_id": "a4d2e8f1-3c5b-4f7a-8e9d-1b6c0f2a5e47",
"target_id_type": "BUSINESS",
"ticket_status": "OPEN",
"trigger": "AML_MONITORING_UPDATE",
"review_queue": {
"review_queue_id": "2b7d9e10-4c3a-4f8e-9d21-6a5b4c3d2e1f",
"name": "High risk KYB"
},
"assignee": {
"email": "[email protected]"
},
"created_at": 1757500000000
}A new ticket can start with no queue and no reviewer. review_queue and assignee are then missing.
Event 34: TICKET_STATUS_UPDATE
Description: Sent when the ticket's status changes, for example when a reviewer resolves it in the dashboard. previous_status is the status before the change. updated_by holds the email of the dashboard user who made the change.
Payload:
{
"business_profile_id": "a4d2e8f1-3c5b-4f7a-8e9d-1b6c0f2a5e47",
"business_profile_event_type": "TICKET_STATUS_UPDATE",
"client_reference_id": "our_business_id_456",
"client_reference_data": {},
"callback_event_id": "5e2c9d71-4a8b-4f36-b1e0-7d3f6a2c8e95",
"ticket_id": "8c1e2f4a-5b6d-4e7f-9a0b-1c2d3e4f5a6b",
"target_id": "a4d2e8f1-3c5b-4f7a-8e9d-1b6c0f2a5e47",
"target_id_type": "BUSINESS",
"ticket_status": "RESOLVED",
"trigger": "AML_MONITORING_UPDATE",
"review_queue": {
"review_queue_id": "2b7d9e10-4c3a-4f8e-9d21-6a5b4c3d2e1f",
"name": "High risk KYB"
},
"assignee": {
"email": "[email protected]"
},
"created_at": 1757500000000,
"resolved_at": 1757600000000,
"previous_status": "OPEN",
"updated_by": {
"email": "[email protected]"
}
}Event 35: TICKET_REVIEWER_UPDATE
Description: Sent when the ticket's reviewer changes. assignee is the new reviewer. data.old_reviewer and data.new_reviewer hold the reviewer before and after the change, each with name and email. When there was no reviewer on one side, both of its values are null.
Earlier versions of this event sent only data. The ticket fields were added next to it and data did not change, so existing handlers keep working.
Payload:
{
"business_profile_id": "a4d2e8f1-3c5b-4f7a-8e9d-1b6c0f2a5e47",
"business_profile_event_type": "TICKET_REVIEWER_UPDATE",
"client_reference_id": "our_business_id_456",
"client_reference_data": {},
"callback_event_id": "9f4e7a23-1c6d-4b58-8e3f-2a7c5d9b0e16",
"ticket_id": "8c1e2f4a-5b6d-4e7f-9a0b-1c2d3e4f5a6b",
"target_id": "a4d2e8f1-3c5b-4f7a-8e9d-1b6c0f2a5e47",
"target_id_type": "BUSINESS",
"ticket_status": "OPEN",
"trigger": "AML_MONITORING_UPDATE",
"review_queue": {
"review_queue_id": "2b7d9e10-4c3a-4f8e-9d21-6a5b4c3d2e1f",
"name": "High risk KYB"
},
"assignee": {
"email": "[email protected]"
},
"created_at": 1757500000000,
"data": {
"old_reviewer": {
"name": "Jane Doe",
"email": "[email protected]"
},
"new_reviewer": {
"name": "Bob Lee",
"email": "[email protected]"
}
}
}Event 36: TICKET_REVIEW_QUEUE_UPDATE
Description: Sent when a reviewer moves the ticket to another review queue in the dashboard. review_queue is the new queue. data.old_review_queue_name and data.new_review_queue_name hold the queue names before and after the move, or null when there was no queue.
Earlier versions of this event sent only data. The ticket fields were added next to it and data did not change, so existing handlers keep working.
Payload:
{
"business_profile_id": "a4d2e8f1-3c5b-4f7a-8e9d-1b6c0f2a5e47",
"business_profile_event_type": "TICKET_REVIEW_QUEUE_UPDATE",
"client_reference_id": "our_business_id_456",
"client_reference_data": {},
"callback_event_id": "d3a8c6e1-7f2b-4e94-a5c0-6b1e9f3d7a28",
"ticket_id": "8c1e2f4a-5b6d-4e7f-9a0b-1c2d3e4f5a6b",
"target_id": "a4d2e8f1-3c5b-4f7a-8e9d-1b6c0f2a5e47",
"target_id_type": "BUSINESS",
"ticket_status": "OPEN",
"trigger": "AML_MONITORING_UPDATE",
"review_queue": {
"review_queue_id": "7e4f1a2b-9c8d-4e6f-a1b2-c3d4e5f60718",
"name": "Escalations"
},
"assignee": {
"email": "[email protected]"
},
"created_at": 1757500000000,
"data": {
"old_review_queue_name": "High risk KYB",
"new_review_queue_name": "Escalations"
}
}Updated 15 days ago