Publish a template
Create a template and its permanent link in one call.
Authorizations
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.
Body
slug, name and steps are required. Everything else is optional.
URL-safe id, unique in your account: lowercase letters, digits and single hyphens.
2 - 40^[a-z0-9]+(?:-[a-z0-9]+)*$Name shown in the dashboard and to the person capturing.
1 - 80Steps every person goes through, in order.
1- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
capture (live photos, default), audit (uploaded files) or hybrid.
capture, audit, hybrid How long each verification minted from the link stays open, in seconds. Default 3600.
60 <= x <= 86400active (default) publishes the link. draft only allows simulation.
draft, active Key/value strings stamped on every verification from this template.
Street address every photo must be taken at. Turns on location_match.
1 - 300What must appear in the photos, e.g. "car". Turns on object_match.
1 - 200One to six aspects to score from 0 to 10. Turns on condition.
1 - 6 elements1 - 40Structured alternative to expected_location, expected_object and condition_aspects. Send one form or the other.
Maximum verifications per day. Absent = no cap.
1 <= x <= 10000Maximum verifications in total. Absent = no cap.
1 <= x <= 1000000Brand profile shown on the capture page. Absent = your default brand.
2 - 40^[a-z0-9]+(?:-[a-z0-9]+)*$Email that receives each result. Inherited by every verification from this template.
254Subject of the result email. {variable} placeholders allowed.
1Body of the result email. {variable} placeholders allowed.
1Full plain-text message shown after submitting content. HTML, markdown and variables are not interpreted. Omit on create or send null on PATCH to use the default.
1 - 2000Which step identifies the person, and how to find their row in the connected database.
Connected database: the table and which columns feed the checks.
Require a GPS fix on the first photo of every run without comparing it to an address.
Response
Template published. version is always 1 on create.
capture, audit, hybrid active, paused x >= 1Full plain-text message shown after submitting content. HTML, markdown and variables are not interpreted. Omit on create or send null on PATCH to use the default.
1 - 2000