Simulate individual KYC
Learn how to trigger specific KYC statuses by submitting predetermined test data during the verification process. This guide helps you understand the end-to-end user journey for individual KYC approvals and rejections in the staging environment.
Use Cases:
- You need to simulate an individual KYC approval to test the success scenarios of your onboarding process.
- You need to simulate an individual KYC rejection to test the negative scenarios of your onboarding process.
Prerequisites:
- You must already have an registered individual user that is ready to perform KYC. Refer to the Submit individual KYC section to learn about the specific required KYC criteria.
Simulation Workflow
[PH] Document-based verification
[PH] Document-based verification
Simulated KYC Approval
Once a user profile is complete and their KYC application has been submitted, you can seamlessly test your onboarding flow using a simulated KYC approval in the staging environment. This feature allows you to bypass real document processing and safely evaluate how your system responds to a successful user verification. To simulate approval, please follow these steps:
1
[Pre-KYC Submission] Register the user
Go through the normal process of creating a user and KYC document submission:
- Register the information details of the user — Create Individual Users
- Complete missing required information (if any) — Update Individual Users
- Verify the mobile and email of the user — User Contact Verification
2
[Pre-KYC Submission] Initiate verification with simulation flag
To enable KYC simulation mode, initiate the verification process by passing the is_simulate and the verification_mode parameters to the Initiate KYC Submission API.
Initiate KYC Submission request (with simulation flag)
curl --location --request POST 'https://{{identity_base_url}}/{{program_code}}/v2/users/authentications/documents/verifications' \
--header 'X-Auth-User-ID: {{user_id}}' \
--header 'Authorization: ••••••' \
--header 'Content-Type: application/json' \
--data-raw '{
"is_simulate": true,
"verification_mode": "document_based"
}'
3
[Pre-KYC Submission] KYC document upload
Refer to the following steps above to satisfy the verification requirements:
- [PH] Document-based verificationn, section 3. Collect and upload supporting documents (immediately_due.required_documents)
- User will need to upload the required documents.
4
[Pre-KYC Submission] Confirm KYC submission for approval
Refer to the following steps above to submit the KYC application:
- [PH] Document-based verificationn, section 4. Confirm all uploads and submit KYC for approval
- This will invoke the KYC approval process
5
[Post-KYC Submission] Update the status of the KYC application to trigger approval simulation
To start the KYC approval simulation process, we need to update the Update KYC status with the supported approval simulation status:
| User Activation
|
|---|---|
| User Pending Manual Review |
Update KYC Status request (with approval simulation status)
curl --location --request PUT 'https://{{identity_base_url}}/{{program_code}}/v2/simulate/users/authentications/documents/status' \
--header 'X-Auth-User-ID: {{user_id}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••'' \
--data-raw '{
"status": "ACTIVE"
}'
Immediately after the KYC approval simulation process has completed on the backend, your user should be updated with the expected simulated results.
Simulated KYC Rejection
You can also test your application's response to an unsuccessful user verification by triggering a simulated KYC rejection in the staging environment. This approach eliminates the need for real document evaluation, allowing you to safely observe your system's error-handling workflows. To simulate rejection, please follow these steps:
1
[Pre-KYC Submission] Register user and submit KYC application (with simulation identifier)
Go through the normal process of creating a user and KYC document submission:
- Register the information details of the user — Create Individual Users
- Complete missing required information (if any) — Update Individual Users
- To help the simulation logic identify users bound for rejection — Update Individual Users (
"middle_name": "VERIFICATION-FAILED") - Verify the mobile and email of the user — User Contact Verification
Update Individual Users request (with middle_name simulation identifier)
curl --location --request PUT 'https://{{identity_base_url}}/{{program_code}}/v2/users/{{user_id}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data-raw '{
"middle_name": "VERIFICATION-FAILED"
}'
2
[Pre-KYC Submission] Initiate verification with simulation flag
To enable KYC simulation mode, initiate the verification process by passing the is_simulate and the verification_mode parameters to the Initiate KYC Submission API.
Initiate KYC Submission request (with simulation flag)
curl --location --request POST 'https://{{identity_base_url}}/{{program_code}}/v2/users/authentications/documents/verifications' \
--header 'X-Auth-User-ID: {{user_id}}' \
--header 'Authorization: ••••••' \
--header 'Content-Type: application/json' \
--data-raw '{
"is_simulate": true,
"verification_mode": "document_based"
}'
3
[Pre-KYC Submission] KYC document upload
Refer to the following steps above to satisfy the verification requirements:
- [PH] Document-based verification, section 3. Collect and upload supporting documents (immediately_due.required_documents)
- The user will need to upload the required documents.
4
[Pre-KYC Submission] Confirm KYC submission for approval
Refer to the following steps above to submit the KYC application:
- [PH] Document-based verification, section 4. Confirm all uploads and submit KYC for approval
- This will invoke the KYC approval process
5
[Post-KYC Submission] Update the status of the KYC application to trigger rejection simulation
To start the KYC rejection simulation process, we need to Update KYC status to any of the available rejection simulation statuses:
| User Termination
|
| User Rejection
|
| User Suspension
|
Update KYC Status request (with rejection simulation status)
curl --location --request PUT 'https://{{identity_base_url}}/{{program_code}}/v2/simulate/users/authentications/documents/status' \
--header 'X-Auth-User-ID: {{user_id}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••'' \
--data-raw '{
"status": "ACCOUNT_REJECTED"
}'
Immediately after the KYC rejection simulation process has completed on the backend, your user should be updated with the expected simulated results.
[PH] Authentication-based verification
[PH] Authentication-based verification
Simulated KYC Approval
Once a user profile is complete and their KYC application has been submitted, you can seamlessly test your onboarding flow using a simulated KYC approval in the staging environment. This feature allows you to bypass real document processing and safely evaluate how your system responds to a successful user verification. To simulate approval, please follow these steps:
1
[Pre-KYC Submission] Register the user
Go through the normal process of creating a user and KYC document submission:
- Register the information details of the user — Create Individual User
- Complete missing required information (if any) — Update Individual Users
- Verify the mobile and email of the user — User Contact Verification
2
[Pre-KYC Submission] Initiate verification with simulation flag
To enable KYC simulation mode, initiate the verification process by passing the is_simulate and the verification_mode parameters to the Initiate KYC Submission API.
Inititate KYC Submission request (with simulation flag)
curl --location --request POST 'https://{{identity_base_url}}/{{program_code}}/v2/users/authentications/documents/verifications' \
--header 'X-Auth-User-ID: {{user_id}}' \
--header 'Authorization: ••••••' \
--header 'Content-Type: application/json' \
--data-raw '{
"is_simulate": true,
"verification_mode": "authentication_based"
}'
3
[Pre-KYC Submission] KYC document upload
Refer to the following steps above to satisfy the verification requirements:
- [PH] Authentication-based verificationn, section 3. Collect and upload supporting documents (immediately_due.required_documents)
- The user will need to upload the required documents.
4
[Pre-KYC Submission] Confirm KYC submission for approval
Refer to the following steps above to submit the KYC application:
- [PH] Authentication-based verificationn, section 4. Confirm all uploads and submit KYC for approval
- This will invoke the KYC approval process
5
[Post-KYC Submission] Update the status of the KYC application to trigger approval simulation
To start the KYC approval simulation process, we need to Update KYC status with the supported approval simulation status:
| User Activation
|
|---|---|
| User Pending Manual Review |
Update KYC Status request (with approval simulation status)
curl --location --request PUT 'https://{{identity_base_url}}/{{program_code}}/v2/simulate/users/authentications/documents/status' \
--header 'X-Auth-User-ID: {{user_id}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••'' \
--data-raw '{
"status": "ACTIVE"
}'
Immediately after the KYC approval simulation process has completed on the backend, your user should be updated with the expected simulated results.
Simulated KYC Rejection
You can also test your application's response to an unsuccessful user verification by triggering a simulated KYC rejection in the staging environment. This approach eliminates the need for real document evaluation, allowing you to safely observe your system's error-handling workflows. To simulate rejection, please follow these steps:
1
[Pre-KYC Submission] Register user and submit KYC application (with simulation identifier)
Go through the normal process of creating a user and KYC document submission:
- Register the information details of the user — Create Individual Users
- Complete missing required information (if any) — Update Individual Users
- To help the simulation logic identify users bound for rejection — Update Individual Users (
"middle_name": "VERIFICATION-FAILED") - Verify the mobile and email of the user — User Contact Verification
Update Individual User request (with middle_name simulation identifier)
curl --location --request PUT 'https://{{identity_base_url}}/{{program_code}}/v2/users/{{user_id}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data-raw '{
"middle_name": "VERIFICATION-FAILED"
}'
2
[Pre-KYC Submission] Initiate verification with simulation flag
To enable KYC simulation mode, initiate the verification process by passing the is_simulate and the verification_mode parameters to the Initiate KYC Submission API.
Initiate KYC Submission request (with simulation flag)
curl --location --request POST 'https://{{identity_base_url}}/{{program_code}}/v2/users/authentications/documents/verifications' \
--header 'X-Auth-User-ID: {{user_id}}' \
--header 'Authorization: ••••••' \
--header 'Content-Type: application/json' \
--data-raw '{
"is_simulate": true,
"verification_mode": "authentication_based"
}'
3
[Pre-KYC Submission] KYC document upload
Refer to the following steps above to satisfy the verification requirements:
- [PH] Authentication-based verification, section 3. Collect and upload supporting documents (immediately_due.required_documents)
- The user will need to upload the required documents.
4
[Pre-KYC Submission] Confirm KYC submission for approval
Refer to the following steps above to submit the KYC application:
- [PH] Authentication-based verification, section 4. Confirm all uploads and submit KYC for approval
- This will invoke the KYC approval process
5
[Post-KYC Submission] Update the status of the KYC application to trigger rejection simulation
To start the KYC rejection simulation process, we need to Update KYC status to any of the available rejection simulation statuses:
| User Rejection
|
| User Rejection
|
Update KYC Status request (with rejection simulation status)
curl --location --request PUT 'https://{{identity_base_url}}/{{program_code}}/v2/simulate/users/authentications/documents/status' \
--header 'X-Auth-User-ID: {{user_id}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••'' \
--data-raw '{
"status": "MISMATCH_AUTHENTICATION_PROFILE_DETAILS"
}'
Immediately after the KYC rejection simulation process has completed on the backend, your user should be updated with the expected simulated results.
On this page
- Simulate individual KYC