Skip to main content
POST
Simulate biometric verification events

Body

application/json

Request payload for simulating biometric verification events for testing in non-production environments.

verification_id
string
required

Biometric verification ID to simulate an action for.

Example:

"inq_abc123xyz"

action
enum<string>
required

Biometric verification simulation action type.

Available options:
start_inquiry,
complete_inquiry,
fail_inquiry,
expire_inquiry,
mark_for_review_inquiry,
approve_inquiry,
decline_inquiry
Example:

"approve_inquiry"

Response

200 - application/json

Biometric verification event simulated successfully

Response payload from the verification simulation endpoint.

ok
boolean
required

Indicates whether the simulation request was processed successfully.

Example:

true

inquiryId
string
required

The biometric verification ID that was simulated.

Example:

"inq_abc123xyz"