# Generar un token de acceso para el widget Generar un token de acceso para nuestro Widget alojado. Endpoint: POST /api/token/ Version: 1.223.0 Security: basicAuth ## Request fields (application/json): - `body` (object, required) — one of: - OFDA 🇧🇷 Brazil Access Token: - `id` (string, required) Tu Belvo secretId. - `password` (string, required) Tu Belvo secretPassword. - `scopes` (string, required) El parámetro scopes contiene una lista de permisos que te permiten crear un enlace para el usuario. Este es un parámetro obligatorio y debe enviarse exactamente como se muestra. Example: "read_institutions,write_links,read_consents,write_consents,write_consent_callback,delete_consents" - `fetch_resources` (array, required) Un array de recursos para los que te gustaría recibir una actualización histórica. {% admonition type="warning" name="Espera los Webhooks Antes de Recuperar Datos" %} Después de solicitar recursos usando fetch_resources, debes esperar el webhook de actualización histórica de Belvo antes de recuperar los datos. Hacer solicitudes antes de recibir el webhook (GET o POST) devolverá resultados vacíos o incompletos. {% /admonition %} Para OFDA Brasil, puedes seleccionar los siguientes recursos: - ACCOUNTS - OWNERS - TRANSACTIONS - BILLS Además, puedes optar por los siguientes recursos específicos de Open Finance (contacta a tu representante ya que se aplican costos adicionales): - INVESTMENTS - INVESTMENT_TRANSACTIONS - EXCHANGES Para OFDA, puedes habilitar recursos de Enriquecimiento para obtener información ampliada (contacta a tu representante ya que se aplican costos adicionales): - INCOMES - RECURRING_EXPENSES - RISK_INSIGHTS {% admonition type="info" name="Los Recursos de Enriquecimiento Requieren Datos de Transacciones" %} Para calcular los recursos de enriquecimiento (INCOMES, RECURRING_EXPENSES, RISK_INSIGHTS), también debes incluir ACCOUNTS y TRANSACTIONS en tu array de fetch_resources. Sin estos recursos fundamentales, los cálculos de enriquecimiento estarán incompletos o pueden no generarse. {% /admonition %} Enum: "ACCOUNTS", "TRANSACTIONS", "OWNERS", "BILLS", "INVESTMENTS", "INVESTMENT_TRANSACTIONS", "EXCHANGES", "INCOMES", "RECURRING_EXPENSES", "RISK_INSIGHTS" - `stale_in` (string, required) Indica cuánto tiempo se debe almacenar cualquier dato derivado del usuario en la base de datos de Belvo para el enlace (tanto único como recurrente). Por ejemplo, si envías 90d, Belvo eliminará cualquier dato relacionado con el usuario de su base de datos después de 90 días. Para más información, consulta la sección stale_in de nuestro artículo sobre controles de retención de datos. > 📘 Info > > Belvo solo eliminará datos para enlaces que no se hayan actualizado en el período que proporciones en stale_in. Belvo solo eliminará datos para enlaces que no se hayan actualizado en el período que proporciones en stale_in. Por defecto, Belvo almacena los datos del usuario durante 365 días, a menos que el enlace sea eliminado. Example: "42d" - `widget` (object, required) El objeto widget contiene información adicional sobre cómo configurar el widget, incluyendo la personalización de la marca, tus términos y condiciones, URLs de callback, e información sobre el usuario para el que deseas extraer datos. - `widget.openfinance_feature` (string, required) El parámetro openfinance_feature indica que el usuario final pasará por el flujo OFDA. Debe establecerse en consent_link_creation. Example: "consent_link_creation" - `widget.callback_urls` (object, required) En el objeto callback_urls, debes agregar enlaces a donde tu usuario debe ser redirigido en los siguientes casos: - success (tu usuario conectó sus cuentas exitosamente) - exit (tu usuario salió del widget antes de completar el proceso) - event (ocurrió un error durante el proceso de conexión) Para más información, consulta la sección de callback_urls en nuestra guía del Widget Alojado (OFDA). > 📘 Eventos de Callback > > Belvo también enviará información adicional sobre el evento dependiendo del mismo. Para más información, asegúrate de consultar la sección de Manejo de eventos de callback de la guía del Widget Alojado (OFDA). - `widget.callback_urls.success` (string, required) La URL a la que se redirige a su usuario cuando conecta exitosamente su cuenta. Example: "your_deeplink_here://success" - `widget.callback_urls.exit` (string, required) La URL a la que se redirige a tu usuario cuando salen del proceso antes de conectar su cuenta. Example: "your_deeplink_here://exit" - `widget.callback_urls.event` (string, required) La URL a la que se redirige a tu usuario cuando encuentran un error al conectar su cuenta. Example: "your_deeplink_here://error" - `widget.branding` (object, required) En el objeto branding, debes agregar tu: - company_icon - company_logo - company_name - company_terms_url También puedes opcionalmente agregar un color de fondo personalizado para cuando el widget se abra, así como desactivar los mensajes de Belvo sobre cuántas cuentas se han conectado. Para más información sobre las opciones de personalización y branding del widget, consulta nuestra guía dedicada. - `widget.branding.company_icon` (string, required) Puede agregar el ícono de su empresa al widget para que esté más alineado con su marca. Para obtener más información, consulte la sección company_icon de nuestra guía de Branding y personalización (OFDA). Example: "https://mysite.com/icon.svg" - `widget.branding.company_logo` (string, required) Puede agregar el logotipo de su empresa al widget para que esté más alineado con su marca. Para obtener más información, consulte la sección company_icon de nuestra guía de Branding y personalización (OFDA). Example: "https://mysite.com/logo.svg" - `widget.branding.company_name` (string, required) Puede agregar el nombre de su empresa para que se muestre cuando el widget se inicie por primera vez. De forma predeterminada, solo mostrará "Link your account". Cuando agregue el nombre de su empresa, el mensaje seguirá el formato "[company_name] uses Belvo to connect your account". Para obtener más información, consulte la sección company_name de nuestra guía de Branding y personalización (OFDA). Example: "ACME" - `widget.branding.company_terms_url` (string, required) Puede agregar un enlace a su política de privacidad (o términos y condiciones) en la pantalla inicial del widget que, al hacer clic, redirigirá a sus usuarios a la página web vinculada. Esto ayuda a sus usuarios a comprender mejor cuál es su caso de uso con respecto a los datos que está solicitando. Para obtener más información, consulte la sección company_terms_url de nuestra guía de Branding y personalización (OFDA). Example: "https://belvo.com/terms-service/" - `widget.branding.overlay_background_color` (string) Puede agregar un color de superposición personalizado para cuando el widget se carga en su aplicación de escritorio. Para obtener más información, consulte la sección overlay_background_color de nuestra guía de Branding y personalización (OFDA). Example: "#F0F2F4" - `widget.branding.social_proof` (boolean) Puede optar por ocultar el mensaje "Mais de 5 milhões de usuários já conectaram com segurança suas contas." que aparece cuando su usuario selecciona su institución en el widget. Para obtener más información, consulte la sección social_proof de nuestra guía de Branding y personalización (OFDA). Example: true - `widget.branding.show_belvo_middle_logo` (boolean) Puede optar por mostrar el logotipo de Belvo entre el logotipo de su empresa y el logotipo de la institución en la pantalla de conexión inicial. Cuando se establece en true, se mostrará el logotipo de Belvo. Por defecto es false. Para obtener más información, consulte la sección show_belvo_middle_logo de nuestra guía de Personalización y Branding del Widget OFDA. - `widget.theme` (array) Puede agregar opcionalmente los colores de su marca al widget utilizando el parámetro theme. Para obtener más información sobre dónde aparecerán estos colores en el widget, consulte la sección dedicada Agregar colores personalizados al widget de nuestra guía de Branding. - `widget.theme.css_key` (string, required) Nombre de variable CSS. Los valores posibles incluyen: - --color-primary-base - --nav-bar-title-color - --nav-bar-icon-color Example: "--color-primary-base" - `widget.theme.value` (string, required) El código HEX para el css_key. Example: "#907AD6" - `widget.consent` (object, required) El objeto consent es exclusivo del widget OFDA y debe ser enviado. - `widget.consent.purpose` (string, required) En el parámetro purpose, puedes personalizar el mensaje que se muestra a tu usuario sobre para qué caso de uso estás solicitando sus datos. Para más información, consulta la sección de purpose en nuestra guía del Hosted Widget (OFDA). Example: "Soluções financeiras personalizadas oferecidas por meio de recomendações sob medida, visando melhores ofertas de produtos financeiros e de crédito." - `widget.consent.terms_and_conditions_url` (string, required) En el parámetro terms_and_conditions_url, debe proporcionar un enlace a los términos y condiciones de su empresa. Example: "https://www.your_terms_and_conditions.com" - `widget.consent.permissions` (array, required) El parámetro permissions contiene los recursos que deseas extraer de la Red de Finanzas Abiertas de Brasil para el usuario. Este valor debe establecerse en ["REGISTER", "ACCOUNTS", "CREDIT_CARDS", "CREDIT_OPERATIONS"]. Enum: "REGISTER", "ACCOUNTS", "CREDIT_CARDS", "CREDIT_OPERATIONS" - `widget.consent.identification_info` (array, required) En el array identification_info, necesitas proporcionar la información de identificación del usuario para el cual deseas recuperar información. La información que proporciones aquí debe coincidir con la información que la institución regulada tiene para el usuario (por ejemplo, para empresas, el CPF y el nombre deben ser de un usuario con acceso a la cuenta empresarial). - Para individuos, solo necesitas proporcionar el CPF y el nombre. - Para empresas, necesitas proporcionar tanto la información del CPF como del CNPJ. Para más información, consulta la sección identification_info de nuestra guía del Hosted Widget (OFDA). - `widget.consent.identification_info.type` (string, required) El tipo de identificador. Puede ser CPF o CNPJ. Example: "CPF" - `widget.consent.identification_info.number` (string, required) El número de CPF o CNPJ de la persona o empresa asociada con la identificación. Example: 76109277673 - `widget.consent.identification_info.name` (string, required) Nombre de la persona o empresa asociada con la identificación. Example: "Ralph Bragg" - `widget.consent.default_consent_duration_days` (number) Puede preseleccionar la duración del consentimiento en el menú desplegable. El parámetro default_consent_duration_days acepta 366, 275, 183 o 92 días (correspondientes a 12, 9, 6 o 3 meses). Si proporciona cualquier otro valor, el menú desplegable se establecerá por defecto en "Indeterminado". Para más información, consulte la sección default_consent_duration_days de nuestra guía de Personalización y Branding del Widget OFDA. Enum: 92, 183, 275, 366 - Empleos 🇧🇷 Brazil Access Token: - `id` (string, required) Tu Belvo secretId. - `password` (string, required) Tu Belvo secretPassword. - `scopes` (string, required) El parámetro scopes contiene una lista de permisos que te permiten crear un enlace para el usuario. Este es un parámetro obligatorio y debe enviarse exactamente como se muestra. Example: "read_institutions,write_links" - `fetch_resources` (array, required) Una matriz de recursos para los que le gustaría recibir una actualización histórica. Para Empleos Brasil (INSS), puede seleccionar los siguientes recursos: - EMPLOYMENTS - OWNERS Enum: "EMPLOYMENTS", "OWNERS" - `stale_in` (string, required) Indica cuánto tiempo se debe almacenar cualquier dato derivado del usuario en la base de datos de Belvo para el enlace (tanto único como recurrente). Por ejemplo, si envías 90d, Belvo eliminará cualquier dato relacionado con el usuario de su base de datos después de 90 días. Para más información, consulta la sección stale_in de nuestro artículo sobre controles de retención de datos. > 📘 Info > > Belvo solo eliminará datos para enlaces que no se hayan actualizado en el período que proporciones en stale_in. Belvo solo eliminará datos para enlaces que no se hayan actualizado en el período que proporciones en stale_in. Por defecto, Belvo almacena los datos del usuario durante 365 días, a menos que el enlace sea eliminado. Example: "42d" - `credentials_storage` (string) Indica si se deben almacenar las credenciales (y la duración durante la cual se almacenarán las credenciales). - Para enlaces recurrentes, esto se establece en store por defecto (y no se puede cambiar). - Para enlaces únicos, esto se establece en 365d por defecto. Puede ser: - store para almacenar credenciales (hasta que se elimine el enlace) - nostore para no almacenar credenciales - Cualquier valor entre 1d y 365d para indicar el número de días que deseas que se almacenen las credenciales. Para más información, consulta la sección credentials_storage de nuestro artículo sobre controles de retención de datos. Example: "27d" - `widget` (object, required) El objeto widget contiene información adicional sobre cómo configurar el widget, incluyendo la personalización de la marca, tus términos y condiciones, URLs de callback, e información sobre el usuario para el que deseas extraer datos. - `widget.callback_urls` (object) > 📘 Solo es necesario para el Widget Alojado. En el objeto callback_urls, debes agregar enlaces a donde tu usuario debe ser redirigido en los siguientes casos: - success (tu usuario conectó sus cuentas exitosamente) - exit (tu usuario salió del widget antes de completar el proceso) - event (ocurrió un error durante el proceso de conexión) Para más información, consulta la sección de callback_urls en nuestra guía del Widget Alojado (Multi-Region). > 📘 Eventos de Callback > > Belvo también enviará información adicional del evento dependiendo del evento. Para más información, asegúrate de consultar la sección de Manejo de eventos de callback de la guía del Widget Alojado (Multi-Region). - `widget.callback_urls.success` (string, required) La URL a la que se redirige a su usuario cuando conecta exitosamente su cuenta. Example: "your_deeplink_here://success" - `widget.callback_urls.exit` (string, required) La URL a la que se redirige a tu usuario cuando salen del proceso antes de conectar su cuenta. Example: "your_deeplink_here://exit" - `widget.callback_urls.event` (string, required) La URL a la que se redirige a tu usuario cuando encuentran un error al conectar su cuenta. Example: "your_deeplink_here://error" - `widget.branding` (object, required) En el objeto branding, debes agregar tu: - company_icon - company_logo - company_name - company_terms_url También puedes opcionalmente agregar un color de fondo personalizado para cuando el widget se abra, así como desactivar el mensaje de Belvo sobre cuántas cuentas se han conectado. Para más información sobre las opciones de personalización y branding del widget, consulta nuestra guía dedicada. - `widget.branding.company_icon` (string, required) Puede agregar el ícono de su empresa al widget para que esté más alineado con su marca. Para obtener más información, consulte la sección company_icon de nuestra guía de Branding y personalización (Multi-Region). Example: "https://mysite.com/icon.svg" - `widget.branding.company_logo` (string, required) Puede agregar el logotipo de su empresa al widget para que esté más alineado con su marca. Para obtener más información, consulte la sección company_icon de nuestra guía de Branding y personalización (Multi-Region). Example: "https://mysite.com/logo.svg" - `widget.branding.company_name` (string, required) Puede agregar el nombre de su empresa para que se muestre cuando el widget se inicie por primera vez. De forma predeterminada, solo mostrará "Link your account". Cuando agregue el nombre de su empresa, el mensaje seguirá el formato "[company_name] uses Belvo to connect your account". Para obtener más información, consulte la sección company_name de nuestra guía de Branding y personalización (Multi-Region). Example: "ACME" - `widget.branding.company_terms_url` (string, required) Puede agregar un enlace a su política de privacidad (o términos y condiciones) en la pantalla inicial del widget que, al hacer clic, redirigirá a sus usuarios a la página web vinculada. Esto ayuda a sus usuarios a comprender mejor cuál es su caso de uso con respecto a los datos que está solicitando. Para obtener más información, consulte la sección company_terms_url de nuestra guía de Branding y personalización (Multi-Region). Example: "https://belvo.com/terms-service/" - `widget.branding.company_terms_version` (string) La versión de sus términos y condiciones. Use este parámetro junto con company_terms_url para rastrear qué versión de sus T&C aceptó el usuario durante el flujo del widget. Example: "20260323" - `widget.branding.overlay_background_color` (string) Puede agregar un color de superposición personalizado para cuando el widget se carga en su aplicación de escritorio. Para obtener más información, consulte la sección overlay_background_color de nuestra guía de Branding y personalización (Multi-Region). Example: "#F0F2F4" - `widget.branding.social_proof` (boolean) Puede optar por ocultar el mensaje "Mais de 5 milhões de usuários já conectaram com segurança suas contas." que aparece cuando su usuario selecciona su institución en el widget. Para obtener más información, consulte la sección social_proof de nuestra guía de Branding y personalización (Multi-Region). Example: true - `widget.theme` (array) Puede agregar opcionalmente los colores de su marca al widget utilizando el parámetro theme. Para obtener más información sobre dónde aparecerán estos colores en el widget, consulte la sección dedicada Agregar colores personalizados al widget de nuestra guía de Branding. - `widget.theme.css_key` (string, required) Nombre de variable CSS. Los valores posibles incluyen: - --color-primary-base - --nav-bar-title-color - --nav-bar-icon-color Example: "--color-primary-base" - `widget.theme.value` (string, required) El código HEX para el css_key. Example: "#907AD6" - Registros de Empleo 🇲🇽 Token de Acceso de México: - `id` (string, required) Tu Belvo secretId. - `password` (string, required) Tu Belvo secretPassword. - `scopes` (string, required) El parámetro scopes contiene una lista de permisos que te permiten crear un enlace para el usuario. Este es un parámetro obligatorio y debe enviarse exactamente como se muestra. Example: "read_institutions,write_links" - `fetch_resources` (array, required) Una matriz de recursos para los que te gustaría recibir una actualización histórica. Para Registros de Empleo México (IMSS e ISSSTE), puedes seleccionar los siguientes recursos: - EMPLOYMENT_RECORDS Además, puedes optar por los siguientes recursos específicos de Registros de Empleo (contacta a tu representante ya que se aplican costos adicionales): - CURRENT_EMPLOYMENTS (solo IMSS) - EMPLOYMENT_METRICS (solo IMSS) Enum: "EMPLOYMENT_RECORDS", "CURRENT_EMPLOYMENTS", "EMPLOYMENT_METRICS" - `stale_in` (string, required) Indica cuánto tiempo se debe almacenar cualquier dato derivado del usuario en la base de datos de Belvo para el enlace (tanto único como recurrente). Por ejemplo, si envías 90d, Belvo eliminará cualquier dato relacionado con el usuario de su base de datos después de 90 días. Para más información, consulta la sección stale_in de nuestro artículo sobre controles de retención de datos. > 📘 Info > > Belvo solo eliminará datos para enlaces que no se hayan actualizado en el período que proporciones en stale_in. Belvo solo eliminará datos para enlaces que no se hayan actualizado en el período que proporciones en stale_in. Por defecto, Belvo almacena los datos del usuario durante 365 días, a menos que el enlace sea eliminado. Example: "42d" - `credentials_storage` (string) Indica si se deben almacenar las credenciales (y la duración durante la cual se almacenarán las credenciales). - Para enlaces recurrentes, esto se establece en store por defecto (y no se puede cambiar). - Para enlaces únicos, esto se establece en 365d por defecto. Puede ser: - store para almacenar credenciales (hasta que se elimine el enlace) - nostore para no almacenar credenciales - Cualquier valor entre 1d y 365d para indicar el número de días que deseas que se almacenen las credenciales. Para más información, consulta la sección credentials_storage de nuestro artículo sobre controles de retención de datos. Example: "27d" - `widget` (object, required) El objeto widget contiene información adicional sobre cómo configurar el widget, incluyendo la personalización de la marca, tus términos y condiciones, URLs de callback, e información sobre el usuario para el que deseas extraer datos. - `widget.callback_urls` (object) > 📘 Solo es necesario para el Widget Alojado. En el objeto callback_urls, debes agregar enlaces a donde tu usuario debe ser redirigido en los siguientes casos: - success (tu usuario conectó sus cuentas exitosamente) - exit (tu usuario salió del widget antes de completar el proceso) - event (ocurrió un error durante el proceso de conexión) Para más información, consulta la sección de callback_urls en nuestra guía del Widget Alojado (Multi-Region). > 📘 Eventos de Callback > > Belvo también enviará información adicional del evento dependiendo del evento. Para más información, asegúrate de consultar la sección de Manejo de eventos de callback de la guía del Widget Alojado (Multi-Region). - `widget.callback_urls.success` (string, required) La URL a la que se redirige a su usuario cuando conecta exitosamente su cuenta. Example: "your_deeplink_here://success" - `widget.callback_urls.exit` (string, required) La URL a la que se redirige a tu usuario cuando salen del proceso antes de conectar su cuenta. Example: "your_deeplink_here://exit" - `widget.callback_urls.event` (string, required) La URL a la que se redirige a tu usuario cuando encuentran un error al conectar su cuenta. Example: "your_deeplink_here://error" - `widget.branding` (object, required) En el objeto branding, debes agregar tu: - company_icon - company_logo - company_name - company_terms_url También puedes opcionalmente agregar un color de fondo personalizado para cuando el widget se abra, así como desactivar el mensaje de Belvo sobre cuántas cuentas se han conectado. Para más información sobre las opciones de personalización y branding del widget, consulta nuestra guía dedicada. - `widget.branding.company_icon` (string, required) Puede agregar el ícono de su empresa al widget para que esté más alineado con su marca. Para obtener más información, consulte la sección company_icon de nuestra guía de Branding y personalización (Multi-Region). Example: "https://mysite.com/icon.svg" - `widget.branding.company_logo` (string, required) Puede agregar el logotipo de su empresa al widget para que esté más alineado con su marca. Para obtener más información, consulte la sección company_icon de nuestra guía de Branding y personalización (Multi-Region). Example: "https://mysite.com/logo.svg" - `widget.branding.company_name` (string, required) Puede agregar el nombre de su empresa para que se muestre cuando el widget se inicie por primera vez. De forma predeterminada, solo mostrará "Link your account". Cuando agregue el nombre de su empresa, el mensaje seguirá el formato "[company_name] uses Belvo to connect your account". Para obtener más información, consulte la sección company_name de nuestra guía de Branding y personalización (Multi-Region). Example: "ACME" - `widget.branding.company_terms_url` (string, required) Puede agregar un enlace a su política de privacidad (o términos y condiciones) en la pantalla inicial del widget que, al hacer clic, redirigirá a sus usuarios a la página web vinculada. Esto ayuda a sus usuarios a comprender mejor cuál es su caso de uso con respecto a los datos que está solicitando. Para obtener más información, consulte la sección company_terms_url de nuestra guía de Branding y personalización (Multi-Region). Example: "https://belvo.com/terms-service/" - `widget.branding.company_terms_version` (string) La versión de sus términos y condiciones. Use este parámetro junto con company_terms_url para rastrear qué versión de sus T&C aceptó el usuario durante el flujo del widget. Example: "20260323" - `widget.branding.overlay_background_color` (string) Puede agregar un color de superposición personalizado para cuando el widget se carga en su aplicación de escritorio. Para obtener más información, consulte la sección overlay_background_color de nuestra guía de Branding y personalización (Multi-Region). Example: "#F0F2F4" - `widget.branding.social_proof` (boolean) Puede optar por ocultar el mensaje "Mais de 5 milhões de usuários já conectaram com segurança suas contas." que aparece cuando su usuario selecciona su institución en el widget. Para obtener más información, consulte la sección social_proof de nuestra guía de Branding y personalización (Multi-Region). Example: true - `widget.theme` (array) Puede agregar opcionalmente los colores de su marca al widget utilizando el parámetro theme. Para obtener más información sobre dónde aparecerán estos colores en el widget, consulte la sección dedicada Agregar colores personalizados al widget de nuestra guía de Branding. - `widget.theme.css_key` (string, required) Nombre de variable CSS. Los valores posibles incluyen: - --color-primary-base - --nav-bar-title-color - --nav-bar-icon-color Example: "--color-primary-base" - `widget.theme.value` (string, required) El código HEX para el css_key. Example: "#907AD6" - Token de Acceso Fiscal 🇲🇽 México: - `id` (string, required) Tu Belvo secretId. - `password` (string, required) Tu Belvo secretPassword. - `scopes` (string, required) El parámetro scopes contiene una lista de permisos que te permiten crear un enlace para el usuario. Este es un parámetro obligatorio y debe enviarse exactamente como se muestra. Example: "read_institutions,write_links" - `fetch_resources` (array, required) Una matriz de recursos para los que te gustaría recibir una actualización histórica. Para Fiscal Mexico (SAT), puedes seleccionar los siguientes recursos: - FINANCIAL_STATEMENTS - INVOICES - TAX_COMPLIANCE_STATUS - TAX_RETENTIONS - TAX_RETURNS - TAX_STATUS Enum: "FINANCIAL_STATEMENTS", "INVOICES", "TAX_COMPLIANCE_STATUS", "TAX_RETENTIONS", "TAX_RETURNS", "TAX_STATUS" - `stale_in` (string, required) Indica cuánto tiempo se debe almacenar cualquier dato derivado del usuario en la base de datos de Belvo para el enlace (tanto único como recurrente). Por ejemplo, si envías 90d, Belvo eliminará cualquier dato relacionado con el usuario de su base de datos después de 90 días. Para más información, consulta la sección stale_in de nuestro artículo sobre controles de retención de datos. > 📘 Info > > Belvo solo eliminará datos para enlaces que no se hayan actualizado en el período que proporciones en stale_in. Belvo solo eliminará datos para enlaces que no se hayan actualizado en el período que proporciones en stale_in. Por defecto, Belvo almacena los datos del usuario durante 365 días, a menos que el enlace sea eliminado. Example: "42d" - `credentials_storage` (string) Indica si se deben almacenar las credenciales (y la duración durante la cual se almacenarán las credenciales). - Para enlaces recurrentes, esto se establece en store por defecto (y no se puede cambiar). - Para enlaces únicos, esto se establece en 365d por defecto. Puede ser: - store para almacenar credenciales (hasta que se elimine el enlace) - nostore para no almacenar credenciales - Cualquier valor entre 1d y 365d para indicar el número de días que deseas que se almacenen las credenciales. Para más información, consulta la sección credentials_storage de nuestro artículo sobre controles de retención de datos. Example: "27d" - `widget` (object, required) El objeto widget contiene información adicional sobre cómo configurar el widget, incluyendo la personalización de la marca, tus términos y condiciones, URLs de callback, e información sobre el usuario para el que deseas extraer datos. - `widget.callback_urls` (object) > 📘 Solo es necesario para el Widget Alojado. En el objeto callback_urls, debes agregar enlaces a donde tu usuario debe ser redirigido en los siguientes casos: - success (tu usuario conectó sus cuentas exitosamente) - exit (tu usuario salió del widget antes de completar el proceso) - event (ocurrió un error durante el proceso de conexión) Para más información, consulta la sección de callback_urls en nuestra guía del Widget Alojado (Multi-Region). > 📘 Eventos de Callback > > Belvo también enviará información adicional del evento dependiendo del evento. Para más información, asegúrate de consultar la sección de Manejo de eventos de callback de la guía del Widget Alojado (Multi-Region). - `widget.callback_urls.success` (string, required) La URL a la que se redirige a su usuario cuando conecta exitosamente su cuenta. Example: "your_deeplink_here://success" - `widget.callback_urls.exit` (string, required) La URL a la que se redirige a tu usuario cuando salen del proceso antes de conectar su cuenta. Example: "your_deeplink_here://exit" - `widget.callback_urls.event` (string, required) La URL a la que se redirige a tu usuario cuando encuentran un error al conectar su cuenta. Example: "your_deeplink_here://error" - `widget.branding` (object, required) En el objeto branding, debes agregar tu: - company_icon - company_logo - company_name - company_terms_url También puedes opcionalmente agregar un color de fondo personalizado para cuando el widget se abra, así como desactivar el mensaje de Belvo sobre cuántas cuentas se han conectado. Para más información sobre las opciones de personalización y branding del widget, consulta nuestra guía dedicada. - `widget.branding.company_icon` (string, required) Puede agregar el ícono de su empresa al widget para que esté más alineado con su marca. Para obtener más información, consulte la sección company_icon de nuestra guía de Branding y personalización (Multi-Region). Example: "https://mysite.com/icon.svg" - `widget.branding.company_logo` (string, required) Puede agregar el logotipo de su empresa al widget para que esté más alineado con su marca. Para obtener más información, consulte la sección company_icon de nuestra guía de Branding y personalización (Multi-Region). Example: "https://mysite.com/logo.svg" - `widget.branding.company_name` (string, required) Puede agregar el nombre de su empresa para que se muestre cuando el widget se inicie por primera vez. De forma predeterminada, solo mostrará "Link your account". Cuando agregue el nombre de su empresa, el mensaje seguirá el formato "[company_name] uses Belvo to connect your account". Para obtener más información, consulte la sección company_name de nuestra guía de Branding y personalización (Multi-Region). Example: "ACME" - `widget.branding.company_terms_url` (string, required) Puede agregar un enlace a su política de privacidad (o términos y condiciones) en la pantalla inicial del widget que, al hacer clic, redirigirá a sus usuarios a la página web vinculada. Esto ayuda a sus usuarios a comprender mejor cuál es su caso de uso con respecto a los datos que está solicitando. Para obtener más información, consulte la sección company_terms_url de nuestra guía de Branding y personalización (Multi-Region). Example: "https://belvo.com/terms-service/" - `widget.branding.company_terms_version` (string) La versión de sus términos y condiciones. Use este parámetro junto con company_terms_url para rastrear qué versión de sus T&C aceptó el usuario durante el flujo del widget. Example: "20260323" - `widget.branding.overlay_background_color` (string) Puede agregar un color de superposición personalizado para cuando el widget se carga en su aplicación de escritorio. Para obtener más información, consulte la sección overlay_background_color de nuestra guía de Branding y personalización (Multi-Region). Example: "#F0F2F4" - `widget.branding.social_proof` (boolean) Puede optar por ocultar el mensaje "Mais de 5 milhões de usuários já conectaram com segurança suas contas." que aparece cuando su usuario selecciona su institución en el widget. Para obtener más información, consulte la sección social_proof de nuestra guía de Branding y personalización (Multi-Region). Example: true - `widget.theme` (array) Puede agregar opcionalmente los colores de su marca al widget utilizando el parámetro theme. Para obtener más información sobre dónde aparecerán estos colores en el widget, consulte la sección dedicada Agregar colores personalizados al widget de nuestra guía de Branding. - `widget.theme.css_key` (string, required) Nombre de variable CSS. Los valores posibles incluyen: - --color-primary-base - --nav-bar-title-color - --nav-bar-icon-color Example: "--color-primary-base" - `widget.theme.value` (string, required) El código HEX para el css_key. Example: "#907AD6" ## Response 200 fields (application/json): - `access` (string) El token de acceso que se utilizará para autenticar el widget. Example: "jwt_test_ey.........." - `refresh` (string) El token de actualización que se utilizará para autenticar el widget. Example: "jwt_test_ey.........." ## Response 500 fields (application/json): - `code` (string) Un código de error único (unexpected_error) que te permite clasificar y manejar el error de manera programática. ℹ️ Consulta nuestro DevPortal para obtener más información sobre cómo manejar errores 500 unexpected_error. Example: "unexpected_error" - `message` (string) Una breve descripción del error. Para los errores unexpected_error, la descripción es: - Belvo no puede procesar la solicitud debido a un problema interno del sistema o a una respuesta no soportada de una institución. Example: "Belvo is unable to process the request due to an internal system issue or to an unsupported response from an institution" - `request_id` (string) Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: [a-f0-9]{32}). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones. Example: "9e7b283c6efa449c9c028a16b5c249fb"