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

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",
  "author_id": "api_key_abc"
}

Event 2: 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 3: 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 4: 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 5: 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 6: 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 7: 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 8: 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 9: 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",
  "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 10: 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
}