> ## 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 verification request

> Creates a verification request with deep link, web URL, and QR code. Requires an anchor grant token from create-session.



## OpenAPI

````yaml /openapi-sdk-a.json post /sdk/create-verification-link
openapi: 3.1.0
info:
  title: BotShield SDK A API
  version: 2.0.0
  description: >-
    BotShield SDK A -- Signal-only human presence verification. Momentary
    presence check with no persistence.
  contact:
    name: BotShield Support
    email: support@botshield.ai
    url: https://botshield.ai
servers:
  - url: https://api.botshield.ai/operations
    description: BotShield API
security: []
tags:
  - name: SDK
    description: >-
      Core SDK operations — session management, verification, token validation,
      and Signal Pixel scoring
  - name: Signal Pixel
    description: >-
      BotShield Signal Pixel — passive behavioral fingerprinting with
      tamper-proof server-side scoring
  - name: Verification
    description: Verification status checking and user lookup
paths:
  /sdk/create-verification-link:
    post:
      tags:
        - SDK
      summary: Create a verification request
      description: >-
        Creates a verification request with deep link, web URL, and QR code.
        Requires an anchor grant token from create-session.
      operationId: SdkCreateVerificationLink
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                return_url:
                  type: string
                  format: uri
                webhook_url:
                  type: string
                  format: uri
                scope:
                  type: string
                sdk_type:
                  type: string
                  enum:
                    - signal
                    - presence
                mode:
                  type: string
                  enum:
                    - linked-account
                    - private
                  default: linked-account
                  description: >-
                    linked-account = OAuth+passkey, private = direct WebAuthn
                    (no PII)
                signal_token:
                  type: string
                  description: >-
                    Tamper-proof Signal Pixel token (bs_sig_...) for server-side
                    score correlation
                metadata:
                  type: object
                  additionalProperties: true
      responses:
        '200':
          description: Verification link created
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    type: object
                    required:
                      - request_id
                      - deep_link
                      - web_url
                      - qr_code_url
                      - expires_at
                    properties:
                      request_id:
                        type: string
                      deep_link:
                        type: string
                      web_url:
                        type: string
                      qr_code_url:
                        type: string
                      expires_at:
                        type: string
                        format: date-time
                      sdk_type:
                        type: string
                        enum:
                          - signal
                          - presence
                      scope:
                        type: string
                      organization:
                        type: object
                        properties:
                          id:
                            type: string
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '409':
          description: Duplicate pending verification
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - ApiKeyAuth: []
components:
  responses:
    BadRequest:
      description: Invalid input
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/InvalidInputError'
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - message
            - statusCode
          properties:
            message:
              type: string
            statusCode:
              type: integer
    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
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        API key with Bearer prefix (e.g., 'Bearer bs_live_sk_...' or 'Bearer
        pk_live_...')

````