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

# Extract document data

> Extracts data from an identity document using OCR without 
performing face matching or liveness checks.

Useful for pre-filling forms or document validation.




## OpenAPI

````yaml openapi/identity.yaml post /identity/extract
openapi: 3.0.3
info:
  title: TXCloud Identity API
  version: 1.0.0
  description: >
    The TXCloud Identity API enables identity verification through document
    OCR, 

    face matching, liveness detection, and fraud checks.


    ## Base URL

    ```

    https://api.txcloud.io/v1

    ```


    ## Authentication

    All requests require a Bearer token in the Authorization header:

    ```

    Authorization: Bearer txc_live_your_api_key

    ```


    ## Rate Limits

    | Plan | Requests/min |

    |------|--------------|

    | Starter | 60 |

    | Growth | 300 |

    | Scale | 1,000 |

    | Enterprise | Custom |
  termsOfService: https://txcloud.io/terms
  contact:
    name: TXCloud API Support
    email: support@txcloud.io
    url: https://docs.txcloud.io
  license:
    name: Proprietary
    url: https://txcloud.io/license
  x-logo:
    url: https://txcloud.io/logo.png
servers:
  - url: https://api.txcloud.io/v1
    description: Production
  - url: https://sandbox.api.txcloud.io/v1
    description: Sandbox (test environment)
security:
  - BearerAuth: []
tags:
  - name: Verification
    description: Core identity verification endpoints
  - name: Management
    description: Manage and retrieve verifications
  - name: Sessions
    description: Multi-step verification sessions
  - name: Documents
    description: Document management
  - name: Configuration
    description: Supported documents and countries
paths:
  /identity/extract:
    post:
      tags:
        - Verification
      summary: Extract document data
      description: |
        Extracts data from an identity document using OCR without 
        performing face matching or liveness checks.

        Useful for pre-filling forms or document validation.
      operationId: extractDocument
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExtractRequest'
      responses:
        '200':
          description: Extraction successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtractResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
components:
  schemas:
    ExtractRequest:
      type: object
      required:
        - document_front
        - document_type
        - country
      properties:
        document_front:
          type: string
          format: byte
        document_back:
          type: string
          format: byte
        document_type:
          type: string
        country:
          type: string
    ExtractResponse:
      type: object
      properties:
        id:
          type: string
        object:
          type: string
          enum:
            - identity.extraction
        extracted_data:
          $ref: '#/components/schemas/ExtractedData'
        field_confidences:
          type: object
        quality_score:
          type: number
    ExtractedData:
      type: object
      properties:
        document_number:
          type: string
          example: AE123456
        first_name:
          type: string
          example: Mohammed
        last_name:
          type: string
          example: El Amrani
        first_name_arabic:
          type: string
        last_name_arabic:
          type: string
        date_of_birth:
          type: string
          format: date
        gender:
          type: string
          enum:
            - M
            - F
        nationality:
          type: string
        issue_date:
          type: string
          format: date
        expiry_date:
          type: string
          format: date
        address:
          type: string
        place_of_birth:
          type: string
        mrz:
          type: string
        field_confidences:
          type: object
          additionalProperties:
            type: number
  responses:
    BadRequest:
      description: Bad Request
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  code:
                    type: string
                  message:
                    type: string
                  type:
                    type: string
    UnprocessableEntity:
      description: Unprocessable Entity
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: API key as Bearer token

````