Profile - Event Callbacks

User profiles provide a comprehensive set of events covering the entire lifecycle from creation to ongoing monitoring.

Endpoint Configuration: events_callback_url

Available Events

Lifecycle Events

Event Type	Description
`USER_PROFILE_CREATE`	New user profile created via API or dashboard
`USER_PROFILE_INFO_UPDATE`	Profile metadata updated
`USER_PROFILE_CREATE_SESSION_URL`	Hosted capture link generated
`USER_PROFILE_EMAIL_SESSION_URL`	Email invitation link generated

Verification Events

Event Type	Description
`VERIFICATION_SESSION_STARTED`	Linked verification session begins
`VERIFICATION_REQUEST_SUBMITTED`	Linked verification session data submitted
`VERIFICATION_SESSION_COMPLETION`	Linked verification session completes
`RUN_USER_VERIFICATION`	Verification workflow linked to profile completes
`RUN_DOCUMENT_CHECK`	Document-only workflow linked to profile completes
`MAKE_DECISION`	Decisioning workflow linked to profile completes
`RUN_RISK_SCORING`	Risk-scoring workflow executed

Update Events

Event Type	Description
`RESULT_UPDATE`	Profile result changed outside workflow completion
`SECTION_RESULT_UPDATE`	Section-level decision updated
`NAME_UPDATED`	Profile name fields updated
`DATE_OF_BIRTH_UPDATED`	Profile date of birth updated
`ADDRESS_UPDATED`	Profile address updated
`PHONE_UPDATED`	Profile phone number updated
`EMAIL_UPDATED`	Profile email updated
`TAGS_UPDATED`	Profile tags updated

Document Events

Event Type	Description
`ADD_ADDITIONAL_MEDIA`	Additional document uploaded to profile
`UPDATE_ADDITIONAL_MEDIA`	Existing profile document updated
`DELETE_ADDITIONAL_MEDIA`	Profile document removed

Monitoring & Case Management

Event Type	Description
`AML_MONITORING_UPDATE`	Monitoring detects change for profile
`AML_MONITORING_TOGGLE`	Monitoring enabled/disabled
`RELATED_CASE_STATUS_UPDATE`	Linked verification session decision changes
`COMMENT`	Comment posted on profile
`CREATE_TICKET`	Ticket created for profile
`TICKET_STATUS_UPDATE`	Ticket status changes
`TICKET_REVIEWER_UPDATE`	Ticket assignee changes
`TICKET_REVIEW_QUEUE_UPDATE`	Ticket queue changes
`AML_HIT_RESOLVED`	AML hit resolved or whitelisted

Event 1: USER_PROFILE_CREATE

Description: Triggered when a new user profile is created via API or dashboard.

Payload:

{
  "user_profile_id": "up_xyz123",
  "user_profile_event_type": "USER_PROFILE_CREATE",
  "author_id": "api_key_abc" // or email if created by user
}

Event 2: USER_PROFILE_CREATE_SESSION_URL

Description: Hosted KYC capture link generated for a user profile to complete their verification.

Payload:

{
  "user_profile_id": "up_xyz123",
  "user_profile_event_type": "USER_PROFILE_CREATE_SESSION_URL",
  "client_reference_id": "our_user_id_456",
  "session_url": "https://verify.aiprise.com/user/xyz123",
  "verification_session_id": "vs_abc123",
  "expires_at": 1704067200000,
  "delivery_channel": "LINK"
}

Event 3: USER_PROFILE_EMAIL_SESSION_URL

Description: KYC verification link emailed to the user.

Payload:

{
  "user_profile_id": "up_xyz123",
  "user_profile_event_type": "USER_PROFILE_EMAIL_SESSION_URL",
  "client_reference_id": "our_user_id_456",
  "session_url": "https://verify.aiprise.com/user/xyz123",
  "verification_session_id": "vs_abc123",
  "email_address": "[email protected]",
  "expires_at": 1704067200000,
  "delivery_channel": "EMAIL"
}

Event 4: RUN_USER_VERIFICATION

Description: Triggered when a verification workflow linked to the profile completes. This is the profile equivalent of the decision callback for sessions.

Use Cases:

Update profile verification status
Grant/revoke access based on result
Trigger onboarding completion workflows
Send user notifications

Payload:

{
  "user_profile_id": "up_xyz123",
  "user_profile_event_type": "RUN_USER_VERIFICATION",
  "author_id": "system",
  "user_profile_result": "APPROVED",
  "related_companies": [], // if multilevel permissions enabled
  
  // Embedded UserVerificationResultPayload
  "verification_session_id": "vs_abc123",
  "template_id": "tmpl_kyc_basic",
  "aiprise_summary": {
    "decision": "APPROVED",
    "status": "COMPLETED"
  },
  "user_input": { /* ... */ },
  "id_info": { /* ... */ },
  "face_match_info": { /* ... */ },
  "aml_info": { /* ... */ }
  // ... full verification payload
}

Event 5: RUN_DOCUMENT_CHECK

Description: Triggered when a document-only verification workflow completes for the profile (e.g., POA verification).

Payload:

{
  "user_profile_id": "up_xyz123",
  "user_profile_event_type": "RUN_DOCUMENT_CHECK",
  "file_uuid": "file_doc123",
  "user_profile_result": "APPROVED",
  
  // Embedded verification payload
  "verification_session_id": "vs_doc456",
  "aiprise_summary": {
    "decision": "APPROVED"
  }
  // ... document check results
}

Event 6: ADD_ADDITIONAL_MEDIA

Description: Triggered when an additional document is uploaded to the profile (utility bill, bank statement, etc.).

Payload:

{
  "user_profile_id": "up_xyz123",
  "user_profile_event_type": "ADD_ADDITIONAL_MEDIA",
  "file_uuid": "file_doc789",
  "media_type": "UTILITY_BILL",
  "uploaded_by": "api_key_abc",
  "uploaded_at": 1702345678000
}

Event 7: AML_MONITORING_UPDATE

Description: Ongoing AML monitoring detects a match or status change for the profile.

Payload:

{
  "user_profile_id": "up_xyz123",
  "user_profile_event_type": "AML_MONITORING_UPDATE",
  "verification_session_id": "vs_abc123",
  "aml_monitoring_update": {
    "monitoring_run_id": "mon_daily_001",
    "status": "MATCH_FOUND",
    "matches": [
      {
        "list_name": "EU Sanctions List",
        "entity_name": "John Doe",
        "confidence": 0.88,
        "reference_url": "https://..."
      }
    ],
    "previous_status": "CLEAR"
  }
}

Event 8: NAME_UPDATED / ADDRESS_UPDATED / etc.

Description: Triggered when profile contact information is updated.

Payload (example for ADDRESS_UPDATED):

{
  "user_profile_id": "up_xyz123",
  "user_profile_event_type": "ADDRESS_UPDATED",
  "previous": {
    "street": "123 Old St",
    "city": "Old City",
    "postal_code": "12345"
  },
  "current": {
    "street": "456 New Ave",
    "city": "New City",
    "postal_code": "67890"
  }
}

Event 9: TAGS_UPDATED

Description: Triggered when tags are added, removed, or updated on the User Profile. Includes both previous and current tags along with a diff of changes.

Payload:

{
  "user_profile_id": "up_xyz123",
  "user_profile_event_type": "TAGS_UPDATED",
  "client_reference_id": "our_user_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 10: AML_HIT_RESOLVED

Description: Triggered when an AML hit is resolved or whitelisted on the User Profile. Includes details about the resolved hit and the resolution action taken.

Payload:

{
  "user_profile_id": "up_xyz123",
  "user_profile_event_type": "AML_HIT_RESOLVED",
  "client_reference_id": "our_user_id_456",
  "client_reference_data": {},
  "callback_event_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "verification_session_id": "vs_abc123",
  "aml_hit": {
    "entity_hit_id": "hit_001",
    "entity_id": "external_entity_123",
    "name": "John Doe",
    "entity_type": "PERSON",
    "hit_types": ["PEP", "SANCTION"],
    "name_match_score": 0.91,
    "date_of_birth": "1980-05-15",
    "also_known_as": ["Johnny D", "J. Doe"]
  },
  "resolution": {
    "status": "RESOLVED",
    "comment": "False positive - different individual with same name, verified via additional documentation",
    "resolved_by": "[email protected]"
  }
}