Channel Delivered to Contents Notes callback_urlUser sessions, business sessions, business profiles Final decision payload at the end of a workflow User sessions attached to a profile rely on the profile’s callbacks instead of this channel. events_callback_urlUser sessions, business sessions, user profiles, business profiles Lifecycle updates that stream progress and secondary actions External user profiles expose only this channel.
All callbacks include X-HMAC-SIGNATURE = HMAC_SHA256(api_key, raw_payload). Validate the signature before processing. AiPrise queues and retries deliveries automatically and stores each payload (with a callback_uuid) for inspection or replay. Keep your handlers idempotent by keying off verification_session_id, user_profile_id, or business_profile_id.
The tables below define reusable payload structures. Event sections refer back to these types when they embed or reuse a structure.
Field Description verification_session_idUnique identifier for the verification session. template_idIdentifier of the verification template used. client_reference_idOptional customer-provided identifier for correlating the session. client_reference_dataOptional JSON object with additional client-side metadata. aiprise_summarySummary object describing decision/result, status, warning codes, reasons, and notes. statusWorkflow status (NOT_STARTED, COLLECTING, PROCESSING, COMPLETED, FAILED, PENDING). created_atMillisecond epoch timestamp representing when the session was created. status_reasonsOptional array of status reason entries (reason code plus metadata). user_inputObject containing submitted user_data and additional_user_info (including pre-signed URLs). id_infoProvider-specific identity document results (authenticity, extraction, etc.). face_match_infoFace match comparison details (scores, pass/fail). face_liveness_infoLiveness check details (scores, pass/fail). aml_infoAML screening summary, including matches and monitoring status. fraud_insightsFraud detection signals gathered during the workflow. lookup_infoArray of identity lookup results per provider. additional_infoAdditional workflow outputs such as questionnaire responses. risk_infoRisk scoring outputs (score, tier, contributing reasons). aml_monitoring_infoCurrent AML monitoring configuration and next scheduled run.
Zero-knowledge tenants receive a hashed variant with verification_session_id, verification_result, hash, reasons, and notes instead of the full structure above.
Field Description verification_session_idUnique identifier for the KYB verification session. template_idIdentifier of the KYB template used. client_reference_idOptional customer-provided identifier for correlating the session. client_reference_dataOptional JSON object with additional client metadata. aiprise_summarySummary object describing decision/result, status, reasons, notes, and warning codes. statusWorkflow status (NOT_STARTED, COLLECTING, PROCESSING, COMPLETED, FAILED, PENDING). created_atMillisecond epoch timestamp representing when the session was created. status_reasonsOptional array of status reason entries. business_inputSubmitted business data (company details, addresses, contact info) plus additional info. business_infoDerived business attributes (formation, industry, size). registration_infoRegistry lookups and statuses. aml_infoAML screening summary, including matches and monitoring status. fraud_insightsFraud detection insights generated for the business. lookup_infoArray of business lookup results per provider. risk_infoRisk scoring outputs for the business. related_personsArray of officer/UBO representations (V1 or V2 format based on permissions). related_companiesArray of related company representations (V1 or V2 format).
Field Description user_profile_idIdentifier of the external user profile. user_profile_event_typeEvent type name (USER_PROFILE_CREATE, RUN_USER_VERIFICATION, etc.). author_idOptional identifier (usually email) of the actor responsible for the change. …Event-specific fields described in each event table below.
Field Description business_profile_idIdentifier of the business profile. business_profile_event_typeEvent type name (RUN_BUSINESS_VERIFICATION, ADD_BUSINESS_OFFICER, etc.). client_reference_idOptional client-provided identifier attached to the profile. client_reference_dataOptional JSON object with additional client metadata. …Event-specific fields described in each event table below.
Field Description monitoring_run_idIdentifier for the monitoring job execution. statusMonitoring outcome (CLEAR, MATCH_FOUND, etc.). matchesArray of match objects containing list name, entity name, confidence, and reference URLs. previous_statusPrevious monitoring status, if available.
Field Description ticket_idIdentifier of the ticket in AiPrise back office. queueQueue or workflow the ticket is assigned to. statusCurrent ticket status. summaryShort description of the ticket (present on CREATE_TICKET). previous_statusPrevious status before the update (status update events). current_statusNew status after the update (status update events). previous_reviewerPrevious reviewer/assignee (reviewer update events). current_reviewerNew reviewer/assignee (reviewer update events). previous_queuePrevious queue (queue update events). current_queueNew queue (queue update events).
Callback/Event Trigger Result callback (callback_url) Workflow reaches a terminal state (approved, declined, manual review, failed) and the session is not linked to a profile. VERIFICATION_SESSION_STARTEDHosted flow or SDK hands control back when the applicant begins the session. VERIFICATION_REQUEST_SUBMITTEDApplicant completes data entry and the workflow moves into processing. VERIFICATION_SESSION_COMPLETIONVerification workflow finishes with any terminal status. CASE_STATUS_UPDATEReviewer or API client updates the case decision after completion. AML_MONITORING_UPDATEOngoing AML monitoring detects a new match or status change. SECTION_INFO_UPDATEAnalyst edits a section (such as ID info or address) in the dashboard or via API. COMMENTComment is posted on the case by a reviewer, Compliance Copilot, or automation.
Description: Final snapshot of a user verification workflow.Trigger: Workflow reaches a terminal state (approved, declined, manual review, failed) and the session is not attached to a profile.Payload Type: UserVerificationResultPayload.
Field Description event_typeAlways VERIFICATION_SESSION_STARTED. verification_session_idIdentifier of the user verification session. client_reference_idClient-supplied identifier, if provided. client_reference_dataOptional client metadata object.
Field Description event_typeAlways VERIFICATION_REQUEST_SUBMITTED. verification_session_idIdentifier of the user verification session. client_reference_idClient-supplied identifier, if provided. client_reference_dataOptional client metadata object.
Field Description event_typeAlways VERIFICATION_SESSION_COMPLETION. … (UserVerificationResultPayload)Full result payload described in the shared type definition.
Field Description event_typeAlways CASE_STATUS_UPDATE. verification_session_idIdentifier of the user verification session. client_reference_idClient-supplied identifier, if provided. client_reference_dataOptional client metadata object. verification_resultNew decision applied to the case. authorObject containing reviewer metadata (e.g., email_address). author_idReviewer identifier (usually email). reasonOptional decline or override reason.
Field Description event_typeAlways AML_MONITORING_UPDATE. verification_session_idIdentifier of the user verification session. client_reference_idClient-supplied identifier, if provided. client_reference_dataOptional client metadata object. aml_monitoring_updateAMLMonitoringUpdate structure describing the monitoring outcome.
Field Description event_typeAlways SECTION_INFO_UPDATE. verification_session_idIdentifier of the user verification session. client_reference_idClient-supplied identifier, if provided. client_reference_dataOptional client metadata object. dataObject detailing the section name, updated fields (previous/current values), actor, and timestamp.
Field Description event_typeAlways COMMENT. verification_session_idIdentifier of the user verification session. client_reference_idClient-supplied identifier, if provided. client_reference_dataOptional client metadata object. commentText of the comment added to the case. authorObject containing commenter metadata. author_idCommenter identifier (usually email). created_atMillisecond epoch timestamp when the comment was recorded.
Event Trigger USER_PROFILE_CREATEA new external user profile is created via API or dashboard. USER_PROFILE_INFO_UPDATEProfile metadata is updated. USER_PROFILE_CREATE_SESSION_URLHosted capture link generated for onboarding a profile. USER_PROFILE_EMAIL_SESSION_URLEmail invitation link generated for profile capture. VERIFICATION_SESSION_STARTEDLinked verification session begins collecting data. VERIFICATION_REQUEST_SUBMITTEDLinked verification session finishes data submission. VERIFICATION_SESSION_COMPLETIONLinked verification session reaches a terminal status. RUN_USER_VERIFICATIONVerification workflow linked to the profile completes. RUN_DOCUMENT_CHECKDocument-only workflow linked to the profile completes. MAKE_DECISIONDecisioning workflow linked to the profile completes. RUN_RISK_SCORINGRisk-scoring workflow is executed for the profile. RESULT_UPDATEProfile result is changed outside of workflow completion. SECTION_RESULT_UPDATESection-level decision is updated. ADD_ADDITIONAL_MEDIAAdditional document is uploaded to the profile. UPDATE_ADDITIONAL_MEDIAExisting profile document is updated. DELETE_ADDITIONAL_MEDIAProfile document is removed. AML_MONITORING_UPDATEMonitoring job detects a new match or status change for the profile. AML_MONITORING_TOGGLEMonitoring is enabled or disabled for the profile. RELATED_CASE_STATUS_UPDATEDecision changes on a verification session linked to the profile. COMMENTComment posted on the profile. CREATE_TICKETTicket created for profile follow-up. TICKET_STATUS_UPDATETicket status changes. TICKET_REVIEWER_UPDATETicket assignee changes. TICKET_REVIEW_QUEUE_UPDATETicket queue changes. NAME_UPDATEDProfile name fields updated. DATE_OF_BIRTH_UPDATEDProfile date of birth updated. ADDRESS_UPDATEDProfile address updated. PHONE_UPDATEDProfile phone number updated. EMAIL_UPDATEDProfile email updated.
Every payload includes the UserProfileEventEnvelope fields plus event-specific keys.
Field Description (Envelope fields) UserProfileEventEnvelope.author_idIdentifier of the actor who created the profile (may be empty for automated creation).
Field Description (Envelope fields) UserProfileEventEnvelope.author_idIdentifier of the actor who updated the profile.
Field Description (Envelope fields) UserProfileEventEnvelope.session_urlHosted capture URL issued for the profile. expires_atMillisecond epoch timestamp when the link expires. delivery_channelLINK or other transport indicator.
Field Description (Envelope fields) UserProfileEventEnvelope.session_urlHosted capture URL included in the email. expires_atMillisecond epoch timestamp when the link expires. delivery_channelEMAIL.email_addressRecipient email address used for the invitation.
Field Description (Envelope fields) UserProfileEventEnvelope.verification_session_idIdentifier of the linked verification session.
Field Description (Envelope fields) UserProfileEventEnvelope.verification_session_idIdentifier of the linked verification session.
Field Description (Envelope fields) UserProfileEventEnvelope.verification_session_idIdentifier of the linked verification session.
Field Description (Envelope fields) UserProfileEventEnvelope.user_profile_resultProfile-level decision after the verification. related_companiesOptional array describing associated business profiles when multilevel permissions are enabled. …Embedded UserVerificationResultPayload.
Field Description (Envelope fields) UserProfileEventEnvelope.file_uuidIdentifier of the document that was checked. user_profile_resultProfile-level decision after the document workflow. …Embedded UserVerificationResultPayload.
Field Description (Envelope fields) UserProfileEventEnvelope.user_profile_resultUpdated profile decision. …Embedded UserVerificationResultPayload.
Field Description (Envelope fields) UserProfileEventEnvelope.risk_scoring_resultObject containing risk score, tier, and contributing reasons. author_idIdentifier of the actor who triggered the run (may be automated).
Field Description (Envelope fields) UserProfileEventEnvelope.verification_session_idSession associated with the decision change, if applicable. resultNew profile decision. reasonOptional description of why the decision changed.
Field Description (Envelope fields) UserProfileEventEnvelope.sectionIdentifier of the section whose decision changed. new_resultUpdated decision for the section. previous_resultPrevious decision for the section.
Field Description (Envelope fields) UserProfileEventEnvelope.file_uuidIdentifier of the uploaded document. media_typeClassification of the document (e.g., UTILITY_BILL). uploaded_byIdentifier of the actor who uploaded the file. uploaded_atMillisecond epoch timestamp of the upload.
Field Description (Envelope fields) UserProfileEventEnvelope.file_uuidIdentifier of the updated document. media_typeClassification of the document. updated_byIdentifier of the actor who performed the update. updated_atMillisecond epoch timestamp of the update.
Field Description (Envelope fields) UserProfileEventEnvelope.file_uuidIdentifier of the removed document. deleted_byIdentifier of the actor who removed the document. deleted_atMillisecond epoch timestamp of the removal.
Field Description (Envelope fields) UserProfileEventEnvelope.verification_session_idSession tied to the monitoring update. aml_monitoring_updateAMLMonitoringUpdate structure.
Field Description (Envelope fields) UserProfileEventEnvelope.monitoring_enabledBoolean indicating the new monitoring state. toggled_atMillisecond epoch timestamp of the change.
Field Description (Envelope fields) UserProfileEventEnvelope.verification_session_idSession whose status changed. verification_resultUpdated decision applied to the session. authorObject containing reviewer metadata. author_idReviewer identifier (usually email). reasonOptional reason provided for the update.
Field Description (Envelope fields) UserProfileEventEnvelope.commentText of the comment recorded against the profile. authorObject containing commenter metadata. author_idCommenter identifier (usually email). created_atMillisecond epoch timestamp of the comment.
Field Description (Envelope fields) UserProfileEventEnvelope.ticketTicketPayload structure describing the ticket state.
For each contact update event (name, date of birth, address, phone, email), the payload shares the same pattern:
Field Description (Envelope fields) UserProfileEventEnvelope.previousPrevious value of the field. currentNew value of the field.
Callback/Event Trigger Result callback (callback_url) Business verification workflow completes and the session is not linked to a business profile. VERIFICATION_SESSION_STARTEDHosted flow or SDK hands control back when the business begins the session. VERIFICATION_REQUEST_SUBMITTEDBusiness finishes providing required data. VERIFICATION_SESSION_COMPLETIONKYB workflow finishes with any terminal status. CASE_STATUS_UPDATEReviewer or API client updates the case decision after completion. AML_MONITORING_UPDATEOngoing AML monitoring detects a new match or status change. SECTION_INFO_UPDATEAnalyst edits a section (business info, ownership, documents) in the dashboard or via API. COMMENTComment is posted on the business case.
Description: Final KYB verification result.Trigger: Business verification workflow completes and the session is not linked to a business profile.Payload Type: BusinessVerificationResultPayload.
Field Description event_typeAlways VERIFICATION_SESSION_STARTED. verification_session_idIdentifier of the business verification session. client_reference_idClient-supplied identifier, if provided. client_reference_dataOptional client metadata object.
Field Description event_typeAlways VERIFICATION_REQUEST_SUBMITTED. verification_session_idIdentifier of the business verification session. client_reference_idClient-supplied identifier, if provided. client_reference_dataOptional client metadata object.
Field Description event_typeAlways VERIFICATION_SESSION_COMPLETION. … (BusinessVerificationResultPayload)Full result payload described in the shared type definition.
Field Description event_typeAlways CASE_STATUS_UPDATE. verification_session_idIdentifier of the business verification session. client_reference_idClient-supplied identifier, if provided. client_reference_dataOptional client metadata object. verification_resultNew decision applied to the case. authorObject containing reviewer metadata. author_idReviewer identifier (usually email). reasonOptional decline or override reason. person_reference_idOfficer/UBO reference tied to the update (if applicable). company_reference_idRelated company reference tied to the update (if applicable). file_uuidDocument identifier tied to the update (if applicable).
Field Description event_typeAlways AML_MONITORING_UPDATE. verification_session_idIdentifier of the business verification session. client_reference_idClient-supplied identifier, if provided. client_reference_dataOptional client metadata object. aml_monitoring_updateAMLMonitoringUpdate structure.
Field Description event_typeAlways SECTION_INFO_UPDATE. verification_session_idIdentifier of the business verification session. client_reference_idClient-supplied identifier, if provided. client_reference_dataOptional client metadata object. dataObject detailing the section name, updated fields (previous/current values), actor, and timestamp.
Field Description event_typeAlways COMMENT. verification_session_idIdentifier of the business verification session. client_reference_idClient-supplied identifier, if provided. client_reference_dataOptional client metadata object. commentText of the comment recorded against the case. authorObject containing commenter metadata. author_idCommenter identifier (usually email). created_atMillisecond epoch timestamp of the comment.
Callback/Event Trigger Result callback (callback_url) Onboarding session linked to the business profile completes with a decision. BUSINESS_PROFILE_CREATEBusiness profile is created via API or dashboard. BUSINESS_PROFILE_INFO_UPDATEProfile metadata changes. RUN_BUSINESS_VERIFICATIONBusiness verification session linked to the profile completes. BUSINESS_OFFICER_RUN_KYCOfficer/UBO verification linked to the profile completes. RELATED_COMPANY_RUN_KYBRelated company verification linked to the profile completes. RUN_BUSINESS_DOCUMENT_CHECKBusiness document workflow linked to the profile completes. MAKE_DECISIONDecisioning workflow for the profile completes. RUN_RISK_SCORINGRisk-scoring workflow executes for the profile. AML_MONITORING_UPDATE_BUSINESS_VERIFICATIONMonitoring detects a change for the primary business entity. AML_MONITORING_UPDATE_RELATED_BUSINESS_OFFICERMonitoring detects a change for a related officer/UBO. AML_MONITORING_UPDATE_RELATED_COMPANYMonitoring detects a change for a related company. AML_MONITORING_TOGGLEMonitoring enabled/disabled for the profile. ADD_BUSINESS_OFFICEROfficer/UBO added to the profile. EDIT_BUSINESS_OFFICEROfficer/UBO information updated. DELETE_BUSINESS_OFFICEROfficer/UBO removed. BUSINESS_OFFICER_CREATE_SESSION_URLHosted capture link generated for an officer. BUSINESS_OFFICER_EMAIL_SESSION_URLEmail invitation generated for an officer capture. ADD_RELATED_COMPANYRelated company added. EDIT_RELATED_COMPANYRelated company updated. DELETE_RELATED_COMPANYRelated company removed. ADD_ADDITIONAL_MEDIASupporting document uploaded. UPDATE_ADDITIONAL_MEDIASupporting document updated. DELETE_ADDITIONAL_MEDIASupporting document removed. RELATED_CASE_STATUS_UPDATEDecision changes for a linked verification session (business/officer/related company). RELATED_PERSON_SECTION_INFO_UPDATERelated person section data updated. COMMENTComment posted on the profile or related case. CREATE_TICKETTicket created for the profile. TICKET_STATUS_UPDATETicket status changes. TICKET_REVIEWER_UPDATETicket reviewer changes. TICKET_REVIEW_QUEUE_UPDATETicket queue changes. FOLLOW_UP_CREATE_SESSION_URLFollow-up capture link generated. FOLLOW_UP_EMAIL_SESSION_URLFollow-up capture link emailed. RESULT_UPDATEProfile-level decision changed manually. TAGS_UPDATEDTags associated with the profile updated. VERIFICATION_REQUEST_SUBMITTEDLinked business verification session finishes data submission.
Business profile events include the BusinessProfileEventEnvelope fields plus event-specific keys.
Description: Full snapshot of the business profile after the onboarding decision.Trigger: Onboarding session linked to the profile completes.Payload: BusinessProfileEventEnvelope plus all fields from BusinessVerificationResultPayload representing the profile state.
Field Description (Envelope fields) BusinessProfileEventEnvelope.author_idIdentifier of the actor who created the profile.
Field Description (Envelope fields) BusinessProfileEventEnvelope.author_idIdentifier of the actor who updated the profile.
Field Description (Envelope fields) BusinessProfileEventEnvelope.… (BusinessVerificationResultPayload)Embedded business verification result.
Field Description (Envelope fields) BusinessProfileEventEnvelope.person_reference_idRelated person identifier (officer/UBO). … (UserVerificationResultPayload)Embedded officer verification result.
Field Description (Envelope fields) BusinessProfileEventEnvelope.company_reference_idRelated company identifier. … (BusinessVerificationResultPayload)Embedded related company verification result.
Field Description (Envelope fields) BusinessProfileEventEnvelope.file_uuidDocument identifier associated with the check. … (BusinessVerificationResultPayload)Embedded document workflow result.
Field Description (Envelope fields) BusinessProfileEventEnvelope.… (BusinessVerificationResultPayload)Embedded decisioning result.
Field Description (Envelope fields) BusinessProfileEventEnvelope.risk_scoring_resultObject containing risk score, tier, and contributing reasons. author_idIdentifier of the actor who triggered the run (may be automated).
Field Description (Envelope fields) BusinessProfileEventEnvelope.verification_session_idBusiness verification session tied to the update. aml_monitoring_updateAMLMonitoringUpdate structure.
Field Description (Envelope fields) BusinessProfileEventEnvelope.person_reference_idOfficer/UBO identifier. verification_session_idLinked officer verification session. aml_monitoring_updateAMLMonitoringUpdate structure.
Field Description (Envelope fields) BusinessProfileEventEnvelope.company_reference_idRelated company identifier. verification_session_idLinked related-company verification session. aml_monitoring_updateAMLMonitoringUpdate structure.
Field Description (Envelope fields) BusinessProfileEventEnvelope.monitoring_enabledBoolean indicating the new monitoring state for the profile. toggled_atMillisecond epoch timestamp of the change.
Field Description (Envelope fields) BusinessProfileEventEnvelope.person_reference_idIdentifier of the added officer/UBO. user_profileOfficer details (V1 or V2 format based on permissions). rolesArray describing officer roles and responsibilities. ownership_percentOwnership percentage held by the officer. shares_allocatedNumber of shares assigned to the officer. additional_fieldsAdditional metadata attached to the officer record.
Field Description (Envelope fields) BusinessProfileEventEnvelope.person_reference_idIdentifier of the edited officer/UBO. user_profileUpdated officer details (V1 or V2 format). rolesUpdated roles for the officer. ownership_percentUpdated ownership percentage. shares_allocatedUpdated share allocation. additional_fieldsUpdated metadata for the officer.
Field Description (Envelope fields) BusinessProfileEventEnvelope.person_reference_idIdentifier of the removed officer/UBO.
Field Description (Envelope fields) BusinessProfileEventEnvelope.person_reference_idOfficer/UBO identifier. session_urlHosted capture URL for the officer. expires_atMillisecond epoch timestamp when the link expires. delivery_channelLINK or other transport indicator.
Field Description (Envelope fields) BusinessProfileEventEnvelope.person_reference_idOfficer/UBO identifier. session_urlHosted capture URL included in the email. expires_atMillisecond epoch timestamp when the link expires. delivery_channelEMAIL.email_addressRecipient email address used for the invitation.
Field Description (Envelope fields) BusinessProfileEventEnvelope.company_reference_idIdentifier of the added related company. legal_nameLegal name of the related company. jurisdictionJurisdiction of incorporation/registration. relationship_typeRelationship classification (e.g., PARENT, SUBSIDIARY). ownership_percentOwnership percentage for the relationship, if tracked.
Field Description (Envelope fields) BusinessProfileEventEnvelope.company_reference_idIdentifier of the edited related company. legal_nameUpdated legal name. jurisdictionUpdated jurisdiction. relationship_typeUpdated relationship classification. ownership_percentUpdated ownership percentage, if applicable.
Field Description (Envelope fields) BusinessProfileEventEnvelope.company_reference_idIdentifier of the removed related company.
Field Description (Envelope fields) BusinessProfileEventEnvelope.file_uuidIdentifier of the uploaded document. media_typeClassification of the document. uploaded_byIdentifier of the actor who uploaded the document. uploaded_atMillisecond epoch timestamp of the upload.
Field Description (Envelope fields) BusinessProfileEventEnvelope.file_uuidIdentifier of the updated document. media_typeClassification of the document. updated_byIdentifier of the actor who performed the update. updated_atMillisecond epoch timestamp of the update.
Field Description (Envelope fields) BusinessProfileEventEnvelope.file_uuidIdentifier of the removed document. deleted_byIdentifier of the actor who removed the document. deleted_atMillisecond epoch timestamp of the removal.
Field Description (Envelope fields) BusinessProfileEventEnvelope.verification_session_idIdentifier of the linked verification session (business, officer, or related company). verification_resultUpdated decision applied to the linked session. authorObject containing reviewer metadata. author_idReviewer identifier (usually email). reasonOptional reason provided for the update. person_reference_idOfficer/UBO identifier (when applicable). company_reference_idRelated company identifier (when applicable). file_uuidDocument identifier (when applicable).
Field Description (Envelope fields) BusinessProfileEventEnvelope.person_reference_idIdentifier of the related person whose data changed. section_nameSection that was updated. updated_fieldsObject containing previous and current values for the section fields. updated_byIdentifier of the actor who performed the change. updated_atMillisecond epoch timestamp of the change.
Field Description (Envelope fields) BusinessProfileEventEnvelope.commentText of the comment recorded against the profile or related case. authorObject containing commenter metadata. author_idCommenter identifier (usually email). created_atMillisecond epoch timestamp of the comment.
Field Description (Envelope fields) BusinessProfileEventEnvelope.ticketTicketPayload structure describing the ticket state.
Field Description (Envelope fields) BusinessProfileEventEnvelope.session_urlHosted capture URL for follow-up actions. expires_atMillisecond epoch timestamp when the link expires. delivery_channelLINK or other transport indicator.
Field Description (Envelope fields) BusinessProfileEventEnvelope.session_urlHosted capture URL included in the email. expires_atMillisecond epoch timestamp when the link expires. delivery_channelEMAIL.email_addressRecipient email address.
Field Description (Envelope fields) BusinessProfileEventEnvelope.verification_session_idLinked verification session associated with the decision change. resultNew profile-level decision. reasonOptional explanation for the decision change.
Field Description (Envelope fields) BusinessProfileEventEnvelope.tagsArray of tags now associated with the profile.
Field Description (Envelope fields) BusinessProfileEventEnvelope.verification_session_idIdentifier of the linked business verification session that submitted data.
Validate signatures by recomputing HMAC_SHA256(api_key, raw_payload) and rejecting mismatches.Respond quickly with HTTP 2xx and move heavy post-processing to background workers to avoid retries.Log callbacks with their identifiers (verification_session_id, user_profile_id, business_profile_id) so you can deduplicate or replay via callback_uuid.Consult Guides.md for implementation examples covering webhook verification, lifecycle handling, and retry patterns.
With these tabular payload definitions, you can map AiPrise callbacks directly into your internal models and maintain real-time automation across every verification journey.
