Simulation

What is Simulation?

The Simulation group provides a safe way to test KYC result handling in the staging environment. This is especially useful for developers and QA teams who need to:

• Mimic various KYC outcomes (approved, rejected, temp_rejected)
• Validate how different flows respond to identity verification results
• Populate entities with mock KYC requirement data for demo or test cases

This simulation does not trigger any real provider integrations and ensures no live data is affected.

⚠️

Simulation endpoints are disabled in production.

---

✨ Use Cases

• End-to-end testing of onboarding flows without real users
• Triggering specific UI states (e.g., approval success, retry prompt)
• Preloading demo environments with mock KYC data
• Verifying webhook and notification handling

---

⚙️ How It Works

When the simulation endpoint is called, the system:

1. Verifies the provided entityId
2. Creates or updates a KYC requirement for that entity
3. Sets the requirement status based on the status value in the request
4. Adds mock KYC details (e.g., selfie checks, document metadata)