Skip to main content
POST
Record dispatch immediately before the provider call

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

checkfu-version
enum<string>
required
Available options:
2026-08-27
idempotency-key
string
Maximum string length: 255

Body

application/json
key
object
required
generation
integer
required
Required range: x > 0
owner
string
required
Required string length: 1 - 128

Response

Success

key
object
required
generation
integer
required
Required range: x > 0
owner
string
required
Required string length: 1 - 128
lease_expires_at
string | null
required
state
enum<string>
required
Available options:
claimed,
dispatching,
posted,
known_failed,
indeterminate,
superseded
through_sequence
integer
required
Required range: x >= 0
provider_message_id
string | null
required
claimed_at
string
required
dispatch_started_at
string | null
required
settled_at
string | null
required