Boufin Connect (1.2.0)
A continuación, se describen los diferentes endpoints que utiliza Boufin Connect. Esta API permite a las aplicaciones cliente consultar y gestionar consentimientos, así como generar tokens y obtener información detallada de los productos financieros autorizados por el usuario.
El servicio de Boufin Connect utiliza los siguientes mecanismos de autenticación:
- 🔑 API Key: Clave secreta persistente. Se usa para autenticar clientes de confianza (server-to-server) y autorizar operaciones privilegiadas.
- JWT Bearer Token: El servicio utiliza tokens JWT (JSON Web Token) como mecanismo de autenticación para operaciones seguras y controladas.- 🔒 Token OTP: Token de un solo uso generado para inicializar Boufin Connect y autorizar la sesión del usuario.
- 🔒 Task Token: Token asociado a un usuario específico (target), utilizado para consultar consentimientos y productos financieros autorizados. Cada uno está vinculado a un identificador de usuario, permitiendo acceder únicamente a los datos de ese usuario.
 
Listado de consentimientos
Permite obtener la lista paginada de consentimientos asociados al identificador utilizado para crear el 🔒 Task Token.
Authorizations:
query Parameters
| page | integer  Default:  1 Número de página a consultar en la lista paginada de consentimientos. | 
| limit | integer  Default:  10 Cantidad máxima de consentimientos a retornar por página. | 
Responses
Response samples
- 200
- 401
- 422
- 500
{- "data": {- "consents": [- {- "id": "c9ee477f-39d5-4777-9b32-0855badc2138",
- "products": [- "tef",
- "bill"
 ],
- "tyc": {- "actualVersion": 2
 },
- "entity": {- "id": "banco-chile",
- "name": "Banco de Chile",
- "type": "bank"
 },
- "status": "success",
- "validUntil": "2025-12-31T23:59:59Z"
 }
 ],
- "hasNext": false,
- "count": 1
 }
}Obtener consentimiento por id
Permite obtener los detalles de un consentimiento específico utilizando su ID.
Authorizations:
path Parameters
| consentId required | string Identificador único del consentimiento. | 
Responses
Response samples
- 200
- 401
- 404
- 422
- 500
{- "data": {- "id": "c9ee477f-39d5-4777-9b32-0855badc2138",
- "products": [- "tef",
- "bill"
 ],
- "tyc": {- "actualVersion": 2
 },
- "entity": {- "id": "banco-chile",
- "name": "Banco de Chile",
- "type": "bank"
 },
- "status": "success",
- "validUntil": "2025-12-31T23:59:59Z"
 }
}Obtener datos de un producto
Permite recuperar datos de un producto específico asociado a un consentimiento. El campo data contiene el resultado correspondiente al producto solicitado; el formato exacto varía según product. Para más información, consultar la documentación de modelos.
Authorizations:
Request Body schema: application/json
| product required | string (ProductType)   Enum: "tef" "bill" "product-balance" "financial-report" "product-balance-investment" "identity-validation" "movement" "income-report" "pat" "pac" "transfer" "consumer-loan" "mortgage" "investment-report" "credit-card-unbilled-transaction" "credit-card-statement" "account-balance" "identity-validation-clave-unica" "tax-folder" "tax-folder-pdf" "tax-folder-clave-unica" "tax-folder-pdf-clave-unica" "property-tax" "property-tax-clave-unica" "dte" "dte-clave-unica" "sworn-declaration" "sworn-declaration-clave-unica" "tax-situation" "debt" "insurance" "personal-information" "contribution" "job" "consolidate" "fiscal-statement" "fiscal-statement-clave-unica" "birth-certificate" "balances"  ID de la acción que el usuario autoriza. | 
| consentId required | string <uuid>  Identificador único del consentimiento. | 
Responses
Request samples
- Payload
{- "product": "tef",
- "consentId": "e521cf62-a45f-49c5-8372-94853fffeb55"
}Response samples
- 200
- 401
- 403
- 422
- 500
{- "data": [- {- "date": "2025-08-28",
- "amount": 100000,
- "currency": "CLP",
- "originAccount": "12345678",
- "destinationAccount": "87654321"
 }
 ]
}Crea un Token OTP
Permite crear un 🔒 Token OTP para iniciar el flujo de autenticación con Boufin Connect.
Authorizations:
Request Body schema: application/json
| products required | Array of strings (ProductType)  Items Enum: "tef" "bill" "product-balance" "financial-report" "product-balance-investment" "identity-validation" "movement" "income-report" "pat" "pac" "transfer" "consumer-loan" "mortgage" "investment-report" "credit-card-unbilled-transaction" "credit-card-statement" "account-balance" "identity-validation-clave-unica" "tax-folder" "tax-folder-pdf" "tax-folder-clave-unica" "tax-folder-pdf-clave-unica" "property-tax" "property-tax-clave-unica" "dte" "dte-clave-unica" "sworn-declaration" "sworn-declaration-clave-unica" "tax-situation" "debt" "insurance" "personal-information" "contribution" "job" "consolidate" "fiscal-statement" "fiscal-statement-clave-unica" "birth-certificate" "balances"  Lista de IDs de las acciones que se van a autorizar en el consentimiento. | 
| clientId required | string <uuid>  Identificador único del cliente. | 
| required | object Datos de identificación del usuario. | 
| object Datos de identificación de la empresa. | |
| locale | string  Default:  "es-CL" Configuración regional y de idioma. | 
| widgetConfigId required | string Identificador único de la configuración del widget. Distingue entre mayúsculas y minúsculas. Para obtener más detalles, consulta la guía de configuración inicial. | 
| object Configuración que permite definir los criterios de filtrado para determinar qué entidades estarán disponibles al usuario. | 
Responses
Request samples
- Payload
{- "products": [- "tef"
 ],
- "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
- "user": {- "username": "string",
- "email": "user@example.com"
 },
- "company": {- "id": "string"
 },
- "locale": "es-CL",
- "widgetConfigId": "string",
- "filters": {- "entities": {- "include": {- "types": [- "bank"
 ]
 }
 }
 }
}Response samples
- 200
- 401
- 422
- 500
{- "data": {- "otpToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
- "consentId": "c9ee477f-39d5-4777-9b32-0855badc2138"
 }
}Crear Task Token
Permite crear un 🔒 Task Token asociado a un cliente y un usuario específico.
Authorizations:
Request Body schema: application/json
| clientId required | string <uuid>  Identificador único del cliente. | 
| target required | string Identificador del usuario para el cual se solicita el Task Token. En Chile corresponde al RUT. | 
Responses
Request samples
- Payload
{- "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
- "target": "string"
}Response samples
- 200
- 401
- 422
- 500
{- "data": {- "taskToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
 }
}