Events to check account status

Use registration status events to automatically track changes to an account's commercial information, bank account, documentation and general approval.

Each notification indicates the change in event and the current registration status in the accountStatus object.

Available events

Bank account

Commercial information

Documentation

General approval

When accountStatus.general is APPROVED, the account's general approval is complete.

Annual confirmation of commercial data

For subaccounts subject to annual confirmation, the following may also be sent:

ACCOUNT_STATUS_COMMERCIAL_INFO_EXPIRING_SOON is sent before the expiration date so that the integration can request confirmation or update of the data.

When you receive ACCOUNT_STATUS_COMMERCIAL_INFO_EXPIRED, handle the pending item even if accountStatus.commercialInfo and accountStatus.general are still APPROVED. The annual expiration is controlled separately from the registration approval.

See the complete flow in Annual Confirmation of Commercial Data for Subaccounts.

Event payload

The notification is sent via POST with the event and the current account status.

{
    "id": "evt_05b708f961d739ea7eba7e4db318f621&368604920",
    "event": "ACCOUNT_STATUS_COMMERCIAL_INFO_APPROVED",
    "dateCreated": "2024-06-12 16:45:03",
    "account": {
        "id": "47ed0d25-f9fb-4b35-b23a-d8895caf92b7",
        "ownerId": null
    },
    "accountStatus": {
        "id": "175027c1-029c-41e5-8b9a-e289b9788c33",
        "commercialInfo": "APPROVED",
        "bankAccountInfo": "APPROVED",
        "documentation": "APPROVED",
        "general": "APPROVED"
    }
}

Important payload fields

How to handle the events

When receiving a registration status event:

1. identify the change through the event field;
2. persist the id to prevent duplicate processing;
3. use account.id to identify the account in your system;
4. update the corresponding dimension using the accountStatus data;
5. respond HTTP 200 after confirming persistence;
6. process additional rules asynchronously.

Webhooks follow the at least once model, so the same event may be sent more than once.

See how to implement idempotence in Webhooks.

To track registration changes, prefer these events instead of continuously querying the account status through the API. Use the individual query when you need to retrieve the current state on demand.

Next steps

• Understand the annual confirmation of subaccount commercial data
• Receive Asaas events at your Webhook endpoint
• Implement idempotence in Webhooks
• Monitor the Webhook Logs
• See the other Webhook Events