Skip to main content
Documentation Powered by Redocly

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.
  • 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).
  • INE Front: Parte frontal de la credencial de elector.
  • INE Back: Parte trasera de la credencial de elector.
  • NSS: Documento y tarjeta de Seguro Social.
  • PASSPORT: Pasaportes.
  • Payroll: Recibos de nómina.

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)

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
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": "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)

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)

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)

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)

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)

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)

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

Responses

Response samples

Content type
application/json
Example
{
  • "message": "Carta Libranza OCR completed successfully",
  • "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)

Responses

Response samples

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

Credit Report Async

Async version of credit report endpoint. Use this when processing might take > 60 seconds. Results will be sent to the callback_url via webhook.

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

Responses

Response samples

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

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)

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)

Responses

Response samples

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

Constitutive Act

Authorizations:
APIKeyHeader
Request Body schema: application/x-www-form-urlencoded
Password (string) or Password (null) (Password)
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 act information extracted",
  • "data": {
    }
}

Constitutive Act Async

Async version of constitutive act endpoint. Use this when processing might take > 60 seconds. Results will be sent to the callback_url via webhook.

Authorizations:
APIKeyHeader
Request Body schema: application/x-www-form-urlencoded
callback_url
required
string (Callback Url)
Password (string) or Password (null) (Password)
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
{
  • "message": "Success",
  • "data": {
    },
  • "error": "string",
  • "error_type": "INVALID_REQUEST"
}

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)

Responses

Response samples

Content type
application/json
Example
{
  • "message": "ID OCR completed",
  • "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)

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)

Responses

Response samples

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

JOIN US ON

facebooktwitterLinkedIn
AVISOS DE PRIVACIDADClientesProveedoresTrabajadoresUsuarios
POLÍTICASSeguridad de la informaciónTransferencia de datosPolítica disciplinaria
CONTACThello@rem.tools55-91-03-80-54
© Copyright rem 2022 All rights reserved.