> ## 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.

# Get verification status

> Poll a verification request. Carries the signed attestation on completion and NO identity — no user_email, partner_user_id, auth_mode, or botshield_user_id ever cross this boundary.



## OpenAPI

````yaml /openapi.json get /verification/status
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:
  /verification/status:
    get:
      tags:
        - BotShield Gate
      summary: Get verification status
      description: >-
        Poll a verification request. Carries the signed attestation on
        completion and NO identity — no user_email, partner_user_id, auth_mode,
        or botshield_user_id ever cross this boundary.
      operationId: VerificationGetStatus
      parameters:
        - name: request_id
          in: query
          required: true
          schema:
            type: string
      responses:
        '200':
          description: >-
            Verification status. NOTE: handler errors also arrive here (HTTP
            200) as data.error — codes for this operation: none — unknown ids
            return status not_found.
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    type: object
                    properties:
                      found:
                        type: boolean
                      status:
                        type: string
                        enum:
                          - pending
                          - completed
                          - pass
                          - expired
                          - failed
                          - not_found
                          - error
                        description: >-
                          `completed`: the person confirmed in the BotShield
                          app. `pass`: a returning human passed a Recent
                          Presence gate without a new confirmation; this record
                          expires 60 seconds after the check, so read it
                          promptly. Treat `completed` and `pass` as success.
                          `expired`: the request timed out. `failed`: the person
                          declined or the check could not complete.
                      request_id:
                        type: string
                      organization_id:
                        type: string
                      created_at:
                        type: string
                        format: date-time
                      expires_at:
                        type: string
                        format: date-time
                      verified_at:
                        type: string
                        format: date-time
                        nullable: true
                      signed_token:
                        type: string
                        nullable: true
                      verification_token:
                        type: string
                        description: Legacy alias
                        nullable: true
                      error_message:
                        type: string
                        nullable: true
                      sdk_type:
                        type: string
                        enum:
                          - signal
                          - presence
                        nullable: true
                      scope:
                        type: string
                        nullable: true
                      presence_address:
                        type: string
                        nullable: true
                        description: Only for sdk_type=presence; null on every other lane.
                      metadata:
                        type: object
                        nullable: true
                        properties:
                          scope:
                            type: string
                            nullable: true
                            description: The gate.
                          sdk_type:
                            type: string
                            nullable: true
                          environment:
                            type: string
                            nullable: true
                          return_url:
                            type: string
                            nullable: true
                          parent_request_id:
                            type: string
                            nullable: true
                      message:
                        type: string
                        description: Present on not_found / error.
                      error:
                        $ref: '#/components/schemas/ErrorBody'
                      gate_type:
                        type: string
                        enum:
                          - human
                          - age
                        description: The type of gate this request ran against.
                      age_threshold:
                        type:
                          - integer
                          - 'null'
                        enum:
                          - 13
                          - 18
                          - 21
                          - null
                        description: >-
                          Age Gate (Beta): the threshold the gate asks about.
                          Present on age gates only.
                      age_verdict:
                        type:
                          - string
                          - 'null'
                        enum:
                          - over_13
                          - over_18
                          - over_21
                          - unavailable
                          - null
                        description: >-
                          Age Gate (Beta): positive-only result. `unavailable`
                          means no qualifying age signal; it never means
                          "under".
                      age_source:
                        type:
                          - string
                          - 'null'
                        enum:
                          - apple_declared_age_range
                          - play_age_signals
                          - null
                        description: >-
                          Age Gate (Beta): the phone platform signal the result
                          was composed from.
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/InternalError'
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'

````