> ## Documentation Index > Fetch the complete documentation index at: https://usefoil.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Create a Gate signup session ## OpenAPI ````yaml /api-reference/openapi.json post /v1/gate/sessions openapi: 3.1.0 info: title: Foil API version: '2026-03-25' description: >- Customer-facing Foil server APIs for sessions, visitor fingerprints, organizations, and API keys. servers: - url: https://api.usefoil.com description: Production security: [] tags: - name: Sessions description: Durable session readback endpoints. - name: Visitor fingerprints description: Durable visitor fingerprint readback endpoints. - name: Organizations description: Organization lifecycle endpoints. - name: API Keys description: Organization API key lifecycle endpoints. - name: Gate description: >- Registry, organization-owned services, signup sessions, agent tokens, and dashboard login sessions. - name: Gate Webhooks description: Outbound Gate webhook delivery contracts. - name: Webhooks description: Manage webhook endpoints, subscriptions, and outgoing event delivery. - name: Events description: Inspect organization events and their webhook delivery attempts. paths: /v1/gate/sessions: post: tags: - Gate summary: Create a Gate signup session operationId: createGateSession requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateGateSessionRequest' example: service_id: gsvc_0123456789abcdefghjkmnpqrs account_name: Acme Growth Workspace metadata: source: signup_form delivery: version: 1 algorithm: x25519-hkdf-sha256/aes-256-gcm key_id: key_6cw04zdmetw8t5rsdppadhper0 public_key: pk_live_dZO3Bl6MqLn2VJYy18bjGkbPRCkubdgK responses: '201': description: Gate session created. content: application/json: schema: $ref: '#/components/schemas/GateSessionCreateResponse' example: 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 '404': description: Service not found. content: application/json: schema: $ref: '#/components/schemas/ApiErrorEnvelope' example: 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 '422': description: Validation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorEnvelope' example: 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 '429': description: Rate limited. content: application/json: schema: $ref: '#/components/schemas/ApiErrorEnvelope' example: 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 components: schemas: CreateGateSessionRequest: type: object required: - service_id - account_name - delivery properties: service_id: $ref: '#/components/schemas/GateServiceId' example: gsvc_0123456789abcdefghjkmnpqrs account_name: type: string example: Acme Growth Workspace metadata: type: object additionalProperties: true example: source: signup_form delivery: $ref: '#/components/schemas/GateDeliveryRequest' example: version: 1 algorithm: x25519-hkdf-sha256/aes-256-gcm key_id: key_6cw04zdmetw8t5rsdppadhper0 public_key: pk_live_dZO3Bl6MqLn2VJYy18bjGkbPRCkubdgK example: service_id: gsvc_0123456789abcdefghjkmnpqrs account_name: Acme Growth Workspace metadata: source: signup_form delivery: version: 1 algorithm: x25519-hkdf-sha256/aes-256-gcm key_id: key_6cw04zdmetw8t5rsdppadhper0 public_key: pk_live_dZO3Bl6MqLn2VJYy18bjGkbPRCkubdgK GateSessionCreateResponse: type: object required: - data - meta properties: data: $ref: '#/components/schemas/GateSessionCreate' 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' meta: $ref: '#/components/schemas/ResponseMeta' example: request_id: req_cf147349a4134208aebb8c70e25fb7e1 example: 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 ApiErrorEnvelope: type: object additionalProperties: false required: - error properties: error: $ref: '#/components/schemas/PublicError' example: 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 example: 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 GateServiceId: type: string example: gsvc_0123456789abcdefghjkmnpqrs minLength: 3 maxLength: 32 pattern: ^[a-z0-9](?:[a-z0-9_-]{1,30}[a-z0-9])$ description: >- 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. GateDeliveryRequest: type: object required: - version - algorithm - key_id - public_key properties: version: type: integer const: 1 example: 1 algorithm: type: string const: x25519-hkdf-sha256/aes-256-gcm example: x25519-hkdf-sha256/aes-256-gcm key_id: type: string example: key_6cw04zdmetw8t5rsdppadhper0 public_key: type: string example: pk_live_dZO3Bl6MqLn2VJYy18bjGkbPRCkubdgK example: version: 1 algorithm: x25519-hkdf-sha256/aes-256-gcm key_id: key_6cw04zdmetw8t5rsdppadhper0 public_key: pk_live_dZO3Bl6MqLn2VJYy18bjGkbPRCkubdgK GateSessionCreate: type: object required: - object - id - status - poll_token - consent_url - expires_at properties: object: type: string const: gate_session example: gate_session id: $ref: '#/components/schemas/GateSessionId' example: gate_0123456789abcdefghjkmnpqrs status: type: string enum: - pending example: pending poll_token: $ref: '#/components/schemas/GatePollToken' example: gtpl_01hzy4k2s6m8n1p3q5r7t9v2wx consent_url: type: string format: uri example: https://app.acme.co/signup expires_at: type: string format: date-time example: '2026-03-24T20:00:05.000Z' 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' ResponseMeta: type: object additionalProperties: false required: - request_id properties: request_id: $ref: '#/components/schemas/RequestId' example: req_cf147349a4134208aebb8c70e25fb7e1 example: request_id: req_cf147349a4134208aebb8c70e25fb7e1 PublicError: type: object additionalProperties: false required: - code - message - status - retryable - request_id properties: code: type: string x-foil-known-values-ref: '#/components/schemas/KnownPublicErrorCode' example: request.validation_failed message: type: string example: Observation payload failed validation. status: type: integer example: 1 retryable: type: boolean example: true request_id: $ref: '#/components/schemas/RequestId' example: req_cf147349a4134208aebb8c70e25fb7e1 docs_url: type: string format: uri example: https://app.acme.co/signup details: $ref: '#/components/schemas/ApiErrorDetails' example: 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 example: 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 GateSessionId: type: string example: gate_0123456789abcdefghjkmnpqrs GatePollToken: type: string example: gtpl_01hzy4k2s6m8n1p3q5r7t9v2wx RequestId: type: string pattern: ^req_[0-9a-f]{32}$ example: req_cf147349a4134208aebb8c70e25fb7e1 ApiErrorDetails: type: object properties: fields: type: array items: $ref: '#/components/schemas/ApiFieldIssue' example: name: Acme Growth Workspace issue: required expected: string received: any_of example: - name: Acme Growth Workspace issue: required expected: string received: any_of allowed_values: type: array items: type: string example: verified example: - verified header_name: type: string example: x-forwarded-for parameter_set: type: string example: browser_fingerprint next_action: type: string enum: - retry - new_session - reload_bundle - contact_support example: retry additionalProperties: true example: 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 ApiFieldIssue: type: object additionalProperties: false required: - name - issue properties: name: type: string example: Acme Growth Workspace issue: type: string example: required expected: type: string example: string received: anyOf: - type: string example: '0' - type: number example: 1.5 - type: boolean example: true - type: 'null' example: null example: any_of example: name: Acme Growth Workspace issue: required expected: string received: any_of ````