Skip to main content
POST
/
api
/
v1
/
onboarding
/
handshake
cURL
curl --request POST \
  --url https://api.staging.qyl.dev/api/v1/onboarding/handshake \
  --header 'Content-Type: application/json' \
  --data '
{
  "code_challenge": "<string>",
  "client_id": "<string>"
}
'
{
  "id": "<string>",
  "workspace_id": "<string>",
  "challenge": "<string>",
  "challenge_method": "<string>",
  "state": "pending",
  "expires_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "browser_fingerprint": "<string>",
  "origin_url": "<string>",
  "verified_at": "2023-11-07T05:31:56Z"
}

Body

application/json

Handshake start request

​
code_challenge
string
required

PKCE code challenge

​
client_id
string
required

Client identifier

Response

The request has succeeded.

Browser-local handshake session for workspace verification

​
id
string
required

Session ID

​
workspace_id
string
required

Target workspace

​
challenge
string
required

PKCE-style challenge

​
challenge_method
string
required

Challenge method

​
state
enum<string>
required

Handshake state

Available options:
pending,
verified,
expired,
rejected
​
expires_at
string<date-time>
required

Expiration timestamp

​
created_at
string<date-time>
required

Creation timestamp

​
browser_fingerprint
string

Browser fingerprint

​
origin_url
string

Origin URL

​
verified_at
string<date-time>

Verification timestamp