Create a Gate signup session
curl --request POST \
--url https://api.usefoil.com/v1/gate/sessions \
--header 'Content-Type: application/json' \
--data '
{
"service_id": "gsvc_0123456789abcdefghjkmnpqrs",
"account_name": "Acme Growth Workspace",
"delivery": {
"version": 1,
"algorithm": "x25519-hkdf-sha256/aes-256-gcm",
"key_id": "key_6cw04zdmetw8t5rsdppadhper0",
"public_key": "pk_live_dZO3Bl6MqLn2VJYy18bjGkbPRCkubdgK"
}
}
'import requests
url = "https://api.usefoil.com/v1/gate/sessions"
payload = {
"service_id": "gsvc_0123456789abcdefghjkmnpqrs",
"account_name": "Acme Growth Workspace",
"delivery": {
"version": 1,
"algorithm": "x25519-hkdf-sha256/aes-256-gcm",
"key_id": "key_6cw04zdmetw8t5rsdppadhper0",
"public_key": "pk_live_dZO3Bl6MqLn2VJYy18bjGkbPRCkubdgK"
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
service_id: 'gsvc_0123456789abcdefghjkmnpqrs',
account_name: 'Acme Growth Workspace',
delivery: {
version: 1,
algorithm: 'x25519-hkdf-sha256/aes-256-gcm',
key_id: 'key_6cw04zdmetw8t5rsdppadhper0',
public_key: 'pk_live_dZO3Bl6MqLn2VJYy18bjGkbPRCkubdgK'
}
})
};
fetch('https://api.usefoil.com/v1/gate/sessions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.usefoil.com/v1/gate/sessions"
payload := strings.NewReader("{\n \"service_id\": \"gsvc_0123456789abcdefghjkmnpqrs\",\n \"account_name\": \"Acme Growth Workspace\",\n \"delivery\": {\n \"version\": 1,\n \"algorithm\": \"x25519-hkdf-sha256/aes-256-gcm\",\n \"key_id\": \"key_6cw04zdmetw8t5rsdppadhper0\",\n \"public_key\": \"pk_live_dZO3Bl6MqLn2VJYy18bjGkbPRCkubdgK\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}require 'uri'
require 'net/http'
url = URI("https://api.usefoil.com/v1/gate/sessions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"service_id\": \"gsvc_0123456789abcdefghjkmnpqrs\",\n \"account_name\": \"Acme Growth Workspace\",\n \"delivery\": {\n \"version\": 1,\n \"algorithm\": \"x25519-hkdf-sha256/aes-256-gcm\",\n \"key_id\": \"key_6cw04zdmetw8t5rsdppadhper0\",\n \"public_key\": \"pk_live_dZO3Bl6MqLn2VJYy18bjGkbPRCkubdgK\"\n }\n}"
response = http.request(request)
puts response.read_body<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.usefoil.com/v1/gate/sessions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'service_id' => 'gsvc_0123456789abcdefghjkmnpqrs',
'account_name' => 'Acme Growth Workspace',
'delivery' => [
'version' => 1,
'algorithm' => 'x25519-hkdf-sha256/aes-256-gcm',
'key_id' => 'key_6cw04zdmetw8t5rsdppadhper0',
'public_key' => 'pk_live_dZO3Bl6MqLn2VJYy18bjGkbPRCkubdgK'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"data": {
"object": "gate_session",
"id": "gate_0123456789abcdefghjkmnpqrs",
"status": "pending",
"poll_token": "gtpl_01hzy4k2s6m8n1p3q5r7t9v2wx",
"consent_url": "https://app.acme.co/signup",
"expires_at": "2026-03-24T20:00:05.000Z"
},
"meta": {
"request_id": "req_cf147349a4134208aebb8c70e25fb7e1"
}
}{
"error": {
"code": "request.validation_failed",
"message": "Observation payload failed validation.",
"status": 1,
"retryable": true,
"request_id": "req_cf147349a4134208aebb8c70e25fb7e1",
"docs_url": "https://app.acme.co/signup",
"details": {
"fields": [
{
"name": "Acme Growth Workspace",
"issue": "required",
"expected": "string",
"received": "any_of"
}
],
"allowed_values": [
"verified"
],
"header_name": "x-forwarded-for",
"parameter_set": "browser_fingerprint",
"next_action": "retry"
}
}
}{
"error": {
"code": "request.validation_failed",
"message": "Observation payload failed validation.",
"status": 1,
"retryable": true,
"request_id": "req_cf147349a4134208aebb8c70e25fb7e1",
"docs_url": "https://app.acme.co/signup",
"details": {
"fields": [
{
"name": "Acme Growth Workspace",
"issue": "required",
"expected": "string",
"received": "any_of"
}
],
"allowed_values": [
"verified"
],
"header_name": "x-forwarded-for",
"parameter_set": "browser_fingerprint",
"next_action": "retry"
}
}
}{
"error": {
"code": "request.validation_failed",
"message": "Observation payload failed validation.",
"status": 1,
"retryable": true,
"request_id": "req_cf147349a4134208aebb8c70e25fb7e1",
"docs_url": "https://app.acme.co/signup",
"details": {
"fields": [
{
"name": "Acme Growth Workspace",
"issue": "required",
"expected": "string",
"received": "any_of"
}
],
"allowed_values": [
"verified"
],
"header_name": "x-forwarded-for",
"parameter_set": "browser_fingerprint",
"next_action": "retry"
}
}
}Signup sessions
Create a Gate signup session
POST
/
v1
/
gate
/
sessions
Create a Gate signup session
curl --request POST \
--url https://api.usefoil.com/v1/gate/sessions \
--header 'Content-Type: application/json' \
--data '
{
"service_id": "gsvc_0123456789abcdefghjkmnpqrs",
"account_name": "Acme Growth Workspace",
"delivery": {
"version": 1,
"algorithm": "x25519-hkdf-sha256/aes-256-gcm",
"key_id": "key_6cw04zdmetw8t5rsdppadhper0",
"public_key": "pk_live_dZO3Bl6MqLn2VJYy18bjGkbPRCkubdgK"
}
}
'import requests
url = "https://api.usefoil.com/v1/gate/sessions"
payload = {
"service_id": "gsvc_0123456789abcdefghjkmnpqrs",
"account_name": "Acme Growth Workspace",
"delivery": {
"version": 1,
"algorithm": "x25519-hkdf-sha256/aes-256-gcm",
"key_id": "key_6cw04zdmetw8t5rsdppadhper0",
"public_key": "pk_live_dZO3Bl6MqLn2VJYy18bjGkbPRCkubdgK"
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
service_id: 'gsvc_0123456789abcdefghjkmnpqrs',
account_name: 'Acme Growth Workspace',
delivery: {
version: 1,
algorithm: 'x25519-hkdf-sha256/aes-256-gcm',
key_id: 'key_6cw04zdmetw8t5rsdppadhper0',
public_key: 'pk_live_dZO3Bl6MqLn2VJYy18bjGkbPRCkubdgK'
}
})
};
fetch('https://api.usefoil.com/v1/gate/sessions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.usefoil.com/v1/gate/sessions"
payload := strings.NewReader("{\n \"service_id\": \"gsvc_0123456789abcdefghjkmnpqrs\",\n \"account_name\": \"Acme Growth Workspace\",\n \"delivery\": {\n \"version\": 1,\n \"algorithm\": \"x25519-hkdf-sha256/aes-256-gcm\",\n \"key_id\": \"key_6cw04zdmetw8t5rsdppadhper0\",\n \"public_key\": \"pk_live_dZO3Bl6MqLn2VJYy18bjGkbPRCkubdgK\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}require 'uri'
require 'net/http'
url = URI("https://api.usefoil.com/v1/gate/sessions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"service_id\": \"gsvc_0123456789abcdefghjkmnpqrs\",\n \"account_name\": \"Acme Growth Workspace\",\n \"delivery\": {\n \"version\": 1,\n \"algorithm\": \"x25519-hkdf-sha256/aes-256-gcm\",\n \"key_id\": \"key_6cw04zdmetw8t5rsdppadhper0\",\n \"public_key\": \"pk_live_dZO3Bl6MqLn2VJYy18bjGkbPRCkubdgK\"\n }\n}"
response = http.request(request)
puts response.read_body<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.usefoil.com/v1/gate/sessions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'service_id' => 'gsvc_0123456789abcdefghjkmnpqrs',
'account_name' => 'Acme Growth Workspace',
'delivery' => [
'version' => 1,
'algorithm' => 'x25519-hkdf-sha256/aes-256-gcm',
'key_id' => 'key_6cw04zdmetw8t5rsdppadhper0',
'public_key' => 'pk_live_dZO3Bl6MqLn2VJYy18bjGkbPRCkubdgK'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"data": {
"object": "gate_session",
"id": "gate_0123456789abcdefghjkmnpqrs",
"status": "pending",
"poll_token": "gtpl_01hzy4k2s6m8n1p3q5r7t9v2wx",
"consent_url": "https://app.acme.co/signup",
"expires_at": "2026-03-24T20:00:05.000Z"
},
"meta": {
"request_id": "req_cf147349a4134208aebb8c70e25fb7e1"
}
}{
"error": {
"code": "request.validation_failed",
"message": "Observation payload failed validation.",
"status": 1,
"retryable": true,
"request_id": "req_cf147349a4134208aebb8c70e25fb7e1",
"docs_url": "https://app.acme.co/signup",
"details": {
"fields": [
{
"name": "Acme Growth Workspace",
"issue": "required",
"expected": "string",
"received": "any_of"
}
],
"allowed_values": [
"verified"
],
"header_name": "x-forwarded-for",
"parameter_set": "browser_fingerprint",
"next_action": "retry"
}
}
}{
"error": {
"code": "request.validation_failed",
"message": "Observation payload failed validation.",
"status": 1,
"retryable": true,
"request_id": "req_cf147349a4134208aebb8c70e25fb7e1",
"docs_url": "https://app.acme.co/signup",
"details": {
"fields": [
{
"name": "Acme Growth Workspace",
"issue": "required",
"expected": "string",
"received": "any_of"
}
],
"allowed_values": [
"verified"
],
"header_name": "x-forwarded-for",
"parameter_set": "browser_fingerprint",
"next_action": "retry"
}
}
}{
"error": {
"code": "request.validation_failed",
"message": "Observation payload failed validation.",
"status": 1,
"retryable": true,
"request_id": "req_cf147349a4134208aebb8c70e25fb7e1",
"docs_url": "https://app.acme.co/signup",
"details": {
"fields": [
{
"name": "Acme Growth Workspace",
"issue": "required",
"expected": "string",
"received": "any_of"
}
],
"allowed_values": [
"verified"
],
"header_name": "x-forwarded-for",
"parameter_set": "browser_fingerprint",
"next_action": "retry"
}
}
}Body
application/json
Canonical Gate service slug used by the public registry and by npx signup . Lowercase letters, numbers, dashes, and underscores only; must start and end with a letter or number.
Required string length:
3 - 32Pattern:
^[a-z0-9](?:[a-z0-9_-]{1,30}[a-z0-9])$Example:
"gsvc_0123456789abcdefghjkmnpqrs"
Example:
"Acme Growth Workspace"
Show child attributes
Show child attributes
Example:
{
"version": 1,
"algorithm": "x25519-hkdf-sha256/aes-256-gcm",
"key_id": "key_6cw04zdmetw8t5rsdppadhper0",
"public_key": "pk_live_dZO3Bl6MqLn2VJYy18bjGkbPRCkubdgK"
}
Example:
{ "source": "signup_form" }
Response
Gate session created.
Show child attributes
Show child attributes
Example:
{
"object": "gate_session",
"id": "gate_0123456789abcdefghjkmnpqrs",
"status": "pending",
"poll_token": "gtpl_01hzy4k2s6m8n1p3q5r7t9v2wx",
"consent_url": "https://app.acme.co/signup",
"expires_at": "2026-03-24T20:00:05.000Z"
}
Show child attributes
Show child attributes
Example:
{
"request_id": "req_cf147349a4134208aebb8c70e25fb7e1"
}
⌘I