Skip to main content
POST
Create a BootstrapRequest

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-31

Body

application/json
starter
object
required
cli_version
string
required
Maximum string length: 32
Pattern: ^\d+\.\d+\.\d+$
client_challenge
string
required
Pattern: ^sha256:[0-9a-f]{64}$
client_encryption_public_key
string
required
Pattern: ^[A-Za-z0-9_-]{43}$
safe_project_fingerprint
string
required
Required string length: 8 - 128
Pattern: ^[a-z0-9][a-z0-9._-]{7,127}$
requested_capability_ids
string[]
required
Maximum array length: 16
Required string length: 1 - 64
Pattern: ^[a-z][a-z0-9_-]{0,63}$
requested_connection_requirements
object[]
required
Maximum array length: 8

Response

Success

bootstrap_id
string
required
Pattern: ^bst_[0-9a-f]{32}$
verification_uri
string
required
Pattern: ^https:\/\/[a-z0-9.-]+\/activate$
verification_uri_complete
string
required
Required string length: 24 - 512
user_code
string
required
Pattern: ^[A-Z2-9]{4}-[A-Z2-9]{4}$
poll_token
string
required
Required string length: 32 - 128
Pattern: ^[A-Za-z0-9_-]+$
expires_at
string
required

A canonical UTC ISO-8601 timestamp with millisecond precision.

Maximum string length: 24
Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
poll_interval_seconds
integer
required
Required range: 1 <= x <= 60