# Registrar un nuevo enlace

## ▶️ Uso

Registra un nuevo enlace (una conexión entre tu usuario y su institución) utilizando la API de Belvo.

> 👍 Recomendamos encarecidamente usar nuestro Connect Widget para manejar la creación de enlaces y las actualizaciones de estado de los enlaces.

Para facilitar las cosas, hemos incluido ejemplos personalizados para los enlaces que puedes crear para cada uno de nuestros productos. Simplemente haz clic en el tipo de enlace que deseas crear en la sección  a continuación.

Endpoint: POST /api/links/
Version: 1.223.0
Security: basicAuth

## Response 201 fields (application/json):

  - `id` (string)
    Identificador único de Belvo para el elemento actual.
    Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"

  - `institution` (string)
    Nombre de la institución de Belvo.
    Example: "erebor_mx_retail"

  - `access_mode` (string,null)
    El tipo de enlace.
Para más información, consulta nuestro artículo de Enlaces.
Devolvemos uno de los siguientes valores de enum:
  - 
  - 
  -
    Enum: "single", "recurrent", null

  - `last_accessed_at` (string,null)
    La marca de tiempo ISO-8601 del acceso más reciente y exitoso de Belvo a la institución para el enlace dado.
    Example: "2021-03-09T10:28:40.000Z"

  - `created_at` (string)
    La marca de tiempo ISO-8601 de cuando se creó el punto de datos en la base de datos de Belvo.
    Example: "2022-02-09T08:45:50.406032Z"

  - `external_id` (string)
    Un identificador adicional para el enlace, proporcionado por usted, para almacenar en la base de datos de Belvo.  incluir ninguna Información Personal Identificable (PII).  tener al menos tres caracteres de longitud.

Si identificamos que el identificador contiene PII, forzaremos un valor . Para más información, consulte nuestro artículo sobre la creación de enlaces.
    Example: "56ab5706-6e00-48a4-91c9-ca55968678d9"

  - `institution_user_id` (string)
    > 📘 Información
>
> Solo aplicable para enlaces creados .

Una cadena única de 44 caracteres que se puede usar para identificar a un usuario en una institución determinada.

📚 Consulta nuestro artículo del DevPortal Evitar enlaces duplicados para obtener más información y consejos sobre cómo usarlo.
    Example: "sooE7XJWEKypZJR603ecaWYk-8Ap0oD8Nr1pBQ4eG9c="

  - `status` (string)
    El estado actual del enlace. Para más información, consulta nuestro artículo de Link en el devportal. Devolvemos uno de los siguientes valores:
  - 
  - 
  - 
  -
    Enum: "valid", "invalid", "unconfirmed", "token_required"

  - `created_by` (string)
    El ID único para el usuario que creó este elemento.
    Example: "bcef7f35-67f2-4b19-b009-cb38795faf09"

  - `refresh_rate` (string,null)
    La frecuencia de actualización para el enlace recurrente. Para más información, consulta nuestra documentación sobre enlaces recurrentes en nuestro DevPortal.
Devolvemos uno de los siguientes valores de enum:
  - 
  - 
  - 
  -  (predeterminado)
  -  (una vez al mes)
  -  (para enlaces únicos)
    Enum: "6h", "12h", "24h", "7d", "30d", null

  - `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  por defecto (y no se puede cambiar).
- Para enlaces únicos, esto se establece en  por defecto.

Puede ser:
  -  para almacenar credenciales (hasta que se elimine el enlace)
  -  para no almacenar credenciales
  - Cualquier valor entre  y  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"

  - `fetch_resources` (array)
    Un conjunto de recursos para los que recibirás una actualización histórica.
    Example: ["ACCOUNTS","TRANSACTIONS"]

  - `stale_in` (string)
    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 , 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 . Belvo solo eliminará datos para enlaces que no se hayan actualizado en el período que proporciones en .

Por defecto, Belvo almacena los datos del usuario durante 365 días, a menos que el enlace sea eliminado.
    Example: "42d"

## Response 403 fields (application/json):

  - `code` (string)
    Un código de error único () 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 403 access_to_resource_denied.
    Example: "access_to_resource_denied"

  - `message` (string)
    Una breve descripción del error.

Para los errores , la descripción es:

  - .
    Example: "You don't have access to this resource."

  - `request_id` (string)
    Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: ). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 404 fields (application/json):

  - `code` (string)
    Un código de error único () que te permite clasificar y manejar el error de manera programática.
    Example: "not_found"

  - `message` (string)
    Una breve descripción del error.

Para errores , la descripción es:

  -
    Example: "Not found"

  - `request_id` (string)
    Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: ). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 408 fields (application/json):

  - `code` (string)
    Un código de error único () 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 408 request_timeout.
    Example: "request_timeout"

  - `message` (string)
    Una breve descripción del error.

Para los errores de , la descripción es:

  - .
    Example: "The request timed out, you can retry asking for less data by changing your query parameters"

  - `request_id` (string)
    Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: ). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 428 fields (application/json):

  - `code` (string)
    Un código de error único () que te permite clasificar y manejar el error de forma programática. ℹ️ Consulta nuestro DevPortal para obtener más información sobre cómo manejar errores 428 token_required.
    Example: "token_required"

  - `message` (string)
    Una breve descripción del error. 
Para los errores , la descripción es:

  - .
    Example: "A MFA token is required by the institution to login"

  - `request_id` (string)
    Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: ). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

  - `session` (string)
    Un ID único de 32 caracteres de la sesión de inicio de sesión (que coincide con un patrón de regex de: ).
    Example: "2675b703b9d4451f8d4861a3eee54449"

  - `expiry` (integer)
    Tiempo de duración de la sesión en segundos.
    Example: 9600

  - `link` (string)
    Identificador único creado por Belvo, utilizado para referenciar el Link actual.
    Example: "30cb4806-6e00-48a4-91c9-ca55968576c8"

  - `token_generation_data` (object)
    Detalles sobre cómo generar el token.

  - `token_generation_data.instructions` (string)
    Instrucciones para la generación de tokens.
    Example: "Use this code to generate the token"

  - `token_generation_data.type` (string)
    Tipo de datos para generar el token (código QR, desafío numérico).
    Example: "numeric"

  - `token_generation_data.value` (string)
    Valor a utilizar para generar el token.
    Example: "12345"

  - `token_generation_data.expects_user_input` (boolean)
    Indica si el usuario necesita proporcionar información para completar la autenticación. Cuando se establece en , es posible que su usuario necesite:
- confirmar el inicio de sesión en otro dispositivo
- escanear un código QR
Aún necesitará realizar una llamada PATCH para completar la solicitud.
    Example: true

## Response 500 fields (application/json):

  - `code` (string)
    Un código de error único () 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 , la descripción es:

- .
    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: ). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"