Guides
Guides/Simulation

Simulation

Trigger broker application lifecycle webhook events on demand in the sandbox environment.

Simulation

Simulation endpoints are sandbox-only tools that trigger broker application lifecycle webhook events on demand — no need to wait for a real FV Bank reviewer. Use them to build and test your webhook handlers end-to-end.

All simulate endpoints return 400 in production — they are disabled outside the sandbox.


Key concepts

  • Status codes — 2 = Incomplete, 3 = Approved, 4 = Rejected. All three status endpoints use the same values.
  • IDs — Each endpoint needs the ID of the item being simulated. Retrieve them from GET /application/detail/{id}.
  • Remark field — The comment endpoint sends its text in Remark.

Common workflows

Test approval

  1. POST /simulate/form-status with Status 3 — fires form.approved.
  2. Verify your webhook handler receives and processes the event.

Test document rejection and re-upload

  1. POST /simulate/document-status with Status 4 — fires document.rejected.
  2. Re-upload the corrected file.
  3. POST /simulate/document-status with Status 3 — fires document.approved.

Test the ask flow

  1. POST /simulate/ask-created — fires form.incomplete and adds an open ask to the application.
  2. GET /application/detail/{id} — find the new ask in the Asks list.
  3. POST /application/ask/answer — submit the answer.

Test KYC approval

  1. GET /application/detail/{id} — find the individual/UBO ID in Kyc[].IndividualId.
  2. POST /simulate/kyc-status with IndividualId and Status: 3 — fires kyc.approved.

Test a reviewer comment

POST /simulate/comment-added with Id (ApplicationId) and a Remark — fires comment.created to your webhook.

Search guide books, endpoints, paths, or parameters

↑↓navigateopenEscclose