API Documentation
Table of contents
Get to know Maximage ID Recognition®
Fingerprint
Capture of specific details verifiable with official databases, in Mexico with the INE database.
Facial recognition
Recognizes 68 parameters, reporting age, gender, and mood. Proof of Life through random actions.
True face comparison with photos or videos. Offline and online authentication.
Signature
Obtains different samples to authenticate that the person is present at the time of the signature. Obtains the following parameters:
velocity, pressure, acceleration, and congruence.
ID
Extracts data, validates 35 security parameters and compares with liveness test
Benefits
+90% Entry Reduction
Documents Manual
Deforestation prevention and improved waste management
80% savings in accounting costs
Validation with blacklists
<1 minute
Create profiles, functions, roles and structures to find all your
documents
2 levels of encryption Controls on the
process, permissions per document and
traceability
Document Validation API: User Guide
Learn how to use our document validation API. Learn about the examples of requests and responses that we've prepared for you and discover how easy it is to integrate our services, optimizing your workflows with fast and secure validation.
Before You Begin: Your Authorization Token
To access our APIs, you will need a authorization token. This token is your access key and will be provided to you when you purchase any of our services.
For now, in the documentation, we'll provide an example token so you can familiarize yourself with the integration process.
1. Validation Documents
Performs optical character recognition (OCR) of CURP documents, Birth Certificate,
identification and academic background, along with this reading process, validation is carried out
the information obtained from the reading and given as input in the request
Input Parameters
Endpoint:
| Method | Url |
|---|---|
POST
|
Api/ProcessDocuments/ValidationDocuments |
Headers
| Header | Type |
|---|---|
Content-Type | application/json |
Authorization | Bearer token |
Request Body:
The parameters that must be sent in the request for proper validation are detailed below.
| Parameter | Type | Description | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
clave_transaccion |
String (Required) | Transaction category. | |||||||||||||||||||||
identificador |
String (Required) | Unique number to identify the transaction. | |||||||||||||||||||||
datos_Validar |
Data Object (Required) | Object that contains the data provided by the Source System (CRM, ERP, etc.) for validation in the API.
|
|||||||||||||||||||||
documents |
Collection of documents (Required) | Collection (array) of objects for the documents to be processed.
|
2. Keys
| Key | Field | Document type | Document format |
|---|---|---|---|
CURP |
anverso_base64 | CURP | DIGITAL .PDF |
ACTA_NACIMIENTO |
anverso_base64 | Birth certificate | DIGITAL .PDF .JPG |
CERTIFICADO_BACHILLERATO |
anverso_base64 | High school certificate | DIGITALES .PDF |
ID |
anverso_base64 reverso_base64 | INE | .JPG |
ID |
anverso_base64 | Passport | .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.