Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.

Body

application/json

The performer's signed request for a witness, with the digest the preview showed them.

command
string
required

The sync command of the held action, such as inventory.stock.adjust.

Maximum string length: 100
payload
object
required

The payload that command takes, as its sync command schema documents it, such as SyncCommandInventoryStockAdjust.

digest
string
required

The digest the preview returned for this action.

Required string length: 64
locale
enum<string> | null

The locale the statement is shown and kept in. Defaults to yours.

Available options:
en,
es,
fr-CA,
null

Response

VerificationStateResource

data
VerificationStateResource · object
required