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

# Global ID Recognition API

> Process and verify identification documents by analyzing both front and back images, along with the issuing country and ID type

La API de Global ID Recognition procesa y verifica documentos de identificación analizando tanto las imágenes del frente como del reverso de la identificación, junto con el país emisor y el tipo de identificación. Esta API garantiza la autenticidad y validez de la identificación proporcionada a través de OCR detallado (Reconocimiento Óptico de Caracteres) y proporciona resultados integrales.

## Descripción General de la API

La API de Global ID Recognition proporciona una herramienta potente para el procesamiento de documentos de identificación a nivel mundial con las siguientes capacidades:

* **Soporte Mundial**: Procese documentos de identificación de múltiples países
* **Reconocimiento Automático**: Detecte automáticamente el tipo de identificación y el país emisor
* **Tecnología OCR**: Reconocimiento óptico de caracteres avanzado para extracción de texto
* **Extracción de Datos**: Extraiga datos estructurados de documentos de identificación
* **Verificación**: Verifique la autenticidad y validez del documento
* **Soporte Multi-Formato**: Maneje varios formatos de documentos de identificación

## Parámetros de Solicitud

### Parámetros Requeridos

* **idImage**: Imagen del lado frontal del documento de identificación en formato base64
* **issuingCountry**: El Código de País ISO 3 Alpha del país emisor del documento de identificación
* **idType**: El tipo del documento de identificación

### Parámetros Opcionales

* **idBackImage**: Imagen del lado posterior del documento de identificación en formato base64
* **callbackUrl**: La URL donde se enviarán los resultados del reconocimiento al completarse

### Autenticación

* **x-api-key**: Clave API esencial para fines de autenticación y control de acceso

## Formato de Respuesta

La API devuelve resultados detallados de reconocimiento que incluyen:

* **apiType**: Identificador del tipo de API
* **transactionId**: Identificador único para cada solicitud
* **result**: Objeto que contiene el resultado del procesamiento
  * **documentInfo**: Información extraída del documento
  * **personalInfo**: Información personal extraída
  * **verificationStatus**: Estado de verificación del documento
  * **data**: Objeto que contiene los datos extraídos
    * **raw**: Datos OCR sin procesar e información de coordenadas
      * Cada campo (address, name, number, authority, etc.) puede incluir:
        * **value**: Valor del campo extraído (string)
        * **score**: Puntuación de confianza del reconocimiento (number)
        * **accepted**: Estado de aceptación del campo (boolean, presente solo para algunos campos)
        * **coordinates**: Información de coordenadas relativa a la imagen procesada (object)
          * **first**, **second**, **third**, **fourth**: Cuatro puntos de coordenadas de esquina (x, y) del rectángulo
        * **original\_coordinates**: Información de coordenadas relativa a la imagen original cuando se tomó la foto de la identificación (object, opcional)
          * **first**, **second**, **third**, **fourth**: Cuatro puntos de coordenadas de esquina (x, y) relativos a la imagen original
          * Se proporcionan adicionalmente para campos cuando existe información de coordenadas originales en el lado posterior
    * **ocr**: Datos OCR estructurados definidos por Argos

## Países y Tipos de Identificación Soportados

### Países Principales

* **USA**: Estados Unidos
* **CAN**: Canadá
* **MEX**: México
* **BRA**: Brasil
* **ARG**: Argentina
* **GBR**: Reino Unido
* **DEU**: Alemania
* **FRA**: Francia
* **ESP**: España
* **ITA**: Italia
* **KOR**: Corea del Sur
* **JPN**: Japón
* **CHN**: China
* **AUS**: Australia
* **NZL**: Nueva Zelanda

Consulte la **lista de todos los países soportados** en [Glosario/Códigos de País ISO Alpha 3](/es/verify/glossary/iso_alpha_3_country_codes)

### Tipos de Identificación

* **government\_id**: Un documento de identificación oficial emitido por un gobierno, típicamente utilizado para verificar la identidad de una persona
* **passport**: Un documento de viaje oficial emitido por un gobierno, que certifica la identidad y nacionalidad del titular, utilizado principalmente para viajes internacionales
* **drivers\_license**: Un documento oficial que permite a una persona específica operar uno o más tipos de vehículos motorizados, como motocicletas, automóviles, camiones o autobuses
* **residence\_permit**: Un documento oficial que permite a una persona extranjera residir en un país durante un período determinado, típicamente emitido por la autoridad de inmigración
* **vehicle\_registration\_certificate**: Un documento oficial que proporciona prueba de registro de un vehículo, incluyendo detalles sobre el vehículo y el propietario
* **visa**: Un respaldo oficial colocado en un pasaporte que indica que el titular puede entrar, salir o permanecer durante un período específico en un país
* **aadhaar**: Un número de identificación único de 12 dígitos emitido por el gobierno indio a los residentes de India, basado en sus datos biométricos y demográficos
* **pancard**: Una tarjeta de número de cuenta permanente (PAN) emitida por el gobierno indio a personas y entidades, utilizada principalmente para fines fiscales

Consulte la **lista de todos los tipos de identificación soportados para cada país** en [Glosario/Tipos de Identificación Soportados](/es/verify/glossary/supported_id_types)

## Casos de Uso

* **Procesos KYC**: Optimice la verificación de identidad del cliente
* **Banca**: Verifique la identidad del cliente para apertura de cuentas
* **Viajes**: Procese documentos de viaje y visas
* **Empleo**: Verifique la identidad del empleado y permisos de trabajo
* **Servicios Gubernamentales**: Procese documentos de identificación oficiales

## Modos de Procesamiento

### Procesamiento Síncrono

* Respuesta inmediata con resultados de reconocimiento
* Mejor para aplicaciones en tiempo real
* Respuesta directa de la API

### Procesamiento Asíncrono

* Use URL de callback para resultados diferidos
* Mejor para procesamiento por lotes
* Formato detallado de respuesta de callback

## Requisitos de Imagen

### Tamaño de Archivo

* **Recomendado**: Menos de 10MB
* **Máximo**: 50MB

### Calidad de Imagen

* **Resolución**: Se recomienda un mínimo de 300 DPI
* **Formato**: Las imágenes de alto contraste y bien iluminadas funcionan mejor
* **Orientación**: El documento debe estar correctamente orientado

### Formatos Soportados

* **JPEG** (.jpg, .jpeg)
* **PNG** (.png)

## Manejo de Errores

El código de estado **400** indica que la solicitud fue inaceptable, a menudo debido a la falta de un parámetro requerido. En operaciones asíncronas, donde se proporciona callbackUrl, el error se detecta durante la validación de la solicitud.

### Tipo de errorCode

La siguiente tabla muestra los errorCodes específicos devueltos por la API:

| Status Code | errorCode | Description                         | Detailed                                                       |
| ----------- | --------- | ----------------------------------- | -------------------------------------------------------------- |
| 400         | 1001      | Workspace is unavailable            | workspace is not currently operating                           |
| 400         | 1003      | Fail to process data                | Server had problem in processing data please retry             |
| 400         | 1005      | idImage is required                 | idImage is not entered                                         |
| 400         | 1006      | issuingCountry is required          | issuingCountry is missing                                      |
| 400         | 1010      | callbackUrl is required             | callbackUrl is missing                                         |
| 400         | 1011      | Fail to recognize idCard            | the idCard's image is different from issuingCountry and idType |
| 400         | 1012      | Fail to recognize back of an idCard | the idCard's image is different from issuingCountry and idType |
| 400         | 1013      | Invalid image format                | the image is not in Base64 format                              |
| 400         | 1014      | idType is required                  | idType is missing                                              |
| 400         | 1015      | invalid inputs : missing fields     | field is missing                                               |


## OpenAPI

````yaml POST /recognition
openapi: 3.1.0
info:
  title: Global ID Recognition API
  description: >-
    API for processing and verifying identification documents worldwide using
    OCR technology
  version: 1.0.0
servers:
  - url: https://idverify-api.argosidentity.com/modules
    description: Production server
security:
  - apiKeyAuth: []
paths:
  /recognition:
    post:
      tags:
        - Global ID Recognition
      summary: Recognize and verify ID document
      description: >-
        Process and verify identification documents by analyzing both front and
        back images, along with the issuing country and ID type
      operationId: recognizeIdDocument
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - idImage
                - issuingCountry
                - idType
              properties:
                idImage:
                  type: string
                  description: >-
                    Image of the front side of the ID document in base64 format.
                    Base64 encoded characters in the payload must not include
                    the MIME type. For example, if the encoded base64 characters
                    are "image/png;base64,/9j/2wBDABQODxIP...", then remove
                    "image/png;base64," and send only the encoded data
                    "/9j/2wBDABQODxIP...".
                  example: >-
                    iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAAAABJRU5ErkJggg==
                idBackImage:
                  type: string
                  description: Image of the back side of the ID document in base64 format.
                  example: >-
                    iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAAAABJRU5ErkJggg==
                issuingCountry:
                  type: string
                  description: >-
                    The ISO 3 Alpha Country Code of the issuing country for the
                    ID document.
                  example: USA
                idType:
                  type: string
                  description: The type of the ID document
                  enum:
                    - government_id
                    - passport
                    - drivers_license
                    - residence_permit
                    - vehicle_registration_certificate
                    - visa
                    - aadhaar
                    - pancard
                  example: government_id
                callbackUrl:
                  type: string
                  description: >-
                    The URL where the recognition results will be sent upon
                    completion. If a callbackUrl is provided, the process works
                    asynchronously. If no callbackUrl is provided, the process
                    operates synchronously.
                  format: uri
                  example: https://your-domain.com/callback
      responses:
        '200':
          description: Successful ID recognition
          content:
            application/json:
              schema:
                type: object
                properties:
                  apiType:
                    type: string
                    description: API type identifier
                    example: id_recognition
                  transactionId:
                    type: string
                    description: Unique identifier for each request
                    example: txn_123456789
                  result:
                    type: object
                    description: Object containing the processing result
                    properties:
                      data:
                        type: object
                        description: Extracted data from document
                        properties:
                          raw:
                            type: object
                            description: Raw extracted data with coordinates and scores
                            properties:
                              address:
                                type: object
                                properties:
                                  value:
                                    type: string
                                    example: '{{value}}'
                                  score:
                                    type: number
                                    example: 34
                                  coordinates:
                                    type: object
                                    properties:
                                      first:
                                        type: object
                                        properties:
                                          x:
                                            type: number
                                            example: 410
                                          'y':
                                            type: number
                                            example: 1237
                                      second:
                                        type: object
                                        properties:
                                          x:
                                            type: number
                                            example: 560
                                          'y':
                                            type: number
                                            example: 1237
                                      third:
                                        type: object
                                        properties:
                                          x:
                                            type: number
                                            example: 564
                                          'y':
                                            type: number
                                            example: 1362
                                      fourth:
                                        type: object
                                        properties:
                                          x:
                                            type: number
                                            example: 415
                                          'y':
                                            type: number
                                            example: 1362
                                  original_coordinates:
                                    type: object
                                    description: >-
                                      Original image coordinates for the field
                                      (optional)
                                    properties:
                                      first:
                                        type: object
                                        properties:
                                          x:
                                            type: number
                                            example: 211
                                          'y':
                                            type: number
                                            example: 714
                                      second:
                                        type: object
                                        properties:
                                          x:
                                            type: number
                                            example: 553
                                          'y':
                                            type: number
                                            example: 713
                                      third:
                                        type: object
                                        properties:
                                          x:
                                            type: number
                                            example: 554
                                          'y':
                                            type: number
                                            example: 751
                                      fourth:
                                        type: object
                                        properties:
                                          x:
                                            type: number
                                            example: 213
                                          'y':
                                            type: number
                                            example: 752
                              authority:
                                type: object
                                properties:
                                  value:
                                    type: string
                                    example: '{{value}}'
                                  score:
                                    type: number
                                    example: 4
                                  coordinates:
                                    type: object
                                    properties:
                                      first:
                                        type: object
                                        properties:
                                          x:
                                            type: number
                                            example: 796
                                          'y':
                                            type: number
                                            example: 1460
                                      second:
                                        type: object
                                        properties:
                                          x:
                                            type: number
                                            example: 1931
                                          'y':
                                            type: number
                                            example: 1461
                                      third:
                                        type: object
                                        properties:
                                          x:
                                            type: number
                                            example: 1925
                                          'y':
                                            type: number
                                            example: 1641
                                      fourth:
                                        type: object
                                        properties:
                                          x:
                                            type: number
                                            example: 799
                                          'y':
                                            type: number
                                            example: 1637
                              name:
                                type: object
                                properties:
                                  value:
                                    type: string
                                    example: '{{value}}'
                                  score:
                                    type: number
                                    example: 61
                                  coordinates:
                                    type: object
                                    properties:
                                      first:
                                        type: object
                                        properties:
                                          x:
                                            type: number
                                            example: 367
                                          'y':
                                            type: number
                                            example: 462
                                      second:
                                        type: object
                                        properties:
                                          x:
                                            type: number
                                            example: 1379
                                          'y':
                                            type: number
                                            example: 454
                                      third:
                                        type: object
                                        properties:
                                          x:
                                            type: number
                                            example: 1378
                                          'y':
                                            type: number
                                            example: 663
                                      fourth:
                                        type: object
                                        properties:
                                          x:
                                            type: number
                                            example: 375
                                          'y':
                                            type: number
                                            example: 669
                              name_chn:
                                type: object
                                properties:
                                  value:
                                    type: string
                                    example: '{{value}}'
                                  score:
                                    type: number
                                    example: 61
                                  coordinates:
                                    type: object
                                    properties:
                                      first:
                                        type: object
                                        properties:
                                          x:
                                            type: number
                                            example: 367
                                          'y':
                                            type: number
                                            example: 462
                                      second:
                                        type: object
                                        properties:
                                          x:
                                            type: number
                                            example: 1379
                                          'y':
                                            type: number
                                            example: 454
                                      third:
                                        type: object
                                        properties:
                                          x:
                                            type: number
                                            example: 1378
                                          'y':
                                            type: number
                                            example: 663
                                      fourth:
                                        type: object
                                        properties:
                                          x:
                                            type: number
                                            example: 375
                                          'y':
                                            type: number
                                            example: 669
                              number:
                                type: object
                                properties:
                                  value:
                                    type: string
                                    example: '{{value}}'
                                  score:
                                    type: number
                                    example: 95
                                  accepted:
                                    type: boolean
                                    example: true
                                  coordinates:
                                    type: object
                                    properties:
                                      first:
                                        type: object
                                        properties:
                                          x:
                                            type: number
                                            example: 248
                                          'y':
                                            type: number
                                            example: 698
                                      second:
                                        type: object
                                        properties:
                                          x:
                                            type: number
                                            example: 1423
                                          'y':
                                            type: number
                                            example: 691
                                      third:
                                        type: object
                                        properties:
                                          x:
                                            type: number
                                            example: 1421
                                          'y':
                                            type: number
                                            example: 861
                                      fourth:
                                        type: object
                                        properties:
                                          x:
                                            type: number
                                            example: 256
                                          'y':
                                            type: number
                                            example: 867
                              rotate:
                                type: object
                                properties:
                                  value:
                                    type: string
                                    example: '0'
                          ocr:
                            type: object
                            description: OCR extracted data
                            properties:
                              ocr_fullName:
                                type: string
                                example: '{{ocr_fullName}}'
                              ocr_firstName:
                                type: string
                                example: '{{ocr_firstName}}'
                              ocr_middleName:
                                type: string
                                example: '{{ocr_middleName}}'
                              ocr_lastName:
                                type: string
                                example: '{{ocr_lastName}}'
                              ocr_gender:
                                type: string
                                example: '{{ocr_gender}}'
                              ocr_nationality:
                                type: string
                                example: '{{ocr_nationality}}'
                              ocr_birthDate:
                                type: string
                                example: '{{ocr_birthDate}}'
                              ocr_identityNumber:
                                type: string
                                example: '{{ocr_identityNumber}}'
                              ocr_issueDate:
                                type: string
                                example: '{{ocr_issueDate}}'
                              ocr_expireDate:
                                type: string
                                example: '{{ocr_expireDate}}'
                              ocr_version:
                                type: string
                                example: '{{ocr_version}}'
                              ocr_number:
                                type: string
                                example: '{{ocr_number}}'
                              full_mrz:
                                type: string
                                example: '{{full_mrz}}'
                              mrz_line1:
                                type: string
                                example: '{{mrz_line1}}'
                              mrz_line2:
                                type: string
                                example: '{{mrz_line2}}'
                      review_front:
                        type: boolean
                        example: true
                      review_back:
                        type: boolean
                        example: false
                      document_type:
                        type: string
                        example: '{{document_type}}'
              examples:
                successful-recognition:
                  summary: Successful ID recognition with complete data
                  value:
                    apiType: id_recognition
                    transactionId: e0nvom3caiis7
                    result:
                      data:
                        raw:
                          address:
                            value: ADDRESS 110, SOMEWHERE STREET
                            score: 89
                            coordinates:
                              first:
                                x: 95
                                'y': 221
                              fourth:
                                x: 95
                                'y': 258
                              second:
                                x: 430
                                'y': 221
                              third:
                                x: 430
                                'y': 258
                            original_coordinates:
                              first:
                                x: 211
                                'y': 714
                              fourth:
                                x: 213
                                'y': 752
                              second:
                                x: 553
                                'y': 713
                              third:
                                x: 554
                                'y': 751
                          authority:
                            value: '{{value}}'
                            score: 4
                            coordinates:
                              first:
                                x: 796
                                'y': 1460
                              fourth:
                                x: 799
                                'y': 1637
                              second:
                                x: 1931
                                'y': 1461
                              third:
                                x: 1925
                                'y': 1641
                          name:
                            value: '{{value}}'
                            score: 61
                            coordinates:
                              first:
                                x: 367
                                'y': 462
                              fourth:
                                x: 375
                                'y': 669
                              second:
                                x: 1379
                                'y': 454
                              third:
                                x: 1378
                                'y': 663
                          name_chn:
                            value: '{{value}}'
                            score: 61
                            coordinates:
                              first:
                                x: 367
                                'y': 462
                              fourth:
                                x: 375
                                'y': 669
                              second:
                                x: 1379
                                'y': 454
                              third:
                                x: 1378
                                'y': 663
                          number:
                            value: '{{value}}'
                            score: 95
                            accepted: true
                            coordinates:
                              first:
                                x: 248
                                'y': 698
                              fourth:
                                x: 256
                                'y': 867
                              second:
                                x: 1423
                                'y': 691
                              third:
                                x: 1421
                                'y': 861
                          rotate:
                            value: '0'
                        ocr:
                          ocr_fullName: '{{ocr_fullName}}'
                          ocr_firstName: '{{ocr_firstName}}'
                          ocr_middleName: '{{ocr_middleName}}'
                          ocr_lastName: '{{ocr_lastName}}'
                          ocr_gender: '{{ocr_gender}}'
                          ocr_nationality: '{{ocr_nationality}}'
                          ocr_birthDate: '{{ocr_birthDate}}'
                          ocr_identityNumber: '{{ocr_identityNumber}}'
                          ocr_issueDate: '{{ocr_issueDate}}'
                          ocr_expireDate: '{{ocr_expireDate}}'
                          ocr_version: '{{ocr_version}}'
                          ocr_number: '{{ocr_number}}'
                          full_mrz: '{{full_mrz}}'
                          mrz_line1: '{{mrz_line1}}'
                          mrz_line2: '{{mrz_line2}}'
                      review_front: true
                      review_back: false
                      document_type: '{{document_type}}'
                async-processing:
                  summary: Async processing request accepted
                  value:
                    transactionId: async_txn_789123
                    message: >-
                      request has been successfully received. The response will
                      be sent to https://your-domain.com/callback
        '400':
          description: Bad request - Invalid input parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: number
                    example: 400
                  apiType:
                    type: string
                    example: id_recognition
                  transactionId:
                    type: string
                    example: '{{transactionId}}'
                  errorCode:
                    type: string
                    example: '1011'
                  message:
                    type: string
                    example: Fail to recognize idCard
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````