Read the gating status for the signed-in user
curl --request GET \
--url https://api-sandbox.ledgersyncappv2.com/v3/portal/access-request/status \
--header 'X-Portal-Bootstrap-Signature: <x-portal-bootstrap-signature>' \
--header 'X-Portal-Workos-User-Id: <x-portal-workos-user-id>'import requests
url = "https://api-sandbox.ledgersyncappv2.com/v3/portal/access-request/status"
headers = {
"X-Portal-Bootstrap-Signature": "<x-portal-bootstrap-signature>",
"X-Portal-Workos-User-Id": "<x-portal-workos-user-id>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {
'X-Portal-Bootstrap-Signature': '<x-portal-bootstrap-signature>',
'X-Portal-Workos-User-Id': '<x-portal-workos-user-id>'
}
};
fetch('https://api-sandbox.ledgersyncappv2.com/v3/portal/access-request/status', 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-sandbox.ledgersyncappv2.com/v3/portal/access-request/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Portal-Bootstrap-Signature: <x-portal-bootstrap-signature>",
"X-Portal-Workos-User-Id: <x-portal-workos-user-id>"
],
]);
$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-sandbox.ledgersyncappv2.com/v3/portal/access-request/status"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Portal-Bootstrap-Signature", "<x-portal-bootstrap-signature>")
req.Header.Add("X-Portal-Workos-User-Id", "<x-portal-workos-user-id>")
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-sandbox.ledgersyncappv2.com/v3/portal/access-request/status")
.header("X-Portal-Bootstrap-Signature", "<x-portal-bootstrap-signature>")
.header("X-Portal-Workos-User-Id", "<x-portal-workos-user-id>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.ledgersyncappv2.com/v3/portal/access-request/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Portal-Bootstrap-Signature"] = '<x-portal-bootstrap-signature>'
request["X-Portal-Workos-User-Id"] = '<x-portal-workos-user-id>'
response = http.request(request)
puts response.read_body{
"sandbox_status": "PENDING",
"live_status": "PENDING",
"sandbox_denial_reason_code_public": "<string>",
"live_denial_reason_code_public": "<string>"
}{
"error": {
"code": "unknown_api_key",
"message": "The API key you presented doesn't match any active key.",
"type": "auth_error",
"doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key",
"category": "AUTH_ERROR",
"is_user_actionable": true,
"source_diagnostic_code": "FIN-103",
"param": "client.email",
"trace_id": "4bf92f3577b34da6a3ce929d0e0e4736",
"errors": [
{
"param": "client.email",
"message": "must be a valid email address",
"code": "invalid_email"
}
]
}
}{
"error": {
"code": "unknown_api_key",
"message": "The API key you presented doesn't match any active key.",
"type": "auth_error",
"doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key",
"category": "AUTH_ERROR",
"is_user_actionable": true,
"source_diagnostic_code": "FIN-103",
"param": "client.email",
"trace_id": "4bf92f3577b34da6a3ce929d0e0e4736",
"errors": [
{
"param": "client.email",
"message": "must be a valid email address",
"code": "invalid_email"
}
]
}
}PortalGating
Read the gating status for the signed-in user
Returns the latest sandbox + live status for the WorkOS user
whose id is supplied as the X-Portal-Workos-User-Id header.
The HMAC signature is computed over that header value (the
endpoint has no body), keeping the identity unforgeable.
Either status field is null when the user has not yet filed a sandbox or live application.
GET
/
portal
/
access-request
/
status
Read the gating status for the signed-in user
curl --request GET \
--url https://api-sandbox.ledgersyncappv2.com/v3/portal/access-request/status \
--header 'X-Portal-Bootstrap-Signature: <x-portal-bootstrap-signature>' \
--header 'X-Portal-Workos-User-Id: <x-portal-workos-user-id>'import requests
url = "https://api-sandbox.ledgersyncappv2.com/v3/portal/access-request/status"
headers = {
"X-Portal-Bootstrap-Signature": "<x-portal-bootstrap-signature>",
"X-Portal-Workos-User-Id": "<x-portal-workos-user-id>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {
'X-Portal-Bootstrap-Signature': '<x-portal-bootstrap-signature>',
'X-Portal-Workos-User-Id': '<x-portal-workos-user-id>'
}
};
fetch('https://api-sandbox.ledgersyncappv2.com/v3/portal/access-request/status', 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-sandbox.ledgersyncappv2.com/v3/portal/access-request/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Portal-Bootstrap-Signature: <x-portal-bootstrap-signature>",
"X-Portal-Workos-User-Id: <x-portal-workos-user-id>"
],
]);
$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-sandbox.ledgersyncappv2.com/v3/portal/access-request/status"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Portal-Bootstrap-Signature", "<x-portal-bootstrap-signature>")
req.Header.Add("X-Portal-Workos-User-Id", "<x-portal-workos-user-id>")
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-sandbox.ledgersyncappv2.com/v3/portal/access-request/status")
.header("X-Portal-Bootstrap-Signature", "<x-portal-bootstrap-signature>")
.header("X-Portal-Workos-User-Id", "<x-portal-workos-user-id>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.ledgersyncappv2.com/v3/portal/access-request/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Portal-Bootstrap-Signature"] = '<x-portal-bootstrap-signature>'
request["X-Portal-Workos-User-Id"] = '<x-portal-workos-user-id>'
response = http.request(request)
puts response.read_body{
"sandbox_status": "PENDING",
"live_status": "PENDING",
"sandbox_denial_reason_code_public": "<string>",
"live_denial_reason_code_public": "<string>"
}{
"error": {
"code": "unknown_api_key",
"message": "The API key you presented doesn't match any active key.",
"type": "auth_error",
"doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key",
"category": "AUTH_ERROR",
"is_user_actionable": true,
"source_diagnostic_code": "FIN-103",
"param": "client.email",
"trace_id": "4bf92f3577b34da6a3ce929d0e0e4736",
"errors": [
{
"param": "client.email",
"message": "must be a valid email address",
"code": "invalid_email"
}
]
}
}{
"error": {
"code": "unknown_api_key",
"message": "The API key you presented doesn't match any active key.",
"type": "auth_error",
"doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key",
"category": "AUTH_ERROR",
"is_user_actionable": true,
"source_diagnostic_code": "FIN-103",
"param": "client.email",
"trace_id": "4bf92f3577b34da6a3ce929d0e0e4736",
"errors": [
{
"param": "client.email",
"message": "must be a valid email address",
"code": "invalid_email"
}
]
}
}Headers
Hex HMAC-SHA256 of the raw request body (or, for the GET
status endpoint, of the X-Portal-Workos-User-Id header
value) computed with the shared portal bootstrap secret.
WorkOS user id whose gating status is being read.
Response
Latest sandbox and live status.
⌘I
