Skip to main content
POST
Simulate a template

Authorizations

Authorization
string
header
required

Secret API key, created in the dashboard under Settings → API. Send it as Authorization: Bearer rk_secret_… from your server only. Publishable keys (pk_live_…) are for the native SDKs and reach the capture endpoints alone. An unknown key returns 401.

Path Parameters

slug
string
required

Template slug — lowercase [a-z0-9-].

Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
Example:

"warehouse-intake"

Response

Sandbox verification minted from the snapshot.

verification_id
string
required
capture_url
string<uri>
required
simulation
enum<boolean>
required
Available options:
true