Business Profile Events Callback

When events occur on the Business Profile, AiPrise sends a callback (a POST request) to the set events_callback_url.

There are two ways to set the events_callback_url:

  1. Set the events_callback_url at the template level. This can be set from the Dashboard > View Templates > {TemplateID}.
  2. Set the events_callback_url URL with each create business profile request using the parameter events_callback_url.

πŸ“˜

Note

In case events_callback_url is set in the create business profile request, it will take precedence over the one set at the template level.

Types of Events Callback

BUSINESS_PROFILE_CREATE

Payload:

KeyValue
business_profile_event_typeThe type of event callback. Here, it will beBUSINESS_PROFILE_CREATE
business_profile_idThe ID associated with the business profile

BUSINESS_PROFILE_INFO_UPDATE

Payload:

KeyValue
business_profile_event_typeThe type of event callback. Here, it will beBUSINESS_PROFILE_INFO_UPDATE
business_profile_idThe ID associated with the business profile

RUN_BUSINESS_VERIFICATION

Payload:

KeyValue
business_profile_event_typeThe type of event callback. Here, it will beRUN_BUSINESS_VERIFICATION
business_profile_idThe ID associated with the business profile
****Additionally, all fields from https://docs.aiprise.com/docs/business-verification-response

ADD_BUSINESS_OFFICER

Payload:

KeyValue
business_profile_event_typeThe type of event callback. Here, it will beADD_BUSINESS_OFFICER
business_profile_idThe ID associated with the business profile
****Additionally, all the fields from https://docs.aiprise.com/docs/business-verification-response#related_persons

BUSINESS_OFFICER_RUN_KYC

Payload:

KeyValue
business_profile_event_typeThe type of event callback. Here, it will beBUSINESS_OFFICER_RUN_KYC
business_profile_idThe ID associated with the business profile
person_reference_idUnique ID for the related person
****Additionally, all fields from https://docs.aiprise.com/docs/verification-result-1

EDIT_BUSINESS_OFFICER

Payload:

KeyValue
business_profile_event_typeThe type of event callback. Here, it will beEDIT_BUSINESS_OFFICER
business_profile_idThe ID associated with the business profile
person_reference_idAdditionally, all the fields from https://docs.aiprise.com/docs/business-verification-response#related_persons

DELETE_BUSINESS_OFFICER

Payload:

KeyValue
business_profile_event_typeThe type of event callback. Here, it will beDELETE_BUSINESS_OFFICER
business_profile_idThe ID associated with the business profile
person_reference_idThe ID associated with the deleted business officer

ADD_RELATED_COMPANY

Payload:

KeyValue
business_profile_event_typeThe type of event callback. Here, it will beADD_RELATED_COMPANY
business_profile_idThe ID associated with the business profile
****Additionally, all the fields from https://docs.aiprise.com/docs/business-verification-response#related_companies

RELATED_COMPANY_RUN_KYB

Payload:

KeyValue
business_profile_event_typeThe type of event callback. Here, it will be RELATED_COMPANY_RUN_KYB
business_profile_idThe ID associated with the business profile
company_reference_idUnique ID for the related company
****Additionally, all fields from https://docs.aiprise.com/docs/business-verification-response

EDIT_RELATED_COMPANY

Payload:

KeyValue
business_profile_event_typeThe type of event callback. Here, it will beEDIT_RELATED_COMPANY
business_profile_idThe ID associated with the business profile
****Additionally, all the fields from https://docs.aiprise.com/docs/business-verification-response#related_companies

DELETE_RELATED_COMPANY

Payload:

KeyValue
business_profile_event_typeThe type of event callback. Here, it will beDELETE_RELATED_COMPANY
business_profile_idThe ID associated with the business profile
company_reference_idThe ID associated with the added business officer

ADD_ADDITIONAL_MEDIA

Payload:

KeyValue
business_profile_event_typeThe type of event callback. Here, it will beADD_ADDITIONAL_MEDIA
business_profile_idThe ID associated with the business profile
file_uuidUnique ID associated with the added media

DELETE_ADDITIONAL_MEDIA

Payload:

KeyValue
business_profile_event_typeThe type of event callback. Here, it will beDELETE_ADDITIONAL_MEDIA
business_profile_idThe ID associated with the business profile
file_uuidUnique ID associated with the added media

BUSINESS_OFFICER_CREATE_SESSION_URL

Payload:

KeyValue
business_profile_event_typeThe type of event callback. Here, it will be BUSINESS_OFFICER_CREATE_SESSION_URL
business_profile_idThe ID associated with the business profile

BUSINESS_OFFICER_EMAIL_SESSION_URL

Payload:

KeyValue
business_profile_evenT_typeThe type of the event callback. Here, it will be BUSINESS_OFFICER_EMAIL_SESSION_URL
business_profile_idThe ID associated with the business profile

COMMENT

Payload:

KeyValue
business_profile_event_typeThe type of the event callback. Here, it will be COMMENT
business_profile_idThe ID associated with the business profile

RESULT_UPDATE

Payload:

KeyValue
business_profile_event_typeThe type of event callback. Here, it will be RESULT_UPDATE
business_profile_idThe ID associated with the business profile

SECTION_RESULT_UPDATE

Payload:

KeyValue
business_profile_event_typeThe type of event callback. Here, it will be SECTION_RESULT_UPDATE
business_profile_idThe ID associated with the business profile

RUN_BUSINESS_DOCUMENT_CHECK

Payload:

KeyValue
business_profile_event_typeThe type of event callback. Here, it will be RUN_BUSINESS_DOCUMENT_CHECK
business_profile_idThe ID associated with the business profile
file_uuidUnique ID associated with the added media