Global ID Recognition API - ARGOS Identity

POST

recognition

Recognize and verify ID document

curl --request POST \
  --url https://idverify-api.argosidentity.com/modules/recognition \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "idImage": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAAAABJRU5ErkJggg==",
  "issuingCountry": "USA",
  "idType": "government_id",
  "idBackImage": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAAAABJRU5ErkJggg==",
  "callbackUrl": "https://your-domain.com/callback"
}
'

{
  "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}}"
  }
}

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

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

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

Autorizaciones

x-api-key

string

header

requerido

Cuerpo

application/json

idImage

string

requerido

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

Ejemplo:

"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAAAABJRU5ErkJggg=="

issuingCountry

string

requerido

The ISO 3 Alpha Country Code of the issuing country for the ID document.

Ejemplo:

"USA"

idType

enum<string>

requerido

The type of the ID document

Opciones disponibles:

government_id,

passport,

drivers_license,

residence_permit,

vehicle_registration_certificate,

visa,

aadhaar,

pancard

Ejemplo:

"government_id"

idBackImage

string

Image of the back side of the ID document in base64 format.

Ejemplo:

"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAAAABJRU5ErkJggg=="

callbackUrl

string<uri>

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.

Ejemplo:

"https://your-domain.com/callback"

Respuesta

Successful ID recognition

apiType

string

API type identifier

Ejemplo:

"id_recognition"

transactionId

string

Unique identifier for each request

Ejemplo:

"txn_123456789"

result

object

Object containing the processing result

Show child attributes

Mejores Prácticas para Imágenes de Identificación

⌘I

Recognize and verify ID document

curl --request POST \
  --url https://idverify-api.argosidentity.com/modules/recognition \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "idImage": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAAAABJRU5ErkJggg==",
  "issuingCountry": "USA",
  "idType": "government_id",
  "idBackImage": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAAAABJRU5ErkJggg==",
  "callbackUrl": "https://your-domain.com/callback"
}
'

{
  "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}}"
  }
}

​Descripción General de la API

​Parámetros de Solicitud

​Parámetros Requeridos

​Parámetros Opcionales

​Autenticación

​Formato de Respuesta

​Países y Tipos de Identificación Soportados

​Países Principales

​Tipos de Identificación

​Casos de Uso

​Modos de Procesamiento

​Procesamiento Síncrono

​Procesamiento Asíncrono

​Requisitos de Imagen

​Tamaño de Archivo

​Calidad de Imagen

​Formatos Soportados

​Manejo de Errores

​Tipo de errorCode

Autorizaciones

Cuerpo

Respuesta

Descripción General de la API

Parámetros de Solicitud

Parámetros Requeridos

Parámetros Opcionales

Autenticación

Formato de Respuesta

Países y Tipos de Identificación Soportados

Países Principales

Tipos de Identificación

Casos de Uso

Modos de Procesamiento

Procesamiento Síncrono

Procesamiento Asíncrono

Requisitos de Imagen

Tamaño de Archivo

Calidad de Imagen

Formatos Soportados

Manejo de Errores

Tipo de errorCode