Get handshake

Get handshake session status

GET /api/v1/onboarding/handshake/{sessionId}

cURL

cURL

curl --request GET \
  --url https://api.staging.qyl.dev/api/v1/onboarding/handshake/{sessionId}

import requests

url = "https://api.staging.qyl.dev/api/v1/onboarding/handshake/{sessionId}"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.staging.qyl.dev/api/v1/onboarding/handshake/{sessionId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.staging.qyl.dev/api/v1/onboarding/handshake/{sessionId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.staging.qyl.dev/api/v1/onboarding/handshake/{sessionId}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.staging.qyl.dev/api/v1/onboarding/handshake/{sessionId}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.staging.qyl.dev/api/v1/onboarding/handshake/{sessionId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

200

{
  "id": "<string>",
  "workspace_id": "<string>",
  "challenge": "<string>",
  "challenge_method": "<string>",
  "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"
}

{
  "type": "about:blank",
  "title": "Not Found",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "timestamp": "2023-11-07T05:31:56Z",
  "resource_type": "<string>",
  "resource_id": "<string>"
}

{
  "type": "about:blank",
  "title": "Internal Server Error",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "timestamp": "2023-11-07T05:31:56Z",
  "error_code": "<string>"
}

Path Parameters

sessionId · string · required

Response

200

application/json

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