In your test environment, all verification checks are passed by default when the required fields and documents are provided. To test your error handling flow, you can force a scenario where one or more verification checks fail.
This allows you to reproduce an unsuccessful verification flow, including the result and corresponding verification codes. You can then also test the remediating flow to resolve the verification errors.
Before you begin
Step 1: Make an API request
You can use requested verification codes for the following endpoints:
Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.
In this example, you want to test the
1_3004 suberror code
The name and residence country couldn't be verified for an individual legal entity. This triggers the following verification checks:
- Name and date of birth check
- Residency country check
In the header of your POST /legalEntities request, include
Step 2: Create account holder
For error tests for legal entities, you need to create an account holder for the legal entity of the organization, individual, or sole proprietorship.
For error tests for documents or transfer instruments, you need to create an account holder for the legal entity who owns the resource.
Step 3: Check verification errors
To get updates about the failed verification and the corresponding error codes, you can:
- Listen to the balancePlatform.accountHolder.updated or
- Make a GET API request for the particular legal entity, document, or transfer instrument.
Step 4: Test the remediating flow and resolve verification errors
To simulate the resolution of the verification errors, in your test environment, include the
x-requested-verification-code: 0_0001 in the header of your API request.
The requested verification code can be used for the following endpoints in the Legal Entity Management API:
If your error handling is successful, the requested verification code resolves any suberrors associated with the legal entity, document, or transfer instrument.