> ## Documentation Index
> Fetch the complete documentation index at: https://docs.botshield.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a grant token

> Creates a short-lived grant token (5 minutes) from an API token or site key. Use this to get a token before creating verification links.



## OpenAPI

````yaml /openapi.json post /sdk/create-session
openapi: 3.1.0
info:
  title: BotShield API
  version: 2.0.0
  description: >-
    The BotShield partner API.


    **BotShield Gate** — ask whether a live human is present (Human Gate) or
    over an age threshold (Age Gate). The person confirms with their device
    biometric in the BotShield app and you receive a signed result. Partners
    learn *that* a user is human, never *who*.


    **Agents Ask** — your agent proposes an action, a verified human confirms or
    denies it, and BotShield signs a Proof of Resolution you can verify offline.


    Every operation answers HTTP 200 with a `data` envelope; handler errors
    arrive as `data.error`. See the API overview and error reference. In the
    `botshield-sdk` package these operations live under `client.census.*`,
    `client.verification.*` and `client.actions.*`.
  contact:
    name: BotShield Support
    email: support@botshield.ai
    url: https://botshield.ai
servers:
  - url: https://api.botshield.ai/operations
    description: Production
security: []
tags:
  - name: BotShield Gate
    description: >-
      Place a gate and learn whether a present human (Human Gate) or a human
      over an age threshold (Age Gate) confirmed.
  - name: Agents Ask
    description: >-
      Your agent proposes an action; a verified human confirms or denies it in
      the BotShield app; you receive a signed Proof of Resolution.
paths:
  /sdk/create-session:
    post:
      tags:
        - BotShield Gate
      summary: Create a grant token
      description: >-
        Creates a short-lived grant token (5 minutes) from an API token or site
        key. Use this to get a token before creating verification links.
      operationId: SdkCreateSession
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                partner_user_id:
                  type: string
                  description: Your internal user identifier for correlation
                metadata:
                  type: object
                  additionalProperties: true
      responses:
        '200':
          description: >-
            grant token created. NOTE: handler errors also arrive here (HTTP
            200) as data.error — codes for this operation: 401 (bad or missing
            credential), 403 (origin not allowed for the site key).
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    type: object
                    properties:
                      data:
                        type: object
                        required:
                          - anchor_grant_token
                          - anchor_grant_expires_at
                          - anchor_grant_expires_in_seconds
                          - session_token
                          - expires_at
                          - expires_in_seconds
                          - organization
                        properties:
                          anchor_grant_token:
                            type: string
                            description: Canonical grant token (Bearer bss_*)
                          anchor_grant_expires_at:
                            type: string
                            format: date-time
                          anchor_grant_expires_in_seconds:
                            type: integer
                          session_token:
                            type: string
                            description: Legacy alias (backward compatibility)
                          expires_at:
                            type: string
                            format: date-time
                          expires_in_seconds:
                            type: integer
                          organization:
                            type: object
                            required:
                              - id
                              - environment
                            properties:
                              id:
                                type: string
                              environment:
                                type: string
                                enum:
                                  - development
                                  - production
                                description: >-
                                  Resolved from the credential: API token
                                  environment, or site key pk_test_ →
                                  development / pk_live_ → production.
                      error:
                        $ref: '#/components/schemas/ErrorBody'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    ErrorBody:
      type: object
      required:
        - message
        - statusCode
      description: >-
        Handler error. Arrives inside data.error with HTTP 200 — check for it
        before reading the result.
      properties:
        message:
          type: string
        statusCode:
          type: integer
          description: >-
            The HTTP status the error stands for (401, 403, 404, 409, 422, 500,
            502).
        code:
          type: string
          description: Machine code when present, e.g. ttl_below_floor, ttl_above_ceiling.
        min_ttl_seconds:
          type: integer
        max_ttl_seconds:
          type: integer
        violations:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
              path:
                type: string
              severity:
                type: string
          description: Adaptive Card TRUST-layer rejections (statusCode 422).
    InvalidInputError:
      type: object
      required:
        - message
        - input
        - errors
      properties:
        message:
          type: string
          example: Invalid input provided
        input:
          type: object
          additionalProperties: true
        errors:
          type: array
          items:
            type: object
            required:
              - propertyPath
              - invalidValue
              - message
            properties:
              propertyPath:
                type: string
              invalidValue:
                description: The invalid value
              message:
                type: string
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - message
            - statusCode
          properties:
            message:
              type: string
            statusCode:
              type: integer
  responses:
    BadRequest:
      description: Invalid input
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/InvalidInputError'
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: >-
        Your secret API key (`bs_dev_…` for development, `bs_production_…` for
        production), or a site key (`pk_test_…` / `pk_live_…`) when calling from
        an allowed origin. Create keys in the Console under Settings → Developer
        Tools.

````