Documentación de la API de Belvo (1.222.0)
Alcanza nuevas audiencias y convierte más usuarios conectándote fácil y seguramente a sus datos financieros, entendiendo su comportamiento y habilitando pagos instantáneos con finanzas abiertas. A través de nuestra API, puedes acceder a:
Belvo es una API de banca abierta para América Latina que permite a las empresas acceder a información bancaria y fiscal de manera segura y ágil.
A través de nuestra API, puedes acceder a:
- Información Bancaria en Brasil
- Información Laboral en Brasil
- Información Laboral en México
- Información Fiscal en México
- Información Fiscal en Chile
También puedes usar nuestra API para realizar pagos en:
- Brasil
- México
Si deseas la documentación de respuesta en formato Excel o CSV, por favor descárgalos desde nuestro Repositorio Público de GitHub: Diccionarios de Datos de Belvo Open Finance.
Nuestros archivos EXCEL y CSV están adicionalmente localizados en español y portugués (Brasil).
Disponible para:
- 🟢 Agregación y Enriquecimiento
- ⚪️ Iniciación de Pagos
Usa nuestro entorno Sandbox para construir tu integración. Ofrecemos datos ficticios que imitan casos de uso del mundo real, lo que significa que puedes probar todos los endpoints, usar el widget e implementar webhooks, tal como lo harías con datos reales.
Todo lo que necesitas para comenzar con el entorno Sandbox es obtener tus claves API. Realmente recomendamos que comiences creando tu integración en este entorno.
Disponible para:
- 🟢 Agregación y Enriquecimiento
- 🟢 Iniciación de Pagos
Después de haber probado tu integración en el entorno Sandbox y estar listo para ir en vivo, necesitarás solicitar acceso a nuestro entorno de Producción. Después de solicitar acceso, nuestro equipo de ventas se pondrá en contacto contigo para programar una reunión solo para asegurarse de que se cumplan tus necesidades, y luego solo necesitarás pasar por un proceso de certificación con uno de nuestros ingenieros para asegurarte de que tu integración esté funcionando de manera óptima. Para prepararte para la reunión de certificación, solo sigue nuestra lista de verificación de integración.
Una vez que tu integración esté certificada, todo lo que necesitarás hacer es:
- Solicitar claves API de Producción (y cambiar tus claves API de Sandbox en el código por estas nuevas).
- Cambiar la URL base a la que haces solicitudes de
sandbox.belvo.comaapi.belvo.com. - Si estás usando webhooks, asegúrate de establecer una URL de Producción para tus webhooks.
Usamos el siguiente código de estado HTTP en la respuesta dependiendo del éxito o fracaso:
| Código de Estado | Descripción |
|---|---|
200 | ✅ Éxito - El contenido está disponible en el cuerpo de la respuesta. |
201 | ✅ Éxito - El contenido fue creado exitosamente en Belvo. |
204 | ✅ Éxito - No hay contenido para devolver. |
400 | ❌ Error de Solicitud Incorrecta - La solicitud devolvió un error, detalle en el contenido. |
401 | ❌ No Autorizado - Las credenciales de Belvo proporcionadas no son válidas. |
404 | ❌ No Encontrado - El recurso al que intentas acceder no se puede encontrar. |
405 | ❌ Método No Permitido - El método HTTP que estás usando no es aceptado para este recurso. |
408 | ❌ Tiempo de Solicitud Agotado - La solicitud se agotó y fue terminada por el servidor. |
428 | ❌ Se Requiere Token MFA - La institución requirió un token MFA para conectar. |
500 | ❌ Error Interno del Servidor - El detalle del error está disponible en el cuerpo de la respuesta. |
Los errores de la API de Belvo se devuelven en formato JSON. Por ejemplo, un error podría verse así:
[
{
"request_id": "a6e1c493d7a29d91aed4338e6fcf077d",
"message": "Este campo es obligatorio.",
"code": "required",
"field": "link"
}
]Típicamente, una respuesta de error tendrá los siguientes parámetros:
request_id: un ID único para la solicitud, debes compartirlo con el equipo de soporte de Belvo para investigaciones.message: descripción del error en lenguaje humano.code: un código único para el error. Consulta la tabla a continuación para ver cómo manejar cada código de error.field(opcional): El campo específico en el cuerpo de la solicitud que tiene un problema.
Cuando necesites ayuda con un error específico, incluye el identificador de solicitud (request_id) en tu mensaje al equipo de soporte de Belvo. Esto acelerará las investigaciones y te permitirá volver a funcionar en poco tiempo.
Para una lista completa de errores y cómo solucionarlos, por favor consulta nuestro artículo dedicado Manejo de Errores.
Implementa un retroceso exponencial automatizado de hasta cinco reintentos. Recomendamos usar un intervalo base de tres segundos con un factor de dos. Por ejemplo, el primer reintento debe ser después de tres segundos, el segundo reintento después de seis segundos (2 * 3), el tercer reintento después de 12 segundos (2 * 6), el cuarto reintento después de 24 segundos (2 * 12), y el quinto reintento después de 48 segundos (2 * 24).
No debes reintentar hacer solicitudes si recibes una respuesta 40x, ya que esto es un error del cliente.
La única excepción es el error de "Demasiadas Sesiones", ya que significa que tu usuario final está accediendo a la cuenta desde otro navegador al mismo tiempo. En este caso, por favor implementa la misma política de reintentos que con los errores 50x.
En nuestro esquema, puedes ver que un campo ha sido marcado como deprecated. Esto significa que este campo ya no es mantenido por el equipo de Belvo. Aún puedes recibir datos para este campo dependiendo de la institución, sin embargo, no debes confiar en este campo.
En nuestra especificación de API, verás que algunos parámetros de respuesta tendrán una anotación de required. Según la especificación de OpenAPI, cuando un parámetro de respuesta está marcado como required, esto significa que la clave de respuesta debe ser devuelta. Sin embargo, el valor de ese parámetro de respuesta puede ser null.
📘 Info
En resumen, cualquier parámetro de respuesta marcado como requerido será devuelto por nuestra API, pero el valor puede ser establecido en null.
https://developers.belvo.com/_mock/es/apis/belvoopenapispec/
https://sandbox.belvo.com/
Institutions
Una institución es una entidad de la que Belvo puede acceder a información. Puede ser una:
- institución bancaria, como Nubank Brasil.
- institución fiscal, como el Servicio de Administración Tributaria (SAT) en México.
- institución de empleo, como el Instituto Mexicano del Seguro Social (IMSS) en México o el Instituto Nacional do Seguro Social (INSS) en Brasil.
Links
Un Link es un conjunto de credenciales asociadas al acceso de un usuario final a una institución. Necesitarás registrar un Link antes de acceder a la información de ese usuario final específico, como los detalles de cuenta o transacciones.
Recomendamos usar el Belvo Hosted Widget para gestionar el proceso de conexión.
Owners
Un owner representa a la persona que tiene acceso a un Link y es el propietario de todas las cuentas dentro del Link.
Puedes usar este endpoint para obtener información útil sobre tu cliente, como:
- su nombre completo
- información de contacto clave
- información sobre el documento de identificación que usaron al abrir la cuenta
Accounts
Una cuenta es la representación de una cuenta bancaria dentro de una institución financiera. Un usuario puede tener una o más cuentas en una institución.
Por ejemplo, un usuario (o enlace) puede tener una cuenta corriente, varias tarjetas de crédito y una cuenta de préstamo.
Consultar la información de la cuenta de un usuario es útil ya que puedes obtener información sobre:
- qué tipos de cuentas tiene el usuario.
- el saldo de cada cuenta (ahorros, cuenta corriente, tarjeta de crédito, préstamo, etc.).
- información detallada sobre sus gastos con tarjeta de crédito.
- la situación actual de cualquier préstamo que puedan tener.
Employments Brazil
Nuestro recurso de empleos para Brasil te permite obtener una vista completa del historial laboral actual de tu usuario y la información salarial.
Para cada usuario, proporcionamos:
- historial laboral (incluyendo ocupaciones y datos del empleador)
- información salarial histórica y actual (por empleador)
En este momento, el recurso de empleos está disponible para:
- 🇧🇷 Brasil (INSS)
Employment Records Mexico
Nuestro recurso de registros de empleo para México te permite obtener una visión completa de las contribuciones actuales al seguro social y el historial laboral de tu usuario.
Con el recurso de registros de empleo de Belvo para México, puedes acceder a información sobre las contribuciones actuales al seguro social y el historial laboral de tu usuario. Para cada usuario, proporcionamos:
- datos personales
- historial laboral
- salario base diario histórico y actual
- ¡y más!
En este momento, el recurso de registros de empleo está disponible para:
- 🇲🇽 México (IMSS)
- 🇲🇽 México (ISSSTE)
Solicitud
▶️ Uso
Con el método List Employment Records, puedes:
- Listar registros de empleo relacionados con un
link.idespecífico (usando el parámetro de consultalink). - Obtener los detalles de un
employment-record.idespecífico (usando el parámetro de consultaid). - [No Recomendado] Listar todos los registros de empleo relacionados con tu cuenta de Belvo (sin usar ningún parámetro de consulta).
📖 Paginación
Este método devuelve una respuesta paginada (por defecto: 100 elementos por página). Puedes usar el parámetro de consulta page_size para aumentar el número de elementos devueltos hasta un máximo de 1000 elementos. Puedes usar el parámetro de consulta page para navegar a través de los resultados. Para más detalles sobre cómo navegar por las respuestas paginadas de Belvo, consulta nuestro artículo Consejos de Paginación.
🔦 Filtrado de Respuestas
Consulta la lista de campos a continuación para ver los campos por los que puedes filtrar tus respuestas. Para más información sobre cómo usar filtros, consulta nuestro artículo Filtrado de respuestas.
El link.id por el que deseas filtrar.
ℹ️ Recomendamos encarecidamente añadir el filtro link.id para mejorar tu rendimiento.
Indica cuántos resultados devolver por página. Por defecto, devolvemos 100 resultados por página.
ℹ️ El número mínimo de resultados devueltos por página es 1 y el máximo es 1000. Si introduces un valor mayor que 1000, nuestra API usará por defecto el valor máximo (1000).
Un número de página dentro del conjunto de resultados paginados.
Omite ciertos campos para que no se devuelvan en la respuesta. Para más información, consulta nuestro artículo del DevPortal Filtrando respuestas.
Devuelve solo los campos especificados en la respuesta. Para obtener más información, consulta nuestro artículo del DevPortal Filtrando respuestas.
Devuelve información solo para este recurso id.
Devuelve información para estos ids de recursos.
Devuelve resultados solo para estos link.ids.
El internal_identification por el que deseas filtrar.
Uno o más internal_identifications por los que deseas filtrar.
Devuelve los elementos que fueron recuperados de la institución en esta fecha (YYYY-MM-DD o marca de tiempo completa ISO-8601).
Devuelve los elementos que fueron recuperados de la institución después de esta fecha (YYYY-MM-DD o marca de tiempo completa en formato ISO-8601).
Devolver los elementos que fueron recuperados de la institución en o después de esta fecha (YYYY-MM-DD o marca de tiempo completa ISO-8601).
Devolver los elementos que fueron recuperados de la institución antes de esta fecha (YYYY-MM-DD o marca de tiempo completa ISO-8601).
Devuelve los elementos que fueron recuperados de la institución en o antes de esta fecha (YYYY-MM-DD o marca de tiempo completa ISO-8601).
Devolver los elementos que fueron recuperados de la institución entre dos fechas (YYYY-MM-DD o una marca de tiempo completa en formato ISO-8601).
Devuelve los elementos que se actualizaron por última vez en la base de datos de Belvo en esta fecha (en formato YYYY-MM-DD).
Devuelve los elementos que se actualizaron por última vez en la base de datos de Belvo después de esta fecha (en formato YYYY-MM-DD).
Devuelve los elementos que se actualizaron por última vez en la base de datos de Belvo después o en esta fecha (en formato YYYY-MM-DD).
Devuelve los elementos que se actualizaron por última vez en la base de datos de Belvo antes de esta fecha (en formato YYYY-MM-DD).
Devuelve los elementos que se actualizaron por última vez en la base de datos de Belvo antes o en esta fecha (en formato YYYY-MM-DD).
- Mock server
https://developers.belvo.com/_mock/es/apis/belvoopenapispec/api/employment-records/
- Sandbox
https://sandbox.belvo.com/api/employment-records/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://developers.belvo.com/_mock/es/apis/belvoopenapispec/api/employment-records/?link=8848bd0c-9c7e-4f53-a732-ec896b11d4c4&page_size=100&page=1&omit=string&fields=string&id=24ccab1d-3a86-4136-a6eb-e04bf52b356f&id__in=6b3dea0f-be29-49d1-aabe-1a6d588642e6&link__in=5722d0ba-69d7-42dc-8ff5-33767b83c5d6&internal_identification=BLPM951331IONVGR54&internal_identification__in=BLPM951331IONVGR54&collected_at=2022-05-01&collected_at__gt=2022-05-05&collected_at__gte=2022-05-04&collected_at__lt=2022-04-01&collected_at__lte=2022-03-30&collected_at__range=2022-05-04&created_at=2022-05-05&created_at__gt=2022-05-05&created_at__gte=2022-05-04&created_at__lt=2022-04-01&created_at__lte=2022-03-30&created_at__range=2022-03-03'De acuerdo
La URL a la siguiente página de resultados. Cada página consta de hasta 100 elementos. Si no hay suficientes resultados para una página adicional, el valor es null.
En nuestro ejemplo de documentación, usamos {endpoint} como un valor de marcador de posición. En producción, este valor será reemplazado por el endpoint real que estás utilizando actualmente (por ejemplo, accounts o owners).
La URL a la página anterior de resultados. Si no hay una página anterior, el valor es null.
Ejemplo de una respuesta paginada del IMSS.
{ "count": 20, "next": "https://sandbox.belvo.com/api/employment-records/?page=2", "previous": null, "results": [ { … } ] }
Omite ciertos campos para que no se devuelvan en la respuesta. Para más información, consulta nuestro artículo del DevPortal Filtrando respuestas.
Devuelve solo los campos especificados en la respuesta. Para obtener más información, consulta nuestro artículo del DevPortal Filtrando respuestas.
Parámetro de encabezado recomendado para hacer que tu solicitud POST sea asincrónica (evitando así tiempos de espera y mejorando el flujo de datos).
Cuando realizas una solicitud asincrónica, Belvo responde con un payload 202 - Accepted, que incluye el request_id. Una vez que hayamos recuperado la información solicitada, recibirás un webhook con el enlace y los IDs de solicitud.
El link.id para el que deseas recuperar información.
Cuando se establece en true, recibirás el PDF en formato binario en la respuesta.
- Mock server
https://developers.belvo.com/_mock/es/apis/belvoopenapispec/api/employment-records/
- Sandbox
https://sandbox.belvo.com/api/employment-records/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
'https://developers.belvo.com/_mock/es/apis/belvoopenapispec/api/employment-records/?omit=string&fields=string' \
-H 'Content-Type: application/json' \
-H 'X-Belvo-Request-Mode: async' \
-d '{
"link": "c81a1dea-6dd6-4999-8b9f-541ee8197058",
"attach_pdf": true,
"save_data": true
}'De acuerdo
Identificador único de Belvo para el elemento actual.
El link.id al que pertenecen los datos.
La marca de tiempo ISO-8601 de cuando se creó el punto de datos en la base de datos de Belvo.
La marca de tiempo ISO-8601 cuando se recopiló el punto de datos.
La fecha en que se generó el informe del registro de empleo, en formato YYYY-MM-DD.
ID único para el usuario según la institución. Para IMSS e ISSSTE México, este es el CURP.
Detalles sobre las contribuciones al seguro social del individuo, de acuerdo con el IMSS.
Nota: Para ISSSTE México, este valor devolverá
null.
Un array de puntuaciones de employment_record. Cada puntuación proporciona una visión sobre la empleabilidad y el potencial de generación de ingresos en un período determinado.
Nota 1: Este campo solo está disponible para enlaces creados con el IMSS de México. Para otras instituciones, este campo devolverá
null.
Nota 2: Este campo devolverá
nullpara los registros de empleo recuperados antes del 16-04-2024. Para los registros de empleo generados antes del 16-04-2024, necesitarás hacer una nueva solicitud POST para recuperar los registros de empleo y calcular las puntuaciones.
Archivos binarios PDF adicionales relacionados con el empleo del individuo.
Ejemplo de una respuesta del IMSS.
[ { "id": "fef05fc8-7357-4a4a-9d29-55038ea31a04", "link": "27c1d5cf-e8fb-433a-a2f7-d246de199c01", "created_at": "2022-02-09T08:45:50.406032Z", "collected_at": "2022-02-09T08:45:50.406032Z", "report_date": "2023-01-19", "internal_identification": "BLPM951331IONVGR54", "personal_data": { … }, "social_security_summary": { … }, "employment_records": [ … ], "employment_scores": [ … ], "files": [ … ] } ]
Omite ciertos campos para que no se devuelvan en la respuesta. Para más información, consulta nuestro artículo del DevPortal Filtrando respuestas.
Devuelve solo los campos especificados en la respuesta. Para obtener más información, consulta nuestro artículo del DevPortal Filtrando respuestas.
- Mock server
https://developers.belvo.com/_mock/es/apis/belvoopenapispec/api/employment-records/{id}/
- Sandbox
https://sandbox.belvo.com/api/employment-records/{id}/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://developers.belvo.com/_mock/es/apis/belvoopenapispec/api/employment-records/{id}/?omit=string&fields=string'De acuerdo
Identificador único de Belvo para el elemento actual.
El link.id al que pertenecen los datos.
La marca de tiempo ISO-8601 de cuando se creó el punto de datos en la base de datos de Belvo.
La marca de tiempo ISO-8601 cuando se recopiló el punto de datos.
La fecha en que se generó el informe del registro de empleo, en formato YYYY-MM-DD.
ID único para el usuario según la institución. Para IMSS e ISSSTE México, este es el CURP.
Detalles sobre las contribuciones al seguro social del individuo, de acuerdo con el IMSS.
Nota: Para ISSSTE México, este valor devolverá
null.
Un array de puntuaciones de employment_record. Cada puntuación proporciona una visión sobre la empleabilidad y el potencial de generación de ingresos en un período determinado.
Nota 1: Este campo solo está disponible para enlaces creados con el IMSS de México. Para otras instituciones, este campo devolverá
null.
Nota 2: Este campo devolverá
nullpara los registros de empleo recuperados antes del 16-04-2024. Para los registros de empleo generados antes del 16-04-2024, necesitarás hacer una nueva solicitud POST para recuperar los registros de empleo y calcular las puntuaciones.
Ejemplo de una respuesta del IMSS.
{ "id": "fef05fc8-7357-4a4a-9d29-55038ea31a04", "link": "27c1d5cf-e8fb-433a-a2f7-d246de199c01", "created_at": "2022-02-09T08:45:50.406032Z", "collected_at": "2022-02-09T08:45:50.406032Z", "report_date": "2023-01-19", "internal_identification": "BLPM951331IONVGR54", "personal_data": { "official_name": "Bruce Banner del Torro", "first_name": "Bruce", "last_name": "Banner del Torro", "email": "bruce.banner@avengers.com", "birth_date": "2022-02-09", "entitlements": { … }, "document_ids": [ … ] }, "social_security_summary": { "weeks_redeemed": 0, "weeks_reinstated": 0, "weeks_contributed": 188 }, "employment_records": [ { … } ], "employment_scores": [ { … }, { … }, { … } ], "files": [ { … } ] }
Current Employments Mexico
El recurso de Empleos Actuales proporciona acceso en tiempo real al estado de empleo actual de individuos en México. Este recurso ofrece información detallada sobre si una persona está actualmente empleada o desempleada, junto con sus registros de empleo activos.
Incomes
Utiliza el endpoint de Incomes para obtener información sobre las fuentes de ingresos de una cuenta en los últimos 365 días. Este endpoint es particularmente útil cuando deseas verificar los ingresos de una persona.
📘 Información
El recurso de incomes está solo disponible para cuentas de Checking y Savings asociadas con enlaces bancarios.
Recurring Expenses
La API de Gastos Recurrentes de Belvo te permite identificar los pagos regulares de un usuario para servicios de suscripción, como Netflix o membresías de gimnasio, así como pagos de servicios públicos, como facturas de electricidad o teléfono. Devolvemos información de hasta 365 días.
📘 Info
El recurso de gastos recurrentes está solo disponible para cuentas de Cheques, Ahorros y Tarjetas de Crédito asociadas con enlaces bancarios.
Bank Accounts (Brazil)
Para recibir pagos entrantes en la cuenta bancaria de su organización, debe registrar las cuentas bancarias (individuales y empresariales) utilizando la Payments API de Belvo.
- Las cuentas bancarias individuales deben ser creadas para cada pagador (su cliente).
- Las cuentas bancarias empresariales deben ser creadas para el beneficiario del pago (su organización).
Payment Intents (Brazil)
Un payment intent es un punto único de acceso para crear pagos utilizando cualquier método de pago ofrecido por Belvo.
Un payment intent captura toda la información del pago (como el monto a cobrar, la descripción del pago, el proveedor, etc.) y guía a tus clientes a través del flujo de pago.
Nota: Para las instituciones que requieren el
username_typeen el arrayform_fields, debes enviar este valor en tu solicitud PATCH.