Simulations

Simulate Application Approval

⚠️ Sandbox & development only. Simulation endpoints are not available in production and return 404 Not Found there.

Approves a submitted onboarding application in the sandbox as if the compliance review had passed, and kicks off checking-account onboarding for the selected product. Every representative must have passed identity verification (kyc_status is approved) first: like real review, the simulation will not approve an application whose beneficial owner failed KYC, and returns 400 until they pass. Requires an entity API key scoped to the requested entity, or a global API key with the simulations:write scope whose user administers the entity; the application must already be submitted. The application status moves to submitted immediately and to approved once the checking account activates. Poll GET /entities/{entity_id} or subscribe to application.* webhooks to observe the transition. Safe to call repeatedly: if account opening stalls in the sandbox, calling this again completes it.

post/simulations/entities/{entity_id}/application_approval

Request

Path parameters

entity_idstring required

The entity being onboarded.

Request body

banking_account_product_type'grasshopper' | 'crb'

Response

Successful Response

entity_idstring uuid required

Public ID of the onboarded business entity, stable across the onboarding lifecycle and matching the entity_id used in the Customer API, MCP, and webhook payloads.

status'pending_document_upload' | 'pending_user_action' | 'submitted' | 'under_review' | 'approved' | 'rejected' required
business_namestring nullable required

Legal business name.

created_atstring date-time required

ISO 8601 date-time in the format YYYY-MM-DDThh:mm:ss.nnn[Z|[+|-]hh:mm] (per IETF RFC 3339).

updated_atstring date-time required

ISO 8601 date-time in the format YYYY-MM-DDThh:mm:ss.nnn[Z|[+|-]hh:mm] (per IETF RFC 3339).

kyc_status'not_started' | 'pending' | 'action_required' | 'approved' | 'rejected' required
onboarding_type'api' | 'smb' | 'mcp' | 'partner' required
consent_urlstring nullable required

Link where the primary representative reviews and accepts the required agreements and disclosures in their browser. Populated once the application has been submitted; share it with the primary representative. The link needs no login and anyone holding it can accept on the business's behalf, so treat it as a secret.

Changes

No recorded changes to this operation across all 1 revision of this API.