API para extracción y descripción de información en imágenes y documentos. (0.1.6)
Download OpenAPI specification:Download
Visionary es una API que permite a los usuarios analizar imágenes y obtener descripciones detalladas mediante modelos avanzados de lenguaje. Su objetivo principal es transformar documentos no estructurados, como imágenes, en texto estructurado útil para otros sistemas. Soporta distintos tipos de documentos, incluyendo comprobantes de domicilio, estados de cuenta bancarios, cartas de libranza, constancias fiscales (CIF, CURP, FM2/3, NSS, pasaportes y más). La autenticación se realiza con una API Key en el encabezado Rem-Apikey
. Para más detalles, consulta la documentación oficial.
Extrae información a partir de una imagen de comprobante de domicilio.
Permite extraer información estructurada de la imagen de un comprobante de domicilio.
Authorizations:
Request Body schema: multipart/form-data
file required | string <binary> (File) |
Password (string) or Password (null) (Password) |
Responses
Response samples
- 200
- 422
- 500
{- "message": "Address proof OCR completed",
- "data": {
- "name": "Juan Perez",
- "type": "ELECTRICITY",
- "issued_by": "CFE",
- "date": "2023-01-01",
- "end_date": "2023-02-01",
- "likely_recent": true,
- "address": {
- "street": "Avenida Reforma",
- "ext_num": "1234",
- "int_num": "apt 123",
- "neighborhood": "Colonia Centro",
- "municipality": "Delegación Cuauhtémoc",
- "state": "Estado de México",
- "country": "México",
- "postal_code": "06000"
}
}
}
Extrae información de un estado de cuenta bancario a partir de una imagen o archivo PDF.
Permite obtener información estructurada desde la imagen o PDF de un estado de cuenta bancario.
Authorizations:
query Parameters
validate_rfc | boolean (Validate Rfc) Default: false |
Request Body schema: multipart/form-data
file required | string <binary> (File) |
Password (string) or Password (null) (Password) |
Responses
Response samples
- 200
- 422
- 500
{- "message": "Bank statement information extracted",
- "data": {
- "name": "Juan Perez",
- "entity": "CFE",
- "rfc_person": "ABCD123456AB0",
- "rfc_person_structure_valid": true,
- "rfc_entity": "ABCD123456AB0",
- "rfc_entity_structure_valid": true,
- "date_start": "2023-01-01",
- "date_end": "2023-01-31",
- "account_number": "1234567890",
- "clabe": "123456789012345678",
- "average_amount": 1234.56,
- "total_amount": 12345.67,
- "rfc_person_valid": true,
- "rfc_person_status": "Valid"
}
}
Extrae información de una imagen o PDF de CURP.
Permite extraer datos estructurados de una imagen de CURP.
Authorizations:
query Parameters
validate_curp | boolean (Validate Curp) Default: false |
Request Body schema: multipart/form-data
file required | string <binary> (File) |
Password (string) or Password (null) (Password) |
Responses
Response samples
- 200
- 422
- 500
{- "message": "CURP OCR completed",
- "data": {
- "full_name": "JUAN PEREZ HERNANDEZ",
- "curp": "PEHJ950101HDFRRL09",
- "curp_structure_valid": true,
- "birthdate": "1995-01-01",
- "state_of_birth": "DF",
- "state_of_registration": "Distrito Federal",
- "asociated_curps": [
- "PERJ900101HDFXXX01",
- "HUCA900101HDFXXX01"
], - "qr_found": true,
- "qr_valid": true,
- "curp_valid": true,
- "curp_response": {
- "curp": "PERJ900101HDFXXX01",
- "valid": true,
- "name": "JUAN",
- "first_last_name": "PÉREZ",
- "second_last_name": "GARCÍA",
- "birth_date": "1990-01-01",
- "gender": "H",
- "nationality": "MEX",
- "birth_federal_entity": "DF",
- "issuing_entity_key": "",
- "curp_status": "AN",
- "curp_status_description": "Alta Normal",
- "registration_year": "1990",
- "certificate_folio": "",
- "registration_entity_number": "01",
- "municipality_key": "001",
- "foreign_registration_number": "",
- "provatory_document": "Acta de Nacimiento",
- "probatory_document_data": {
- "id": "1",
- "name": "Acta de nacimiento",
- "book": "",
- "act_number": "000000",
- "sheet": "",
- "tome": "",
- "crip": "",
- "letter_folio": ""
}
}
}
}
Extrae información desde una imagen de CIF.
Obtén datos estructurados a partir de la imagen de una constancia de identificación fiscal (CIF).
Authorizations:
query Parameters
validate_rfc | boolean (Validate Rfc) Default: false |
Request Body schema: multipart/form-data
file required | string <binary> (File) |
Password (string) or Password (null) (Password) |
Responses
Response samples
- 200
- 422
- 500
{- "message": "CIF OCR completed",
- "data": {
- "cif": {
- "full_name": "John Doe",
- "rfc": "ABCD123456EFG",
- "id": "1234567890"
}, - "identification_data": {
- "curp": "ABCD123456EFG",
- "name": "John",
- "first_lastname": "Doe",
- "second_lastname": "Smith",
- "birthdate": "2023-01-01",
- "start_date": "2023-01-01",
- "situation": "ACTIVO",
- "situation_last_update": "2023-01-01"
}, - "fiscal_address": {
- "street": "Av. Benito Juárez",
- "ext_num": "1000",
- "int_num": "Apto 123",
- "postal_code": "01000",
- "neighborhood": "Buena Vista",
- "municipality": "Venustiano Carranza",
- "state": "Ciudad de México",
- "email": "example@mail.com",
- "al": "CDMX1"
}, - "fiscal_characteristics": {
- "rfc": "ABCD123456EFG",
- "regimes": [
- {
- "regime": "Régimen de Sueldos y Salarios e Ingresos Asimilados a Salarios",
- "start_date": "2023-01-01"
}
]
}, - "qr_found": true,
- "qr_valid": true,
- "rfc_person_valid": true,
- "rfc_person_status": "Valid"
}
}
Extrae información desde un documento de asignación de NSS.
Extrae información estructurada de un documento de asignación de NSS.
Authorizations:
query Parameters
validate_curp | boolean (Validate Curp) Default: false |
validate_nss | boolean (Validate Nss) Default: false |
Request Body schema: multipart/form-data
file required | string <binary> (File) |
Password (string) or Password (null) (Password) |
Responses
Response samples
- 200
- 422
- 500
{- "message": "NSS assignment OCR completed",
- "data": {
- "nss": "12345678901",
- "request_date": "2023-01-01",
- "folio": "1234567890",
- "name": "John Doe",
- "first_lastname": "Doe",
- "second_lastname": "Smith",
- "birthdate": "2023-01-01",
- "curp": "DOEJ850101HDFXXX01",
- "gender": "H",
- "state_of_birth": "Ciudad de México",
- "qr_found": true,
- "qr_valid": true,
- "nss_valid": true,
- "nss_structure_valid": true,
- "nss_response": {
- "success": true,
- "result": {
- "nss": "12345678901",
- "name": "John Doe",
- "first_lastname": "Doe",
- "second_lastname": "Smith",
- "birth_date": "2023-01-01"
}
}, - "curp_structure_valid": true,
- "valid_curp": true,
- "curp_response": {
- "curp": "PERJ900101HDFXXX01",
- "valid": true,
- "name": "JUAN",
- "first_last_name": "PÉREZ",
- "second_last_name": "GARCÍA",
- "birth_date": "1990-01-01",
- "gender": "H",
- "nationality": "MEX",
- "birth_federal_entity": "DF",
- "issuing_entity_key": "",
- "curp_status": "AN",
- "curp_status_description": "Alta Normal",
- "registration_year": "1990",
- "certificate_folio": "",
- "registration_entity_number": "01",
- "municipality_key": "001",
- "foreign_registration_number": "",
- "provatory_document": "Acta de Nacimiento",
- "probatory_document_data": {
- "id": "1",
- "name": "Acta de nacimiento",
- "book": "",
- "act_number": "000000",
- "sheet": "",
- "tome": "",
- "crip": "",
- "letter_folio": ""
}
}
}
}
Extrae información de un documento pasaporte.
Permite obtener la información contenida en un pasaporte y devuelve los datos en formato estructurado.
Authorizations:
Request Body schema: multipart/form-data
file required | string <binary> (File) |
Password (string) or Password (null) (Password) |
Responses
Response samples
- 200
- 422
- 500
{- "message": "Passport OCR completed",
- "data": {
- "type": "P",
- "number": "123456789",
- "nationality": "MEX",
- "expiration_date": "2023-12-31",
- "issuing_country": "MEX",
- "issuing_date": "2013-12-31",
- "birth_date": "1990-01-01",
- "birth_place": "MEX",
- "name": "Juan",
- "first_lastname": "Perez",
- "second_lastname": "Garcia",
- "gender": "M",
- "national_id": "123456789",
- "remarks": "Remarks"
}
}
Extrae información de un documento FM2 o FM3.
Obtiene información de un documento FM2 y la retorna en formato estructurado.
Authorizations:
query Parameters
validate_curp | boolean (Validate Curp) Default: false |
Request Body schema: multipart/form-data
file required | string <binary> (File) |
Password (string) or Password (null) (Password) |
Responses
Response samples
- 200
- 422
- 500
{- "message": "FM2 OCR completed",
- "data": {
- "type": "VISITANTE",
- "number": "0000000000001",
- "name": "JOHN DOE",
- "last_name": "DOE",
- "first_lastname": "DOE",
- "second_lastname": "SMITH",
- "country": "USA",
- "birth_date": "2000-01-01",
- "gender": "M",
- "curp": "ABCD900101HXXXXX00",
- "curp_structure_valid": true,
- "curp_valid": true,
- "expedition_date": "2022-01-01",
- "expiration_date": "2023-01-01",
- "curp_response": {
- "curp": "PERJ900101HDFXXX01",
- "valid": true,
- "name": "JUAN",
- "first_last_name": "PÉREZ",
- "second_last_name": "GARCÍA",
- "birth_date": "1990-01-01",
- "gender": "H",
- "nationality": "MEX",
- "birth_federal_entity": "DF",
- "issuing_entity_key": "",
- "curp_status": "AN",
- "curp_status_description": "Alta Normal",
- "registration_year": "1990",
- "certificate_folio": "",
- "registration_entity_number": "01",
- "municipality_key": "001",
- "foreign_registration_number": "",
- "provatory_document": "Acta de Nacimiento",
- "probatory_document_data": {
- "id": "1",
- "name": "Acta de nacimiento",
- "book": "",
- "act_number": "000000",
- "sheet": "",
- "tome": "",
- "crip": "",
- "letter_folio": ""
}
}
}
}
Extrae datos de una carta de libranza en formato PDF.
Permite obtener información estructurada de una carta de libranza en PDF.
Authorizations:
query Parameters
validate_curp | boolean (Validate Curp) Default: false |
Request Body schema: multipart/form-data
file required | string <binary> (File) |
Password (string) or Password (null) (Password) | |
Pages (integer) or Pages (null) (Pages) Default: 1 |
Responses
Response samples
- 200
- 422
- 500
{- "message": "Carta Libranza OCR completed successfully",
- "data": {
- "business_email": "test@mail.com",
- "business_name": "TEST COMPANY",
- "business_folio": "ABCD123456EFG",
- "business_phone": "5555555555",
- "curp": "XXXX900101XXXXXX00",
- "curp_structure_valid": true,
- "date": "2023-01-01",
- "email": "user@mail.com",
- "first_name": "John",
- "first_lastname": "Doe",
- "second_lastname": "Smith",
- "loan_amount": "$ 1,000.00",
- "loan_amount_to_receive": "$ 1,000.00",
- "loan_cat_with_iva": "0.00 %",
- "loan_first_deduction_date": "2023-01-01",
- "loan_folio_validity_date": "2023-01-01",
- "loan_monthly_deduction": "$ 1,000.00",
- "loan_term": "12 months",
- "loan_total_amount_due": "$ 1,000.00",
- "loans_to_liquidate": [
- {
- "cat_with_iva": "0.00 %",
- "loan_amount": "$ 1,000.00",
- "monthly_deduction": "$ 1,000.00",
- "deductions_term": "12 months",
- "capital_balance": "$ 1,000.00",
- "total_amount_due": "$ 1,000.00",
- "entity_clabe": "123456789012345678",
- "fine_entity": "TEST COMPANY"
}
], - "mobile_number": "5555555555",
- "nss": "12345678901",
- "ooad": "CDMX",
- "promotor": "John Doe"
}
}
Extrae información de un reporte de crédito en PDF.
Authorizations:
Request Body schema: multipart/form-data
Password (string) or Password (null) (Password) | |
file required | string <binary> (File) |
Responses
Response samples
- 200
- 400
- 422
{- "status": "success",
- "message": "Credit report extracted successfully",
- "data": {
- "type": "PF_CDC",
- "name": "John Doe",
- "rfc": "ABCD123456EFG",
- "curp": "ABCD123456EFGHJKL01",
- "birthdate": "2022-01-01",
- "fiscal_address": {
- "street": "Calle 123",
- "number": "123",
- "neighborhood": "Colonia 123",
- "zip_code": "12345",
- "city": "Ciudad 123",
- "state": "Estado 123",
- "country": "País 123"
}, - "credit_score": 700,
- "shareholders": [
- {
- "name": "John Doe",
- "rfc": "ABCD123456EFG",
- "address": "Calle 123",
- "participation": "50%"
}
], - "guarantors": [
- {
- "name": "John Doe",
- "rfc": "ABCD123456EFG",
- "address": "Calle 123",
- "amount": 1000
}
], - "credits": [
- {
- "institution": "Bank",
- "current_balance": 1000,
- "overdue_balance": 100,
- "status": "CORRIENTE",
- "payment_amount": 100,
- "start_date": "2022-01-01",
- "end_date": "2022-12-31",
- "last_update": "2022-01-01",
- "last_payment_date": "2022-01-01",
- "credit_limit_amount": 1000,
- "max_credit_amount": 1000,
- "type": "COMERCIAL"
}
], - "previous_consultations": [
- {
- "institution": "Bank",
- "date": "2022-01-01",
- "phone": "1234567890",
- "address": "Calle 123, Ciudad 123, Estado 123, País 123"
}
]
}
}