Creates a Business. By default, business creation is synchronous. To create a business asynchronously, set the 'synchronized' parameter to false in the 'meta' object. When set to false, the request returns immediately after input parameters validation and an async job is created to handle the business account creation.
Asynchronous Creation Webhooks: When 'synchronized' is set to false, webhooks will be sent to notify about the business creation outcome:
-
Success Webhook: Subscribe to the 'business' entity with event_type 'create' to receive notifications when business creation succeeds. The webhook will be triggered after the business account and its default subscription have been created, and will include the complete business data.
-
Failure Webhook: Subscribe to the 'account' entity with event_type 'rejected' to receive notifications when business creation fails. The webhook payload includes the email, external_reference_id (if provided), and an errors array containing validation error details.
Example request for asynchronous creation:
{
"admin_account": {
"email": "[email protected]",
"password": "password123"
},
"business": {
"name": "Admin Test"
},
"meta": {
"synchronized": false
}
}Example failure webhook payload:
{
"email": "[email protected]",
"external_reference_id": "unique_id",
"errors": [
{
"business_name": [
"contains invalid term"
]
}
]
}