Business Profile Decision Callback
When decisions occur on the Business Profile, AiPrise sends a callback (a POST request) to the set callback_url.
There are two ways to set the callback_url:
- Set the
callback_urlat the template level. This can be set from theDashboard > View Templates > {TemplateID}. - Set the callback_url URL with each create business profile request using the parameter
callback_url.
NoteIn case callback_url is set in the create business profile request, it will take precedence over the one set at the template level.
Payload:
| Key | Value | Presence |
|---|---|---|
| business_profile_id | The ID associated with this business profile | Present |
| business_profile_result | The final decision for the business profile i.e APPROVED, DECLINED, REVIEW | Present |
| status | The run status of the verification. | Present |
| status_reasons | If for some reason, the verification failed, this populates the reasons. | Optional |
| business_info | Contains all the information extracted about the business | Optional |
| registration_info | Contains information about the registry record of the business | Optional |
| related_persons | Contains information about the directors & other officers of the company. | Optional |
| related_companies | Contains information about the subsidiaries & other related businesses. | Optional |
| aml_info | Contains AML checks of the business. | Optional |
| website_info | Contains information & insights scraped from their website. | Optional |
| events | Contains information about significant changes in the stakeholders/registration of the company. | Optional |
| lookup_info | Contains information about any government / public registry lookup performed. | Optional |
| client_reference_id | An ID you have associated with your verification request. | Present |
Updated 4 months ago
