simulation labels that your team can use to simulate specific product flows in sandbox. Use simulation labels during your testing efforts and UAT integration.
Simulation labels are comma separated, and you can add your own labels alongside them (e.g. sim-onboarding-result:approved,customer-42,sim-offramp:payout-refunded). Bastion ignores labels it doesn’t recognize.
Set the labels in the identity’s label field when you call POST /v2/identities. They then apply to everything that identity does, including onboarding and conversions. To test a conversion outcome, put the onboarding label and the conversion label on the same identity, because the identity must be onboarded before it can convert.
Simulation labels have no effect in production.
Labels that set the same outcome don’t combine. For example, if an identity has two sim-onboarding-result labels, or two payout labels, only one applies. Labels for different steps, such as an onboarding result and a payout label, work together.
Onboarding and KYC/KYB simulation
For sandbox KYC and KYB, you can use thelabel field when calling POST /v2/identities to simulate KYC outcomes and submit dummy KYC/KYB information. Once POST /v2/identities/{identity_id}/compliance completes, the identity transitions to the state indicated by the simulation label.
Example:
POST /v2/identities
Identity verification (IDV) simulation
For sandbox IDV checks, you can use thelabels field when calling POST /v2/identities/{identityId}/id_verification to simulate IDV outcomes. Note that labels is an array.
Example:
POST /v2/identities/{identityId}/id_verification
On-ramp and off-ramp conversion simulations
Simulate an on-ramp deposit
Sandbox Virtual Accounts can’t receive real deposits. CallPOST /v2/simulation/on-ramp-deposit to simulate one and start the on-ramp flow a real deposit triggers. See Test the on-ramp in sandbox for the full steps.
Simulate conversion outcomes
By default, a sandbox conversion follows the happy path toCOMPLETED. To test how your integration handles failures and returns, add one of these labels to the identity before starting the conversion.
On-ramp
Off-ramp
Use one payout label per identity. The payout labels (
sim-offramp:payout-rejected, sim-offramp:payout-bank-bounce, sim-offramp:payout-refunded, and sim-offramp:payout-delay-<duration>) don’t combine: if an identity has more than one, only one of them applies.
Example: POST /v2/identities for an identity whose international off-ramps are returned