Documentación API

¡Bienvenido! Sumérgete en nuestra documentación. Te guiaremos paso a paso para que puedas aprovechar al máximo nuestras APIs y llevar tus proyectos al siguiente nivel.
Para garantizar el mejor desempeño en las validaciones, es importante que la calidad de las imágenes y documentos cumpla con los estándares necesarios para el óptimo funcionamiento del servicio MAXIMAGE ID Recognition®. Te recomendamos integrar no solo las APIs, sino también la interfaz completa del servicio, a fin de asegurar resultados más precisos y una experiencia más eficiente.

Tabla de contenidos

Conoce Maximage ID Recognition®

Valida la identidad de las personas y la veracidad de los documentos, permitiendo que la creación de expedientes sea más segura, eficiente y amigable. La combinación de inteligencia artificial y sistemas biométricos reducen costos y mejoran la experiencia para los procesos dentro y fuera de tu empresa

Huella

Captura de detalles específicos comprobables con Bases de Datos Oficiales, en México con base de datos del INE.

Lectura de Rostro

Reconoce 68 parámetros, reportando edad, género y estados de ánimo. Prueba de Vida a través de acciones aleatorias.
Comparación real entre rostro y fotografía o videos. Autenticación offline y online.

Firma

Obtiene diferentes muestras, para autenticar que la persona está presente al momento de la firma. Obtiene los siguientes
parámetros: velocidad, presión, aceleración y congruencia.

ID

Extrae los datos, valida 35 parámetros de seguridad y compara con prueba de vida

Beneficios

+90% De reducción de Entrada

Manual de Documentos

Prevención de deforestación y mejora en el manejo de residuos

80% de ahorro en costos contables

Validación con listas negras

<1 minuto
Crea perfiles, funciones, roles y estructuras para encontrar todos tus
documentos

2 niveles de cifrado Controles en el
proceso, permisos por documento y
trazabilidad

API de Validación de Documentos: Guía de Uso

Aprende a usar nuestra API de validación de documentos. Conoce los ejemplos de peticiones y respuestas que preparamos para ti y descubre lo fácil que es integrar nuestros servicios, optimizando así tus flujos de trabajo con una validación rápida y segura.

Antes de Empezar: Tu Token de Autorización

Para acceder a nuestras APIs, necesitarás un token de autorización. Este token es tu llave de acceso y te será proporcionado al contratar cualquiera de nuestros servicios.

Por ahora, en la documentación, daremos un token de ejemplo para que puedas familiarizarte con el proceso de integración.

1. Validation Documents

Realiza el reconocimiento óptico de caracteres (OCR) de los documentos CURP, Acta de nacimiento,
identificación y Antecedente académico, junto con este proceso de lectura se realiza la validación de
la información obtenida de la lectura y dada como entrada en la petición

Parámetros de Entrada

Endpoint:

Method Url
POST Api/ProcessDocuments/ValidationDocuments

Encabezados (Headers):

HeaderType
Content-Typeapplication/json
AuthorizationBearer token

Cuerpo de la Petición (Request Body):

A continuación, se detallan los parámetros que se deben enviar en la solicitud para una correcta validación.

Parámetro Tipo Descripción
clave_transaccion String (Requerido) Categoría de la transacción.
identificador String (Requerido) Número único para identificar la transacción.
datos_Validar Objeto de datos (Requerido) Objeto que contiene los datos proporcionados por el Sistema de Origen (CRM, ERP, etc.) para su validación en la API.
Propiedad Tipo Descripción
nombre String (Requerido) Nombre proporcionado por el Sistema de Origen.
paterno String (Requerido) Apellido paterno proporcionado por el Sistema de Origen.
materno String (Requerido) Apellido materno proporcionado por el Sistema de Origen.
curp String (Requerido) CURP proporcionado por el Sistema de Origen.
sexo String (Requerido) Sexo proporcionado por el Sistema de Origen.
fecha_nacimiento String (Requerido) Fecha de nacimiento proporcionada por el Sistema de Origen.
documentos Colección de documentos (Requerido) Colección (array) de objetos para los documentos que se procesarán.
Propiedad Tipo Descripción
clave String (Requerido) Clave que indica el tipo de documento que se está enviando.
anverso_base64 String (Requerido) Documento en formato Base64 (cara frontal).
reverso_base64 String (Requerido) Documento en formato Base64 (cara trasera). Solo se envía en el caso de identificaciones que requieren ambas caras (ej. INE).

2. Claves

Clave Campo Tipo de documento Formato de documento
CURP anverso_base64 CURP DIGITAL .PDF
ACTA_NACIMIENTO anverso_base64 Acta de nacimiento DIGITAL .PDF .JPG
CERTIFICADO_BACHILLERATO anverso_base64 Certificado de bachillerato DIGITALES .PDF
ID anverso_base64 reverso_base64 INE .JPG
ID anverso_base64 Pasaporte .JPG

3. Request

				
					{
    "clave_transaccion": "categoría",
    "identificador": "12370015",
    "datos_validar": {
        "nombre": "TOMAS",
        "paterno": "PEREZ",
        "materno": "FERNANDEZ",
        "curp": "XXXXXXXXXXXXXXXXXX",
        "sexo": "HOMBRE",
        "fecha_nacimiento": "1997-09-14",
    },
    "documentos": [
        {
        "clave": "ID",
        "anverso_base64": "iVBOR...",
        "reverso_base64": "iVBOR..."
        },
        {
        "clave": "CURP",
        "anverso_base64": "JVBE...",
        "reverso_base64": ""
        },
        {
        "clave": "ACTA_NACIMIENTO",
        "anverso_base64": "JVBE...",
        "reverso_base64": ""
        },
        {
        "clave": "CERTIFICADO_BACHILLERATO",
        "anverso_base64": "JVBE...",
        "reverso_base64": ""
        }
    ]
}
				
			

4. Response

Status: 200

Response:

				
					{
    "Success": true,
    "Message": "Success",
    "Token": "",
    "Information": {
        "identificador": "12370015",
        "congruencia": {
            "congruenciaGeneral": true,
            "congruenciaDocs": true,
            "nombreSISTEMA ORIGEN": true,
            "paternoSISTEMA ORIGEN": true,
            "maternoSISTEMA ORIGEN": true,
            "curpSISTEMA ORIGEN": true,
            "sexoSISTEMA ORIGEN": true,
            "fecha_nacimientoSISTEMA ORIGEN": true
            },  
        "datos": {
            "nombre": "TOMAS",
            "apellidoPaterno": "PEREZ",
            "apellidoMaterno": "FERNANDEZ",
            "CURP": "XXXXXXXXXXXXXXXXXX",
            "sexo": "HOMBRE",
            "fecha_nacimiento": "1997-09-14",
            "idElectronicoActa": "XXXXXXXXXXXXXXXXXXX",
            "claveTrabajo": "0000",
            "fechaTerminacionEstudios": "XXXX-XX-XX",
            "fechaTimbrado": "XXXX-XX-XX",
            "selloDigitalEstudios":"H/VMPKVBWTATKVDYLJFJEHIP1XKOZVISSKS7UNVKNGQMAG0UFUCTZKWCROEYVHBVOKLAZNNTZLUMCHN0UDV55FZ2B064RZH9AV0YBA3RTABEDJ/4EKCV6GSG0O7D8KZ1EDEXUE3ANBHJIIUWCNEQS9RSMNTVDENK1OOVQHYXM2TTV99YVWWXMEUBV3XT5RVFMYN8GJLXJRCPVMIC85OBQY8MKVE+E4W0BB0XLWFQ==",
            "bachilleratoQR": [
                {
                "QR": "https://www.siged.sep.gob.mx/certificados",
                "sofiiaOk": true,
                "urlLocalizadaOk": false
                }
            ]
        },
        "resultado_documentos": [
            {
            "documento": "CURP",
            "categoria": "Aprobado",
            "subCategoria": "Documento Digital",
            "comentarios": []
            },
            {
            "documento": "ID",
            "categoria": "Aprobado",
            "subCategoria": "",
            "comentarios": []
            },
            {
            "documento": "ACTA_NACIMIENTO",
            "categoria": "Aprobado",
            "subCategoria": "",
            "comentarios": []
            },
            {
            "documento": "CERTIFICADO_BACHILLERATO",
            "categoria": "Aprobado",
            "subCategoria": "Documento Digital",
            "comentarios": []
            }
        ]
    }
}
				
			

Status: 400

Response: Error de petición: Bad Request

Status: 401

Response: No autorizado: Unauthorized.

Status: 404

Response: Recurso no localizado: Not Found.

Status: 500

Response: Error en el servidor remoto: Internal Server Error. Si el servidor no esta disponible habrá un error de conexión.

ES
Scroll al inicio