Documentación de la API de Belvo (1.222.0)

Introducción

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:

Información Disponible y Métodos de Pago

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

Diccionarios de Datos

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).

Entornos

Actualmente ofrecemos dos entornos: sandbox y producción.

Sandbox

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.

Producción

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 a api.belvo.com.
Si estás usando webhooks, asegúrate de establecer una URL de Producción para tus webhooks.

Códigos de Respuesta

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.

Manejo de Errores

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.

Identificador de Solicitud

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.

Códigos de Error y Solución de Problemas

Para una lista completa de errores y cómo solucionarlos, por favor consulta nuestro artículo dedicado Manejo de Errores.

Política de Reintentos

Errores 50x

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).

Errores 40x

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.

Campos Obsoletos

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.

OpenAPI: campos requeridos y anulables

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.

Descargar el archivo de descripción OpenAPI

BelvoOpenApiSpec.json

BelvoOpenApiSpec.yaml

Resumen

URL

https://developers.belvo.com

Need help?

support@belvo.com

Servidores

Mock server

https://developers.belvo.com/_mock/es/apis/belvoopenapispec/

Sandbox

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.

Operaciones

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.

Operaciones

Consents

Un consentimiento es un permiso otorgado por el usuario final para acceder a sus datos financieros en la Red de Finanzas Abiertas en Brasil.

Operaciones

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

Operaciones

Obtener los detalles de un propietario

Solicitud

Obtener los detalles de un propietario específico.

Este recurso puede devolver campos obsoletos. Por favor, consulte la documentación de la respuesta para más información.

Seguridad

basicAuth

Ruta

idstring(uuid)requerido

El owner.id sobre el cual deseas obtener información detallada.

Consulta

omitstring

Omite ciertos campos para que no se devuelvan en la respuesta. Para más información, consulta nuestro artículo del DevPortal Filtrando respuestas.

fieldsstring

Devuelve solo los campos especificados en la respuesta. Para obtener más información, consulta nuestro artículo del DevPortal Filtrando respuestas.

curl -i -X GET \
  -u <username>:<password> \
  'https://developers.belvo.com/_mock/es/apis/belvoopenapispec/api/owners/{id}/?omit=string&fields=string'

Respuestas

De acuerdo

Cuerpoapplication/json

One of:

idstring(uuid)requerido

Identificador único de Belvo para el elemento actual.

Ejemplo: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"

linkstring or null(uuid)requerido

El link.id al que pertenecen los datos.

Ejemplo: "30cb4806-6e00-48a4-91c9-ca55968576c8"

internal_identificationstring or nullrequerido

El identificador interno de la institución para el propietario.

Ejemplo: "7e5838e4"

collected_atstring(date-time)requerido

La marca de tiempo ISO-8601 cuando se recopiló el punto de datos.

Ejemplo: "2022-02-09T08:45:50.406032Z"

created_atstring(date-time)requerido

La marca de tiempo ISO-8601 de cuando se creó el punto de datos en la base de datos de Belvo.

Ejemplo: "2022-02-09T08:45:50.406032Z"

display_namestring<= 128 characters^[\w\W]{0,128}$requerido

El nombre completo del individuo, tal como lo proporciona la institución.

Ejemplo: "Jack Oswald White"

social_namestring or null<= 128 characters^[\w\W]{0,128}$requerido

El nombre social del individuo, tal como es generalmente aceptado por el país.

Ejemplo: "O Piadista"

birth_datestring(date)<= 10 characters^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?...requerido

La fecha de nacimiento del individuo, en formato YYYY-MM-DD.

Ejemplo: "1988-07-15"

marital_statusstring or nullrequerido

El estado civil del individuo. Devolvemos uno de los siguientes valores:

SINGLE
MARRIED
WIDOWED
SEPARATED
DIVORCED
CIVIL_UNION
OTHER

Enum"SINGLE""MARRIED""WIDOWED""SEPARATED""DIVORCED""CIVIL_UNION""OTHER"

Ejemplo: "SINGLE"

marital_status_additional_infostring or null<= 50 characters^[\w\W]{0,50}$requerido

Información adicional sobre el estado civil del individuo.

Ejemplo: "It's complicated"

genderstring or nullrequerido

El género del individuo. Devolvemos uno de los siguientes valores:

FEMALE
MALE
OTHER

Enum"FEMALE""MALE""OTHER"

Ejemplo: "FEMALE"

companies_idArray of stringsnon-emptyrequerido

Las instituciones responsables de la creación y verificación del propietario.

Ejemplo: ["01773247000103"]

is_local_residentbooleanrequerido

Boolean para indicar si el individuo es residente local del país.

Ejemplo: true

document_idobjectrequerido

Información sobre el documento de identificación que el propietario proporcionó al banco.

document_typestringrequerido

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)

Ejemplo: "CPF"

document_numberstringrequerido

El número de identificación del documento.

Ejemplo: "235578435-S"

additional_documentsArray of objects or nullnon-emptyrequerido

Información detallada sobre documentos adicionales proporcionados para verificar la identidad de las personas.

typestring or nullrequerido

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

Enum"DRIVERS_LICENSE""PASSPORT""ID_CARD""FISCAL_ID""FOREIGNER_REGISTRATION_CARD""OTHER"null

Ejemplo: "DRIVERS_LICENSE"

type_additional_infostring or null<= 70 characters^[\w\W\s]{0,70}$requerido

Información adicional sobre el tipo de documento.

Ejemplo: "Learner's licence"

numberstring<= 40 characters^[\w\W\s]{0,40}$requerido

El número del documento de identificación.

Ejemplo: "DL-7896829-7"

check_digitstring<= 2 characters^[\w\W\s]{0,2}$requerido

El dígito de verificación del documento de identificación.

Ejemplo: "7"

issue_datestring or null(date)<= 10 characters^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?...requerido

La fecha en que se emitió el documento de identificación, en formato YYYY-MM-DD.

Ejemplo: "2019-01-01"

expiration_datestring or null(date)<= 10 characters^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?...requerido

La fecha de vencimiento del documento de identificación, en formato YYYY-MM-DD.

Ejemplo: "2019-01-01"

country_of_issuancestring or null<= 3 characters^[\w]{3}$requerido

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.

Ejemplo: "CAN"

additional_infostring or null<= 100 characters^[\w\W\s]{0,100}$requerido

Información adicional sobre el documento de identificación.

Ejemplo: "The document has water damage"

nationalitiesArray of objects or nullnon-emptyrequerido

Información detallada sobre las nacionalidades del individuo.

Solo se requiere devolver cuando is_local_resident está configurado como false.

infostring or null<= 40 characters^\S[\s\S]*$requerido

La nacionalidad del individuo.

Ejemplo: "CAN"

documentsArray of objects or nullrequerido

typestring or nullrequerido

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

Enum"DRIVERS_LICENSE""PASSPORT""ID_CARD""FISCAL_ID""FOREIGNER_REGISTRATION_CARD""OTHER"null

Ejemplo: "DRIVERS_LICENSE"

numberstring<= 40 characters^[\w\W\s]{0,40}$requerido

El número del documento de identificación.

Ejemplo: "DL-7896829-7"

issue_datestring or null(date)<= 10 characters^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?...requerido

La fecha en que se emitió el documento de identificación, en formato YYYY-MM-DD.

Ejemplo: "2019-01-01"

expiration_datestring or null(date)<= 10 characters^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?...requerido

La fecha de vencimiento del documento de identificación, en formato YYYY-MM-DD.

Ejemplo: "2019-01-01"

country_of_issuancestring or null<= 3 characters^[\w]{3}$requerido

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.

Ejemplo: "CAN"

additional_infostring or null<= 100 characters^[\w\W\s]{0,100}$requerido

Información adicional sobre el documento de identificación.

Ejemplo: "The document has water damage"

emailstring or null(email)<= 320 charactersrequerido

La dirección de correo electrónico registrada del propietario de la cuenta.

Ejemplo: "johndoe@belvo.com"

emailsArray of objects or null>= 0 itemsrequerido

Lista adicional de correos electrónicos proporcionada por el propietario.

is_mainbooleanrequerido

Boolean para indicar si este es el correo electrónico principal del usuario.

Ejemplo: true

emailstring<= 320 characters^[\w\W\s]{0,320}$requerido

La dirección de correo electrónico del usuario.

Ejemplo: "homen_morcego@gmail.com"

addressstring or nullrequerido

La dirección registrada del propietario de la cuenta.

Ejemplo: "Carrer de la Llacuna, 162, 08018 Barcelona"

addressesArray of objects or nullnon-emptyrequerido

Información detallada sobre las direcciones del propietario.

is_mainbooleanrequerido

Boolean para indicar si esta es la dirección principal del usuario.

Ejemplo: true

addressstring<= 150 characters^[\w\W\s]{0,150}$requerido

La dirección del usuario.

Ejemplo: "Av Naburo Ykesaki, 1270"

additional_infostring or null<= 150 characters^[\w\W\s]{0,150}$requerido

Información adicional sobre la dirección del usuario.

Ejemplo: "In between two palm trees"

district_namestring or null<= 50 characters^[\w\W\s]{0,50}$requerido

El distrito de la dirección.

Ejemplo: "CENTRO"

townstring<= 50 characters^[\w\W\s]{0,50}$requerido

La ciudad del usuario.

Ejemplo: "Brasilia"

town_codestring or null<= 7 characters\d{7}$requerido

El código de siete dígitos para la ciudad, si corresponde.

Para Brasil, este es el código de ciudad del IBGE.

Ejemplo: "3550308"

statestring or null<= 2 characters^[\w\W\s]{0,2}$requerido

El estado en el que se encuentra la dirección.

Ejemplo: "SP"

postcodestring<= 8 characters^\d{8}$requerido

El código postal de la dirección.

Ejemplo: "17500001"

country_namestring<= 80 characters^[\w\W\s]{0,80}$requerido

El nombre del país.

Ejemplo: "Brasil"

country_codestring or null<= 3 characters^([A-Z]{3})$requerido

El código de país de tres letras (cumple con ISO-3166 Alpha 3).

Ejemplo: "BRA"

latitudestring or null<= 13 characters^-?\d{1,2}\.\d{1,9}$requerido

La coordenada de latitud geográfica.

Ejemplo: "-23.5475000"

longitudestring or null<= 13 characters^-?\d{1,3}\.\d{1,8}$requerido

La coordenada de longitud geográfica.

Ejemplo: "-46.6361100"

phone_numberstring or nullrequerido

El número de teléfono registrado del propietario de la cuenta.

Ejemplo: "+52-XXX-XXX-XXXX"

phone_numbersArray of objects or null>= 0 itemsrequerido

Información detallada sobre los números de teléfono del propietario.

is_mainbooleanrequerido

Boolean para indicar si este es el número de teléfono principal del usuario.

Ejemplo: true

typestring or nullrequerido

El tipo de número de teléfono. Devolvemos uno de los siguientes valores:

LANDLINE
MOBILE
OTHER
null

Enum"LANDLINE""MOBILE""OTHER"null

Ejemplo: "MOBILE"

additional_infostring or null<= 100 characters^[\w\W\s]{0,100}$requerido

Información adicional sobre el número de teléfono.

Ejemplo: "This is their work mobile number."

numberstring<= 11 characters^([0-9]{8,11})$requerido

El número de teléfono (sin incluir los códigos de país, área o extensión).

Ejemplo: "29875132"

country_codestring or null<= 4 characters^\d{1,4}$requerido

El código de marcación del país. Por ejemplo: 351 (sin +).

Ejemplo: "351"

area_codestring or null<= 2 characters^\d{1,2}$requerido

El código de marcación de área.

Ejemplo: "21"

extensionstring or null<= 5 characters^\d{1,5}$requerido

El código de la extensión.

Ejemplo: "932"

filiationsArray of objectsnon-emptyrequerido

Información sobre cualquier relación familiar del individuo.

typestring or nullrequerido

La relación familiar. Devolvemos uno de los siguientes valores:

MOTHER
FATHER
null

Enum"MOTHER""FATHER"null

Ejemplo: "MOTHER"

civil_namestring<= 70 characters^[\w\W\s]{0,70}$requerido

El nombre completo de la persona.

Ejemplo: "Bruce Wayne"

social_namestring or null<= 70 characters^[\w\W\s]{0,70}$requerido

El nombre social de la persona.

Ejemplo: "The Dark Knight"

financial_profileobject or nullrequerido

Información sobre el perfil financiero del individuo.

company_idstring or null<= 14 characters^\d{14}$requerido

El identificador de la empresa donde está empleado el individuo.

Ejemplo: "50685362000135"

occuptation_codestring or null

El área de empleo del individuo. Devolvemos uno de los siguientes valores:

BRAZIL_PUBLIC_OFFICE
BRAZIL_OCCUPATION_CODE
OTHER
null

Enum"BRAZIL_PUBLIC_OFFICE""BRAZIL_OCCUPATION_CODE""OTHER"null

Ejemplo: "BRAZIL_OCCUPATION_CODE"

occupation_descriptionstring or null<= 100 characters[\w\W\s]*requerido

Información sobre la ocupación del individuo.

Ejemplo: "01"

informed_incomeobjectrequerido

Información sobre los ingresos reportados del individuo.

frequencystring or nullrequerido

Indica con qué frecuencia el individuo recibe su salario. Devolvemos uno de los siguientes valores:

DAILY
WEEKLY
FORTNIGHTLY
MONTHLY
BIMONTHLY
QUARTERLY
BIANNUALLY
ANNUALLY
OTHERS

Enum"DAILY""WEEKLY""FORTNIGHTLY""MONTHLY""BIMONTHLY""QUARTERLY""BIANNUALLY""ANNUALLY""OTHERS"

Ejemplo: "MONTHLY"

amountnumber(float)[ 1 .. 20 ] characters^\d{1,15}\.\d{2,4}$requerido

El ingreso reportado que recibe el individuo.

Ejemplo: 45391.89

currencystring<= 3 characters^[A-Z]{3}$requerido

El código de moneda de tres letras (ISO-4217).

Ejemplo: "BRL"

datestring(date)<= 10 characters^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?...requerido

Fecha en la que el individuo recibió su salario por última vez.

Ejemplo: "2020-03-19"

patrimonyobject or nullrequerido

Información sobre los activos reportados del individuo (si están disponibles).

amountnumber(float)^\d{1,15}\.\d{2,4}$requerido

Los activos reportados del individuo.

Ejemplo: 45391.89

currencystring<= 3 characters^[A-Z]{3}$requerido

El código de moneda de tres letras (ISO-4217).

Ejemplo: "BRL"

yearinteger(int32)[ 1700 .. 2090 ]requerido

El año al que se aplican los activos reportados.

Ejemplo: 2020

financial_relationobject or nullrequerido

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).

start_datestring(date-time)<= 20 characters^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?...requerido

La marca de tiempo ISO-8601 cuando comenzó la relación financiera entre el individuo y la institución.

Ejemplo: "2021-05-21T08:30:00Z"

product_servicesArray of stringsnon-emptyrequerido

Una lista de productos que el individuo tiene con la institución.

Ejemplo: ["CONTA_DEPOSITO_A_VISTA"]

product_services_additional_infostring or null<= 100 characters^[\w\W]*$requerido

Información adicional sobre los productos que tiene la persona.

Ejemplo: "Joint account with Robin"

procuratorsArray of objects or nullrequerido

Información sobre cualquier individuo o empresa que pueda actuar en nombre del propietario.

typestring or nullrequerido

El tipo de representante que puede acceder y realizar cambios en la cuenta. Devolvemos uno de los siguientes valores:

LEGAL_REPRESENTATIVE
ATTORNEY
null

Enum"LEGAL_REPRESENTATIVE""ATTORNEY"null

Ejemplo: "LEGAL_REPRESENTATIVE"

civil_namestring<= 70 characters^[\w\W]*$requerido

El nombre completo de los representantes.

Ejemplo: "Alfred Thaddeus Pennyworth"

social_namestring or null<= 70 characters^[\w\W]*$requerido

El nombre social de la persona.

Ejemplo: "Alfred Pennyworth"

document_numberstring<= 11 characters^\d{11}$requerido

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.

Ejemplo: "73677831148"

productsArray of objects or nullrequerido

Detalles sobre cualquier producto adicional que la persona tenga con la institución.

typestring or nullrequerido

Los productos adicionales que el individuo tiene en la institución. Devolvemos uno de los siguientes valores:

SAVINGS_ACCOUNT
CHECKING_ACCOUNT
null

Enum"SAVINGS_ACCOUNT""CHECKING_ACCOUNT"null

Ejemplo: "SAVINGS_ACCOUNT"

subtypestring or nullrequerido

El subtipo del producto que el individuo tiene en la institución.

Ejemplo: "CONJUNTA_SIMPLES"

agencystring or null<= 4 characters^\d{1,4}$requerido

El código de sucursal donde se abrió el producto.

Ejemplo: "6272"

clearing_codestring<= 3 characters^\d{3}$requerido

El código de compensación bancaria para el producto.

Ejemplo: "001"

numberstring<= 20 characters^\d{8,20}$requerido

El número de cuenta del producto.

Ejemplo: "24550245"

check_digitstring<= 2 characters[\w\W\s]*requerido

El dígito de control del número del producto.

Ejemplo: "7"

salary_portability_requestsArray of objects

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.

payroll_accountsArray of objects

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í.

Respuesta

application/json

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": [ … ]
  }
}

Eliminar un propietario

Solicitud

Eliminar un propietario específico de tu cuenta de Belvo.

Seguridad

basicAuth

Ruta

idstring(uuid)requerido

El owner.id que deseas eliminar.

curl -i -X DELETE \
  -u <username>:<password> \
  'https://developers.belvo.com/_mock/es/apis/belvoopenapispec/api/owners/{id}/'

Respuestas

No hay contenido

Respuesta

Sin contenido

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.

Operaciones

Balances

Un saldo es la cantidad de dinero disponible en una cuenta bancaria determinada (corriente o de ahorros) en un momento dado.

Operaciones

Transactions

Una transacción contiene la información detallada de cada movimiento dentro de una cuenta. Por ejemplo, una compra en una tienda o un restaurante.

Operaciones

Bills

Una bill se refiere a la factura de la tarjeta de crédito que un usuario recibe para una cuenta determinada.

Operaciones

Investments Brazil

Operaciones

Investment Transactions Brazil

Operaciones

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)

Operaciones

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)

Operaciones

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.

Operaciones

Invoices

Operaciones

Tax compliance status

Operaciones

Tax returns

Operaciones

Tax retentions

Operaciones

Tax status

Operaciones

Financial Statements

Operaciones

Invoices Chile

Operaciones

Tax Status Chile

Operaciones

Debt Reports Chile

Operaciones

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.

Operaciones

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.

Operaciones

Risk Insights

Operaciones

Employment Metrics

Operaciones

Payment Institutions (Brazil)

Una institución de pago es una entidad de la que Belvo puede acceder a información. Puedes ver una lista completa de instituciones disponibles para pagos haciendo una solicitud de Lista a este endpoint.

Operaciones

Customers (Brazil)

Un cliente es el pagador que va a transferir fondos a tu cuenta bancaria. Necesitas crear un cliente para recibir pagos entrantes en la cuenta bancaria de tu organización.

Versionado de Recursos

Este endpoint admite versionado a nivel de recurso. Al incluir el encabezado X-Belvo-API-Resource-Version: Payments-BR.V2, puedes acceder a los formatos de solicitud y respuesta más recientes (V2). Si no se proporciona el encabezado, se utilizará el formato predeterminado (V1). Consulta la documentación de la API para obtener detalles sobre las diferencias entre versiones.

Operaciones

Bank Accounts (Brazil)

Para recibir pagos entrantes en la cuenta bancaria de su organización, debe registrar las cuentas bancarias (individuales y comerciales) utilizando la API de Pagos de Belvo.

Las cuentas bancarias individuales deben ser creadas para cada pagador (su cliente).
Las cuentas bancarias comerciales deben ser creadas para el beneficiario del pago (su organización).

Versionado de Recursos

Este endpoint admite el versionado a nivel de recurso. Al incluir el encabezado X-Belvo-API-Resource-Version: Payments-BR.V2, puede acceder a los formatos de solicitud y respuesta más recientes (V2). Si no se proporciona el encabezado, se utilizará el formato predeterminado (V1). Consulte la documentación de la API para obtener detalles sobre las diferencias entre versiones.

Operaciones

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.

Operaciones

Payment Authorizations (Brazil)

Una Autorización de Pago es el consentimiento que tu usuario te da para cargar (debitando dinero de) sus cuentas. Necesitas realizar una Autorización de Pago por cada ‘contrato’ (por ejemplo, si tu empresa maneja tanto electricidad como agua pero se facturan por separado, entonces deberás crear dos Autorizaciones de Pago separadas).

Una vez que el usuario confirma la autorización, necesitarás escuchar un webhook PAYMENT_AUTHORIZATION con el estado configurado en AUTHORIZED. Una vez que recibas este webhook, el proceso de autorización estará completo y podrás cargar a tu usuario.

¿Qué es un cargo?

Un cargo representa el pago individual (débito) que tu cliente realizará.

Encabezado de Versión

El recurso de Autorización de Pago requiere que envíes el encabezado X-Belvo-API-Resource-Version configurado en Payments-BR.V2.

Operaciones

Enrollments (Brazil)

Operaciones

Payment Transactions (Brazil)

Cada vez que recibes un pago entrante de tu cliente, se crea una transacción en la base de datos de Belvo.

Puedes utilizar el recurso de Payment Transactions para obtener información útil sobre una transacción, así como el cargo específico asociado con ella.

Operaciones

Documentación de la API de Belvo (1.222.0)

Introducción

Información Disponible y Métodos de Pago

Diccionarios de Datos

Entornos

Sandbox

Producción

Códigos de Respuesta

Manejo de Errores

Identificador de Solicitud

Códigos de Error y Solución de Problemas

Política de Reintentos

Errores 50x

Errores 40x

Campos Obsoletos

OpenAPI: campos requeridos y anulables

Institutions

Links

Widget Access Token

Consents

Owners

Obtener los detalles de un propietario

Solicitud

Respuestas

¿Qué tan útil fue esta página?

Eliminar un propietario

Solicitud

Respuestas

¿Qué tan útil fue esta página?

Accounts

Balances

Transactions

Bills

Investments Brazil

Investment Transactions Brazil

Employments Brazil

Employment Records Mexico

Current Employments Mexico

Invoices

Tax compliance status

Tax returns

Tax retentions

Tax status

Financial Statements

Invoices Chile

Tax Status Chile

Debt Reports Chile

Incomes

Recurring Expenses

Risk Insights

Employment Metrics

Payment Institutions (Brazil)

Customers (Brazil)

Bank Accounts (Brazil)

Payment Intents (Brazil)

Payment Authorizations (Brazil)

Biometric Pix Widget Access Token (Brazil)

Enrollments (Brazil)

Payment Transactions (Brazil)