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.com
aapi.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
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/owners/{id}/
- Sandbox
https://sandbox.belvo.com/api/owners/{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/owners/{id}/?omit=string&fields=string'
De acuerdo
Identificador único de Belvo para el elemento actual.
El link.id
al que pertenecen los datos.
El identificador interno de la institución para el propietario.
La marca de tiempo ISO-8601 cuando se recopiló el punto de datos.
La marca de tiempo ISO-8601 de cuando se creó el punto de datos en la base de datos de Belvo.
El nombre completo del individuo, tal como lo proporciona la institución.
No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.
El nombre social del individuo, tal como es generalmente aceptado por el país.
La fecha de nacimiento del individuo, en formato YYYY-MM-DD
.
No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.
El estado civil del individuo. Devolvemos uno de los siguientes valores:
SINGLE
MARRIED
WIDOWED
SEPARATED
DIVORCED
CIVIL_UNION
OTHER
Información adicional sobre el estado civil del individuo.
El género del individuo. Devolvemos uno de los siguientes valores:
FEMALE
MALE
OTHER
Las instituciones responsables de la creación y verificación del propietario.
No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.
Boolean para indicar si el individuo es residente local del país.
No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.
Información sobre el documento de identificación que el propietario proporcionó al banco.
Non-nullable: La red de finanzas abiertas de Brasil debe devolver un valor.
El tipo de documento que el propietario proporcionó a la institución para abrir la cuenta. Los tipos de documentos comunes son:
🇧🇷 Brasil
CPF
(Cadastro de Pessoas Físicas)CNPJ
(Cadastro Nacional de Pessoas Jurídicas)
Non-nullable: La red de finanzas abiertas de Brasil debe devolver un valor.
Información detallada sobre documentos adicionales proporcionados para verificar la identidad de las personas.
Non-nullable: La red de finanzas abiertas de Brasil debe devolver un valor.
El tipo de documento de identificación. Devolvemos uno de los siguientes valores:
DRIVERS_LICENSE
PASSPORT
ID_CARD
FISCAL_ID
FOREIGNER_REGISTRATION_CARD
OTHER
null
Información adicional sobre el tipo de documento.
Nota: Para documentos de identificación empresarial, este campo debe devolver un valor de la red de finanzas abiertas de Brasil.
El número del documento de identificación.
No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.
El dígito de verificación del documento de identificación.
No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.
La fecha en que se emitió el documento de identificación, en formato YYYY-MM-DD
.
La fecha de vencimiento del documento de identificación, en formato YYYY-MM-DD
.
El código de país de tres letras que emitió el documento (en formato ISO-3166 Alpha 3).
Este campo debe ser devuelto cuando el type
es PASSPORT
.
Información detallada sobre las nacionalidades del individuo.
Solo se requiere devolver cuando is_local_resident
está configurado como false
.
El tipo de documento de identificación. Devolvemos uno de los siguientes valores:
DRIVERS_LICENSE
PASSPORT
ID_CARD
FISCAL_ID
FOREIGNER_REGISTRATION_CARD
OTHER
null
El número del documento de identificación.
No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.
La fecha en que se emitió el documento de identificación, en formato YYYY-MM-DD
.
La fecha de vencimiento del documento de identificación, en formato YYYY-MM-DD
.
El código de país de tres letras que emitió el documento (en formato ISO-3166 Alpha 3).
Este campo debe ser devuelto cuando el type
es PASSPORT
.
La dirección de correo electrónico registrada del propietario de la cuenta.
No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.
Lista adicional de correos electrónicos proporcionada por el propietario.
No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.
Boolean para indicar si este es el correo electrónico principal del usuario.
No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.
La dirección registrada del propietario de la cuenta.
No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.
Información detallada sobre las direcciones del propietario.
No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.
Boolean para indicar si esta es la dirección principal del usuario.
No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.
La dirección del usuario.
No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.
Información adicional sobre la dirección del usuario.
El distrito de la dirección.
La ciudad del usuario.
No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.
El código de siete dígitos para la ciudad, si corresponde.
Para Brasil, este es el código de ciudad del IBGE.
El estado en el que se encuentra la dirección.
El código postal de la dirección.
No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.
El nombre del país.
No anulable: Se debe devolver un valor por la red de finanzas abiertas de Brasil.
El código de país de tres letras (cumple con ISO-3166 Alpha 3).
La coordenada de latitud geográfica.
El número de teléfono registrado del propietario de la cuenta.
No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.
Información detallada sobre los números de teléfono del propietario.
No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.
Boolean para indicar si este es el número de teléfono principal del usuario.
No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.
El tipo de número de teléfono. Devolvemos uno de los siguientes valores:
LANDLINE
MOBILE
OTHER
null
Información adicional sobre el número de teléfono.
El número de teléfono (sin incluir los códigos de país, área o extensión).
No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.
El código de marcación del país. Por ejemplo: 351
(sin +
).
El código de marcación de área.
Información sobre cualquier relación familiar del individuo.
No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.
La relación familiar. Devolvemos uno de los siguientes valores:
MOTHER
FATHER
null
El nombre completo de la persona.
No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.
Información sobre el perfil financiero del individuo.
El identificador de la empresa donde está empleado el individuo.
El área de empleo del individuo. Devolvemos uno de los siguientes valores:
BRAZIL_PUBLIC_OFFICE
BRAZIL_OCCUPATION_CODE
OTHER
null
Información sobre la ocupación del individuo.
Información sobre los ingresos reportados del individuo.
No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.
Indica con qué frecuencia el individuo recibe su salario. Devolvemos uno de los siguientes valores:
DAILY
WEEKLY
FORTNIGHTLY
MONTHLY
BIMONTHLY
QUARTERLY
BIANNUALLY
ANNUALLY
OTHERS
El ingreso reportado que recibe el individuo.
No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.
El código de moneda de tres letras (ISO-4217).
No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.
Información sobre los activos reportados del individuo (si están disponibles).
Los activos reportados del individuo.
No anulable: Se debe devolver un valor por la red de finanzas abiertas de Brasil cuando el objeto
patrimony
está disponible.
El código de moneda de tres letras (ISO-4217).
No anulable: La red de finanzas abiertas de Brasil debe devolver un valor cuando el objeto
patrimony
está disponible.
Detalles sobre cualquier relación adicional que la persona tenga con la institución (por ejemplo, otras cuentas o productos que tenga con la institución).
La marca de tiempo ISO-8601 cuando comenzó la relación financiera entre el individuo y la institución.
No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.
Una lista de productos que el individuo tiene con la institución.
No anulable: La red de finanzas abiertas de Brasil debe devolver un valor.
Información adicional sobre los productos que tiene la persona.
Información sobre cualquier individuo o empresa que pueda actuar en nombre del propietario.
El tipo de representante que puede acceder y realizar cambios en la cuenta. Devolvemos uno de los siguientes valores:
LEGAL_REPRESENTATIVE
ATTORNEY
null
El nombre completo de los representantes.
No anulable: Se debe devolver un valor por la red de finanzas abiertas de Brasil si el campo
procurators
está disponible.
El nombre social de la persona.
El número de documento del representante.
Nota: Para individuos, este es el número de CPF de Brasil. Para empresas, este es el número de CNPJ de Brasil.
Non-nullable: Se debe devolver un valor por la red de finanzas abiertas de Brasil si el campo
procurators
está disponible.
Detalles sobre cualquier producto adicional que la persona tenga con la institución.
Los productos adicionales que el individuo tiene en la institución. Devolvemos uno de los siguientes valores:
SAVINGS_ACCOUNT
CHECKING_ACCOUNT
null
El subtipo del producto que el individuo tiene en la institución.
No anulable: Se debe devolver un valor por la red de finanzas abiertas de Brasil si el campo
products
está disponible.
El código de sucursal donde se abrió el producto.
El código de compensación bancaria para el producto.
No anulable: Se debe devolver un valor por la red de finanzas abiertas de Brasil si el campo
products
está disponible.
El número de cuenta del producto.
No anulable: Se debe devolver un valor por la red de finanzas abiertas de Brasil si el campo
procurators
está disponible.
Detalles sobre cualquier solicitud de portabilidad de salario que el individuo haya realizado con la institución.
Una portabilidad de salario es una solicitud para transferir el salario del individuo desde la cuenta bancaria de 'nómina' de su empleador a otra cuenta bancaria.
📘
Tenga en cuenta que la cuenta bancaria receptora no puede terminar una portabilidad de salario (o ser informada de que ha sido terminada). Solo el banco de nómina del empleador puede proporcionar esta información. Por lo tanto, las portabilidades enumeradas aquí pueden no estar actualizadas.
Detalles sobre cualquier cuenta bancaria de nómina asociada con el individuo. Es decir, cada vez que el individuo tenga un nuevo empleador del cual reciba un salario, debe estar listado aquí.
📘
Los empleadores anteriores pueden no cerrar la cuenta de nómina del individuo. Por lo tanto, las cuentas de nómina listadas aquí pueden no estar actualizadas.
Ejemplo de un individuo (OFDA Brasil).
{ "id": "c749315b-eec2-435d-a458-06912878564f", "link": "30cb4806-6e00-48a4-91c9-ca55968576c8", "internal_identification": "7e5838e4", "collected_at": "2019-09-27T13:01:41.941Z", "created_at": "2022-02-09T08:45:50.406032Z", "display_name": "Jack Oswald White", "social_name": "O Piadista", "birth_date": "1988-07-15", "marital_status": "SINGLE", "marital_status_additional_info": "It's complicated", "gender": "MALE", "companies_id": [ "01773247000103" ], "is_local_resident": true, "document_id": { "document_type": "CPF", "document_number": "235578435-S" }, "additional_documents": [ { … } ], "nationalities": [ { … } ], "email": "johndoe@belvo.com", "emails": [ { … } ], "address": "Carrer de la Llacuna, 162, 08018 Barcelona", "addresses": [ { … } ], "phone_number": "+52-XXX-XXX-XXXX", "phone_numbers": [ { … } ], "filiations": [ { … } ], "financial_profile": { "company_id": "50685362000135", "occuptation_code": "BRAZIL_OCCUPATION_CODE", "occupation_description": "01", "informed_income": { … }, "patrimony": { … } }, "financial_relation": { "start_date": "2021-05-21T08:30:00Z", "product_services": [ … ], "product_services_additional_info": "Joint account with Robin", "procurators": [ … ], "products": [ … ] } }
- Mock server
https://developers.belvo.com/_mock/es/apis/belvoopenapispec/api/owners/{id}/
- Sandbox
https://sandbox.belvo.com/api/owners/{id}/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
-u <username>:<password> \
'https://developers.belvo.com/_mock/es/apis/belvoopenapispec/api/owners/{id}/'
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)
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_type
en el arrayform_fields
, debes enviar este valor en tu solicitud PATCH.