Simulate account amendment status transition
You can conduct unit and end-to-end testing of your accounts integration by simulating account amendment approvals and rejection in the demo environment. These simulation APIs allow you to make account amendments such as updating business details or primary contact details without requiring KYC review.
Key simulation scenarios include:
- Approve an account amendment
- Reject an account amendment
The approve and reject actions are asynchronous and may take some time to complete. The simulation APIs do not guarantee an immediate status change upon request. We recommend that you subscribe to account amendment webhooks to listen for status changes.
As a platform account, you can call the simulation APIs on behalf of a connected account using the x-on-behalf-of header.
Approve an account amendment
Create an account amendment API on an account that has passed KYC verification by specifying the details you want to amend. A successful response will return a unique identifier for the amendment and the status as PENDING.
Call Approve an account amendment API using the amendment ID. Subscribe to account amendment webhooks and listen for account_amendment.approved event for the status change to APPROVED.
Reject an account amendment
Call Reject an account amendment API using the identifier of the amendment in status PENDING. Subscribe to account amendment webhooks and listen for account_amendment.rejected event for the status change to REJECTED.
The response object is the same as Get an account amendment API.
Troubleshooting
| Error | Error response | Recommended actions |
|---|---|---|
| Amendment is not found | {
|
Check if the amendment is under the current account. |
| Amendment is not in PENDING state | {
|
Only amendments in the PENDING state can be approved or rejected. |
| Amendment is not ready to be operated | {
|
The automation is still running. Try again later. |