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

# Create Verification

> Create a new verification request. Processing is performed synchronously.

The `data.type` field determines the verification type and must be one of:
- `verification/idv`: Identity document verification (requires a `document/idv` relationship)
- `verification/address`: Address document verification (requires a `document/address` relationship)
- `verification/business`: Business verification / KYB (requires a `business` relationship)

The `session` relationship is **optional**. When `meta.auto_update_session` is `true`, a session must be provided and will be updated with the extracted data upon a passing verification.

**Meta options:**
- `auto_update_session`: When `true` and the verification passes, the session is automatically updated with the extracted information. Requires a `session` relationship.



## OpenAPI

````yaml POST /v1/identity/verifications
openapi: 3.1.0
info:
  title: Beltic Identity API
  version: 1.0.0
  description: >-
    # Identity API


    The Beltic Identity API provides identity management capabilities including
    accounts, sessions, document verification, and identity verifications.


    ## Key Features


    - **Account Management**: Create and manage identity accounts

    - **Session Management**: Create and manage verification sessions with
    lifecycle controls

    - **Document Verification**: Submit and process identity documents
    (government IDs, proof of address)

    - **Identity Verification**: Run identity, address, and business
    verifications

    - **JSON:API Format**: All responses follow JSON:API specification


    ## Authentication


    All endpoints require authentication. Include your API key in the
    `X-Api-Key` header:

    ```

    X-Api-Key: YOUR_API_KEY

    ```


    ## Response Format


    All responses follow the JSON:API specification for consistent data
    structures.
  contact:
    name: Beltic API Support
    email: engineering@beltic.com
servers:
  - url: https://api.beltic.com
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Accounts
    description: Account management operations
  - name: Sessions
    description: Session management operations
  - name: Session Devices
    description: Session device management operations
  - name: Document Addresses
    description: Proof of address document management operations
  - name: Document IDVs
    description: Government ID verification document management operations
  - name: Verifications
    description: Base verification resource operations
externalDocs:
  description: Beltic Platform Documentation
  url: https://docs.beltic.com
paths:
  /v1/identity/verifications:
    post:
      tags:
        - Verifications
      summary: Create verification
      description: >-
        Create a new verification request. Processing is performed
        synchronously.


        The `data.type` field determines the verification type and must be one
        of:

        - `verification/idv`: Identity document verification (requires a
        `document/idv` relationship)

        - `verification/address`: Address document verification (requires a
        `document/address` relationship)

        - `verification/business`: Business verification / KYB (requires a
        `business` relationship)


        The `session` relationship is **optional**. When
        `meta.auto_update_session` is `true`, a session must be provided and
        will be updated with the extracted data upon a passing verification.


        **Meta options:**

        - `auto_update_session`: When `true` and the verification passes, the
        session is automatically updated with the extracted information.
        Requires a `session` relationship.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                data:
                  oneOf:
                    - type: object
                      properties:
                        type:
                          type: string
                          enum:
                            - verification/idv
                        relationships:
                          type: object
                          properties:
                            session:
                              type: object
                              properties:
                                data:
                                  type: object
                                  properties:
                                    type:
                                      type: string
                                      enum:
                                        - session
                                    id:
                                      type: string
                                      format: uuid
                                  required:
                                    - type
                                    - id
                              required:
                                - data
                              description: >-
                                Optional session relationship. Required when
                                meta.auto_update_session is true.
                            document:
                              type: object
                              properties:
                                data:
                                  type: object
                                  properties:
                                    type:
                                      type: string
                                      enum:
                                        - document/idv
                                    id:
                                      type: string
                                      format: uuid
                                  required:
                                    - type
                                    - id
                              required:
                                - data
                          required:
                            - document
                        meta:
                          type: object
                          properties:
                            auto_update_session:
                              type: boolean
                              default: false
                              description: >-
                                When true and the verification passes,
                                automatically update the session with extracted
                                information.
                              example: true
                      required:
                        - type
                        - relationships
                      title: verification/idv
                      example:
                        type: verification/idv
                        relationships:
                          session:
                            data:
                              type: session
                              id: 123e4567-e89b-12d3-a456-426614174000
                          document:
                            data:
                              type: document/idv
                              id: 223e4567-e89b-12d3-a456-426614174000
                        meta:
                          auto_update_session: true
                    - type: object
                      properties:
                        type:
                          type: string
                          enum:
                            - verification/address
                        relationships:
                          type: object
                          properties:
                            session:
                              type: object
                              properties:
                                data:
                                  type: object
                                  properties:
                                    type:
                                      type: string
                                      enum:
                                        - session
                                    id:
                                      type: string
                                      format: uuid
                                  required:
                                    - type
                                    - id
                              required:
                                - data
                              description: >-
                                Optional session relationship. Required when
                                meta.auto_update_session is true.
                            document:
                              type: object
                              properties:
                                data:
                                  type: object
                                  properties:
                                    type:
                                      type: string
                                      enum:
                                        - document/address
                                    id:
                                      type: string
                                      format: uuid
                                  required:
                                    - type
                                    - id
                              required:
                                - data
                          required:
                            - document
                        meta:
                          type: object
                          properties:
                            auto_update_session:
                              type: boolean
                              default: false
                              description: >-
                                When true and the verification passes,
                                automatically update the session with extracted
                                information.
                              example: true
                      required:
                        - type
                        - relationships
                      title: verification/address
                      example:
                        type: verification/address
                        relationships:
                          document:
                            data:
                              type: document/address
                              id: 323e4567-e89b-12d3-a456-426614174000
                        meta:
                          auto_update_session: false
                    - type: object
                      properties:
                        type:
                          type: string
                          enum:
                            - verification/business
                        relationships:
                          type: object
                          properties:
                            session:
                              type: object
                              properties:
                                data:
                                  type: object
                                  properties:
                                    type:
                                      type: string
                                      enum:
                                        - session
                                    id:
                                      type: string
                                      format: uuid
                                  required:
                                    - type
                                    - id
                              required:
                                - data
                              description: >-
                                Optional session relationship. Required when
                                meta.auto_update_session is true.
                            business:
                              type: object
                              properties:
                                data:
                                  type: object
                                  properties:
                                    type:
                                      type: string
                                      enum:
                                        - business
                                    id:
                                      type: string
                                      format: uuid
                                  required:
                                    - type
                                    - id
                              required:
                                - data
                          required:
                            - business
                        meta:
                          type: object
                          properties:
                            auto_update_session:
                              type: boolean
                              default: false
                              description: >-
                                When true and the verification passes,
                                automatically update the session with extracted
                                information.
                              example: true
                      required:
                        - type
                        - relationships
                      title: verification/business
                      example:
                        type: verification/business
                        relationships:
                          business:
                            data:
                              type: business
                              id: 423e4567-e89b-12d3-a456-426614174000
                        meta:
                          auto_update_session: false
              required:
                - data
      responses:
        '201':
          description: Verification created and processed successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      type:
                        type: string
                      attributes:
                        type: object
                        additionalProperties: {}
                      relationships:
                        type: object
                        additionalProperties: {}
                      meta:
                        type: object
                        additionalProperties: {}
                    required:
                      - id
                      - type
                      - attributes
                required:
                  - data
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        status:
                          type: string
                        title:
                          type: string
                        detail:
                          type: string
                        code:
                          type: string
                      required:
                        - status
                        - title
                required:
                  - errors
        '404':
          description: Related resource not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        status:
                          type: string
                        title:
                          type: string
                        detail:
                          type: string
                        code:
                          type: string
                      required:
                        - status
                        - title
                required:
                  - errors
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        status:
                          type: string
                        title:
                          type: string
                        detail:
                          type: string
                        code:
                          type: string
                      required:
                        - status
                        - title
                required:
                  - errors
      security:
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
      description: |-
        API key for authentication.
        Access https://console.beltic.com/ to obtain your API key.

````