Skip to main content

Visionary API (1.7.0)

Download OpenAPI specification:Download

rem.tools: support@rem.tools URL: https://www.remtools.io/ License: Apache-2.0

Visionary es una API que permite a los usuarios enviar imágenes y obtener una descripción de las mismas usando modelos de lenguaje avanzados.

Objetivo

El objetivo de esta API, es permitir leer documentos no estructurados, como imágenes, y convertirlos en texto estructurado, para que puedan ser utilizados en otros sistemas.

Documentos soportados

  • Address Proof: Documentos de identificación que contienen información de dirección.
  • Bank Statement: Estados de cuenta bancarios.
  • Carta Libranza: Cartas de libranza.
  • CIF: Constancias de identificación fiscal.
  • Constitutive Act: Actas constitutivas de empresas.
  • Compliance Opinion: Opiniones de cumplimiento de obligaciones fiscales del SAT.
  • Credit Contract: Contratos de crédito.
  • Credit Report: Reportes de crédito.
  • CSF: Constancias de situación fiscal.
  • CURP: Clave Única de Registro de Población.
  • FM: Formato Migratorio 2 y 3.
  • Generic ID Front: Tarjetas de identificación oficiales.
  • Generic ID Back: Tarjetas de identificación oficiales (parte trasera).
  • Generic Extraction: Extracción de campos definidos por el usuario.
  • INE Front: Parte frontal de la credencial de elector.
  • INE Back: Parte trasera de la credencial de elector.
  • ISN: Comprobantes estatales de línea de captura del Impuesto Sobre Nóminas.
  • Lease Invoice: Facturas o CFDI de arrendamiento.
  • NSS: Documento y tarjeta de Seguro Social.
  • PASSPORT: Pasaportes.
  • Payroll: Recibos de nómina.
  • SUA: Cédulas y fichas de pago de obligaciones de seguridad social.

Autenticación

Esta API requiere un API key para ser utilizada. Pasa la API key en el header Rem-Apikey.

Para más información, visita la documentación.

Documentos

Endpoints para extraer información de documentos no estructurados

Extract information from an address proof image

Endpoint to extract information from an address proof image

Authorizations:
APIKeyHeader
Request Body schema: multipart/form-data
file
required
string <binary> (File)
Password (string) or Password (null) (Password)
Ownership Full Name (string) or Ownership Full Name (null) (Ownership Full Name)

Person or institution name used to evaluate its relationship to the document

Ownership Curp (string) or Ownership Curp (null) (Ownership Curp)

Optional CURP used as complementary ownership evidence

Ownership Rfc (string) or Ownership Rfc (null) (Ownership Rfc)

Optional RFC used as complementary ownership evidence

Responses

Response samples

Content type
application/json
Example
{
  • "message": "Address proof OCR completed",
  • "data": {
    }
}

Extract bank statement information from an image or PDF file.

Endpoint to extract information from a bank statement image

Authorizations:
APIKeyHeader
query Parameters
validate_rfc
boolean (Validate Rfc)
Default: false
extended
boolean (Extended)
Default: false

When true and the uploaded file is a PDF, also extracts movements from all pages.

Request Body schema: multipart/form-data
file
required
string <binary> (File)
Password (string) or Password (null) (Password)
Ownership Full Name (string) or Ownership Full Name (null) (Ownership Full Name)

Person or institution name used to evaluate its relationship to the document

Ownership Curp (string) or Ownership Curp (null) (Ownership Curp)

Optional CURP used as complementary ownership evidence

Ownership Rfc (string) or Ownership Rfc (null) (Ownership Rfc)

Optional RFC used as complementary ownership evidence

Responses

Response samples

Content type
application/json
Example
{
  • "message": "Bank statement information extracted",
  • "data": {
    }
}

Extract information from a CURP image or PDF file

Endpoint to extract information from a CURP image

Authorizations:
APIKeyHeader
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)
Ownership Full Name (string) or Ownership Full Name (null) (Ownership Full Name)

Person or institution name used to evaluate its relationship to the document

Ownership Curp (string) or Ownership Curp (null) (Ownership Curp)

Optional CURP used as complementary ownership evidence

Ownership Rfc (string) or Ownership Rfc (null) (Ownership Rfc)

Optional RFC used as complementary ownership evidence

Responses

Response samples

Content type
application/json
Example
{
  • "message": "CURP OCR completed",
  • "data": {
    }
}

Extract information from a CIF image

Endpoint to extract information from a CIF image

Authorizations:
APIKeyHeader
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)
Ownership Full Name (string) or Ownership Full Name (null) (Ownership Full Name)

Person or institution name used to evaluate its relationship to the document

Ownership Curp (string) or Ownership Curp (null) (Ownership Curp)

Optional CURP used as complementary ownership evidence

Ownership Rfc (string) or Ownership Rfc (null) (Ownership Rfc)

Optional RFC used as complementary ownership evidence

Responses

Response samples

Content type
application/json
Example
{
  • "message": "CIF OCR completed",
  • "data": {
    }
}

Extract information from a CSF image

Endpoint to extract information from a CSF image

Authorizations:
APIKeyHeader
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)
Ownership Full Name (string) or Ownership Full Name (null) (Ownership Full Name)

Person or institution name used to evaluate its relationship to the document

Ownership Curp (string) or Ownership Curp (null) (Ownership Curp)

Optional CURP used as complementary ownership evidence

Ownership Rfc (string) or Ownership Rfc (null) (Ownership Rfc)

Optional RFC used as complementary ownership evidence

Responses

Response samples

Content type
application/json
Example
{
  • "message": "CSF OCR completed",
  • "data": {
    }
}

Extract information from a NSS assignment document

Endpoint to extract information from a NSS assignment document

Authorizations:
APIKeyHeader
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)
Ownership Full Name (string) or Ownership Full Name (null) (Ownership Full Name)

Person or institution name used to evaluate its relationship to the document

Ownership Curp (string) or Ownership Curp (null) (Ownership Curp)

Optional CURP used as complementary ownership evidence

Ownership Rfc (string) or Ownership Rfc (null) (Ownership Rfc)

Optional RFC used as complementary ownership evidence

Responses

Response samples

Content type
application/json
Example
{
  • "message": "NSS assignment OCR completed",
  • "data": {
    }
}

Extract information from a passport document

Extract the information from a passport document and return it in a structured format.

Authorizations:
APIKeyHeader
Request Body schema: multipart/form-data
file
required
string <binary> (File)
Password (string) or Password (null) (Password)
Ownership Full Name (string) or Ownership Full Name (null) (Ownership Full Name)

Person or institution name used to evaluate its relationship to the document

Ownership Curp (string) or Ownership Curp (null) (Ownership Curp)

Optional CURP used as complementary ownership evidence

Ownership Rfc (string) or Ownership Rfc (null) (Ownership Rfc)

Optional RFC used as complementary ownership evidence

Responses

Response samples

Content type
application/json
Example
{
  • "message": "Passport OCR completed",
  • "data": {
    }
}

Extract information from a FM2 or FM3 document

Extract the information from a FM2 document and return it in a structured format.

Authorizations:
APIKeyHeader
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)
Ownership Full Name (string) or Ownership Full Name (null) (Ownership Full Name)

Person or institution name used to evaluate its relationship to the document

Ownership Curp (string) or Ownership Curp (null) (Ownership Curp)

Optional CURP used as complementary ownership evidence

Ownership Rfc (string) or Ownership Rfc (null) (Ownership Rfc)

Optional RFC used as complementary ownership evidence

Responses

Response samples

Content type
application/json
Example
{
  • "message": "FM2 OCR completed",
  • "data": {
    }
}

Extract information from a carta libranza pdf

Endpoint to extract information from a carta libranza pdf, solo acepta archivos PDF.

  • file: Carta libranza PDF file to be processed
  • password: Password to unlock the PDF file (if needed)
  • validate_curp: Validate the extracted CURP against the government database (default: False)
  • pages: Number of pages to process (default: 1, max: 5)
  • rem_apikey: API key to access the endpoint (passed in the header)
Authorizations:
APIKeyHeader
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
Ownership Full Name (string) or Ownership Full Name (null) (Ownership Full Name)

Person or institution name used to evaluate its relationship to the document

Ownership Curp (string) or Ownership Curp (null) (Ownership Curp)

Optional CURP used as complementary ownership evidence

Ownership Rfc (string) or Ownership Rfc (null) (Ownership Rfc)

Optional RFC used as complementary ownership evidence

Responses

Response samples

Content type
application/json
Example
{
  • "message": "Carta Libranza OCR completed successfully",
  • "data": {
    }
}

Extract data from a Mexican SAT compliance opinion PDF

Extracts the taxpayer name, opinion result, RFC, reference number, and issue date and time. This extraction does not verify the document's authenticity or query its current status with the SAT. The maximum PDF size is 20 MB.

Authorizations:
APIKeyHeader
Request Body schema: multipart/form-data
file
required
string <binary> (File)
Password (string) or Password (null) (Password)
Ownership Full Name (string) or Ownership Full Name (null) (Ownership Full Name)

Person or institution name used to evaluate its relationship to the document

Ownership Curp (string) or Ownership Curp (null) (Ownership Curp)

Optional CURP used as complementary ownership evidence

Ownership Rfc (string) or Ownership Rfc (null) (Ownership Rfc)

Optional RFC used as complementary ownership evidence

Responses

Response samples

Content type
application/json
{
  • "message": "Compliance opinion information extracted",
  • "data": {
    }
}

Extract caller-defined string fields from a document

Accepts a PDF, JPEG, or PNG and a JSON string containing 1 to 50 field definitions. Each definition requires a lower-case snake_case name and a description of up to 150 characters. document_context is limited to 255 characters. PDFs are limited to six pages. All returned values are strings; missing values are empty strings.

Authorizations:
APIKeyHeader
Request Body schema: multipart/form-data
file
required
string <binary> (File)
fields
required
string (Fields)

JSON string containing 1 to 50 objects with name and description properties

document_context
required
string (Document Context)

Description of the submitted document

Password (string) or Password (null) (Password)
Ownership Full Name (string) or Ownership Full Name (null) (Ownership Full Name)

Person or institution name used to evaluate its relationship to the document

Ownership Curp (string) or Ownership Curp (null) (Ownership Curp)

Optional CURP used as complementary ownership evidence

Ownership Rfc (string) or Ownership Rfc (null) (Ownership Rfc)

Optional RFC used as complementary ownership evidence

Responses

Response samples

Content type
application/json
{
  • "message": "Document information extracted",
  • "data": {
    }
}

Extract information from a credit report in PDF format

Authorizations:
APIKeyHeader
Request Body schema: multipart/form-data
Password (string) or Password (null) (Password)
file
required
string <binary> (File)
Ownership Full Name (string) or Ownership Full Name (null) (Ownership Full Name)

Person or institution name used to evaluate its relationship to the document

Ownership Curp (string) or Ownership Curp (null) (Ownership Curp)

Optional CURP used as complementary ownership evidence

Ownership Rfc (string) or Ownership Rfc (null) (Ownership Rfc)

Optional RFC used as complementary ownership evidence

Responses

Response samples

Content type
application/json
Example
{
  • "status": "success",
  • "message": "Credit report extracted successfully",
  • "data": {
    }
}

Extract credit contract information from an image or PDF file.

Endpoint to extract information from a credit contract image or PDF.

Authorizations:
APIKeyHeader
Request Body schema: multipart/form-data
file
required
string <binary> (File)
Password (string) or Password (null) (Password)
Ownership Full Name (string) or Ownership Full Name (null) (Ownership Full Name)

Person or institution name used to evaluate its relationship to the document

Ownership Curp (string) or Ownership Curp (null) (Ownership Curp)

Optional CURP used as complementary ownership evidence

Ownership Rfc (string) or Ownership Rfc (null) (Ownership Rfc)

Optional RFC used as complementary ownership evidence

Responses

Response samples

Content type
application/json
Example
{
  • "message": "Credit contract information extracted",
  • "data": {
    }
}

Extract information from a INE front document

Extract the information from a INE front document and return it in a structured format.

Authorizations:
APIKeyHeader
Request Body schema: multipart/form-data
file
required
string <binary> (File)
Password (string) or Password (null) (Password)
Ownership Full Name (string) or Ownership Full Name (null) (Ownership Full Name)

Person or institution name used to evaluate its relationship to the document

Ownership Curp (string) or Ownership Curp (null) (Ownership Curp)

Optional CURP used as complementary ownership evidence

Ownership Rfc (string) or Ownership Rfc (null) (Ownership Rfc)

Optional RFC used as complementary ownership evidence

Responses

Response samples

Content type
application/json
Example
{
  • "message": "INE OCR completed",
  • "data": {
    }
}

Extract information from INE reverse side document

Extract the information from a INE reverse side document.

Authorizations:
APIKeyHeader
Request Body schema: multipart/form-data
file
required
string <binary> (File)
Password (string) or Password (null) (Password)
Ownership Full Name (string) or Ownership Full Name (null) (Ownership Full Name)

Person or institution name used to evaluate its relationship to the document

Ownership Curp (string) or Ownership Curp (null) (Ownership Curp)

Optional CURP used as complementary ownership evidence

Ownership Rfc (string) or Ownership Rfc (null) (Ownership Rfc)

Optional RFC used as complementary ownership evidence

Responses

Response samples

Content type
application/json
Example
{
  • "message": "Ine reverse side extracted",
  • "data": {
    }
}

Extract information from a INE front document

Extract the information from a INE front document and return it in a structured format.

Authorizations:
APIKeyHeader
Request Body schema: multipart/form-data
file
required
string <binary> (File)
Password (string) or Password (null) (Password)
Ownership Full Name (string) or Ownership Full Name (null) (Ownership Full Name)

Person or institution name used to evaluate its relationship to the document

Ownership Curp (string) or Ownership Curp (null) (Ownership Curp)

Optional CURP used as complementary ownership evidence

Ownership Rfc (string) or Ownership Rfc (null) (Ownership Rfc)

Optional RFC used as complementary ownership evidence

Responses

Response samples

Content type
application/json
Example
{
  • "message": "INE OCR completed",
  • "data": {
    }
}

Extract data from a Mexican ISN declaration or payment document PDF

Authorizations:
APIKeyHeader
Request Body schema: multipart/form-data
file
required
string <binary> (File)
Password (string) or Password (null) (Password)
Ownership Full Name (string) or Ownership Full Name (null) (Ownership Full Name)

Person or institution name used to evaluate its relationship to the document

Ownership Curp (string) or Ownership Curp (null) (Ownership Curp)

Optional CURP used as complementary ownership evidence

Ownership Rfc (string) or Ownership Rfc (null) (Ownership Rfc)

Optional RFC used as complementary ownership evidence

Responses

Response samples

Content type
application/json
{
  • "message": "ISN payment information extracted",
  • "data": {
    }
}

Extract data from a Mexican lease invoice or CFDI PDF

Authorizations:
APIKeyHeader
Request Body schema: multipart/form-data
file
required
string <binary> (File)
Password (string) or Password (null) (Password)
Ownership Full Name (string) or Ownership Full Name (null) (Ownership Full Name)

Person or institution name used to evaluate its relationship to the document

Ownership Curp (string) or Ownership Curp (null) (Ownership Curp)

Optional CURP used as complementary ownership evidence

Ownership Rfc (string) or Ownership Rfc (null) (Ownership Rfc)

Optional RFC used as complementary ownership evidence

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "data": {
    },
  • "error": "string",
  • "error_type": "INVALID_REQUEST",
  • "document_ownership": {
    }
}

Constitutive Act

Authorizations:
APIKeyHeader
Request Body schema: application/x-www-form-urlencoded
Password (string) or Password (null) (Password)
Ownership Full Name (string) or Ownership Full Name (null) (Ownership Full Name)

Person or institution name used to evaluate its relationship to the document

Ownership Curp (string) or Ownership Curp (null) (Ownership Curp)

Optional CURP used as complementary ownership evidence

Ownership Rfc (string) or Ownership Rfc (null) (Ownership Rfc)

Optional RFC used as complementary ownership evidence

File (string) or File (null) (File)
Tmp File Id (string) or Tmp File Id (null) (Tmp File Id)

Responses

Response samples

Content type
application/json
Example
{
  • "message": "Constitutive document extracted and analyzed",
  • "data": {
    }
}

Extract information from an official ID front document

Extract the information from an official ID front document and return it in a structured format.

Authorizations:
APIKeyHeader
Request Body schema: multipart/form-data
file
required
string <binary> (File)
Password (string) or Password (null) (Password)
Ownership Full Name (string) or Ownership Full Name (null) (Ownership Full Name)

Person or institution name used to evaluate its relationship to the document

Ownership Curp (string) or Ownership Curp (null) (Ownership Curp)

Optional CURP used as complementary ownership evidence

Ownership Rfc (string) or Ownership Rfc (null) (Ownership Rfc)

Optional RFC used as complementary ownership evidence

Responses

Response samples

Content type
application/json
Example
{
  • "message": "ID OCR completed",
  • "data": {
    }
}

Extract information from an official ID back document

Extract the information from an official ID back document and return it in a structured format.

Authorizations:
APIKeyHeader
Request Body schema: multipart/form-data
file
required
string <binary> (File)
Password (string) or Password (null) (Password)
Ownership Full Name (string) or Ownership Full Name (null) (Ownership Full Name)

Person or institution name used to evaluate its relationship to the document

Ownership Curp (string) or Ownership Curp (null) (Ownership Curp)

Optional CURP used as complementary ownership evidence

Ownership Rfc (string) or Ownership Rfc (null) (Ownership Rfc)

Optional RFC used as complementary ownership evidence

Responses

Response samples

Content type
application/json
Example
{
  • "message": "ID back OCR completed",
  • "data": {
    }
}

Extract payroll information from an image or PDF file.

Endpoint to extract information from a payroll image

Authorizations:
APIKeyHeader
query Parameters
validate_rfc
boolean (Validate Rfc)
Default: false
validate_curp
boolean (Validate Curp)
Default: false
validate_cfdi
boolean (Validate Cfdi)
Default: false
Request Body schema: multipart/form-data
file
required
string <binary> (File)
Password (string) or Password (null) (Password)
Ownership Full Name (string) or Ownership Full Name (null) (Ownership Full Name)

Person or institution name used to evaluate its relationship to the document

Ownership Curp (string) or Ownership Curp (null) (Ownership Curp)

Optional CURP used as complementary ownership evidence

Ownership Rfc (string) or Ownership Rfc (null) (Ownership Rfc)

Optional RFC used as complementary ownership evidence

Responses

Response samples

Content type
application/json
Example
{
  • "message": "Payroll information extracted",
  • "data": {
    }
}

Extract data from a Mexican SUA payment form PDF

Authorizations:
APIKeyHeader
Request Body schema: multipart/form-data
file
required
string <binary> (File)
Password (string) or Password (null) (Password)
Ownership Full Name (string) or Ownership Full Name (null) (Ownership Full Name)

Person or institution name used to evaluate its relationship to the document

Ownership Curp (string) or Ownership Curp (null) (Ownership Curp)

Optional CURP used as complementary ownership evidence

Ownership Rfc (string) or Ownership Rfc (null) (Ownership Rfc)

Optional RFC used as complementary ownership evidence

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "data": {
    },
  • "error": "string",
  • "error_type": "INVALID_REQUEST",
  • "document_ownership": {
    }
}

Verify if a document is an original or a photocopy

Analyze an image to determine if it is an original identification document or a photocopy.

The analysis considers multiple factors including:

  • Color quality (vibrant vs washed-out/grayscale)
  • Edge definition (sharp vs blurred)
  • Security features visibility
  • Overall image quality and artifacts

Returns a detailed analysis with confidence score.

Authorizations:
APIKeyHeader
Request Body schema: multipart/form-data
file
required
string <binary> (File)
Password (string) or Password (null) (Password)

Responses

Response samples

Content type
application/json
Example
{
  • "message": "Document analysis completed",
  • "data": {
    }
}

Detect the document type from the first three PDF pages

Authorizations:
APIKeyHeader
Request Body schema: multipart/form-data
file
required
string <binary> (File)
Password (string) or Password (null) (Password)

Responses

Response samples

Content type
application/json
{
  • "message": "Document classification completed",
  • "data": {
    }
}
rem

JOIN US ON

facebooktwitterLinkedIn
CONTACThello@rem.tools55-91-03-80-54
© Copyright rem 2022 All rights reserved.