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.Permite crear un 🔒 Token OTP para iniciar el flujo de autenticación con Boufin Connect.
| 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. |
{- "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"
]
}
}
}
}{- "data": {
- "otpToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
- "consentId": "c9ee477f-39d5-4777-9b32-0855badc2138"
}
}Permite crear un 🔒 Task Token asociado a un cliente y un usuario específico.
| 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. |
{- "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
- "target": "string"
}{- "data": {
- "taskToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}
}Permite obtener la lista paginada de consentimientos asociados al identificador utilizado para crear el 🔒 Task Token.
| 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. |
{- "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
}
}Permite obtener los detalles de un consentimiento específico utilizando su ID.
| consentId required | string Identificador único del consentimiento. |
{- "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"
}
}Permite obtener una URL firmada temporal para descargar el archivo PDF del consentimiento. La URL generada tiene una validez de 5 minutos.
| consentId required | string Identificador único del consentimiento. |
{
}Permite revocar un consentimiento activo, estableciendo su estado como INACTIVE y sub-estado como REVOKED. Una vez revocado, el consentimiento no puede ser utilizado para extraer datos.
| consentId required | string <uuid> Identificador único del consentimiento a revocar. |
{- "consentId": "e521cf62-a45f-49c5-8372-94853fffeb55"
}{- "data": {
- "consentId": "c9ee477f-39d5-4777-9b32-0855badc2138",
- "status": "INACTIVE",
- "subStatus": "REVOKED"
}
}Deprecado — Usar POST /api/v1/products/retrieve-data/tasks en su lugar.
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 de banca personal o banca empresa.
| 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. |
{- "product": "tef",
- "consentId": "e521cf62-a45f-49c5-8372-94853fffeb55"
}Extracción exitosa
{- "taskStatus": "success",
- "taskStatusCode": 200,
- "data": [
- {
- "date": "2025-08-28",
- "amount": 100000,
- "currency": "CLP",
- "originAccount": "12345678",
- "destinationAccount": "87654321"
}
]
}Inicia de forma asíncrona la recuperación de datos de un producto asociado a un consentimiento activo. La respuesta incluye un taskId para consultar el estado de la tarea mediante polling.
| 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. |
{- "product": "tef",
- "consentId": "e521cf62-a45f-49c5-8372-94853fffeb55"
}{- "taskId": "task-12345-abcde"
}Consulta el estado de una tarea de obtención de producto previamente iniciada a partir de su taskId. Retorna pending o running mientras está en curso, y los datos del producto una vez finalizada. 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.
| taskId required | string [ 1 .. 100 ] characters Example: task-12345-abcde Identificador único de la tarea. |
{- "taskStatus": "success",
- "taskStatusCode": 200,
- "results": [
- {
- "date": "2025-08-28",
- "amount": 100000,
- "currency": "CLP",
- "originAccount": "12345678",
- "destinationAccount": "87654321"
}
]
}Inicia de forma asíncrona la recuperación de datos de un producto asociado a un consentimiento activo. La respuesta incluye un taskId para consultar el estado de la tarea mediante polling.
A diferencia de la versión 1, en la versión 2 el código HTTP 200 indica exclusivamente que la tarea se creó con éxito. Cualquier otro resultado se comunica mediante un código HTTP 4xx o 5xx, con un cuerpo de respuesta discriminado por el campo errorType (y errorCode para las subcategorías).
| 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. |
{- "product": "tef",
- "consentId": "e521cf62-a45f-49c5-8372-94853fffeb55"
}{- "data": {
- "taskId": "task-12345-abcde"
}
}Consulta el estado de una tarea de obtención de producto previamente iniciada a partir de su taskId. Mientras la extracción sigue en curso retorna HTTP 202, y una vez finalizada con éxito retorna HTTP 200 con el campo data, cuyo formato varía según el product solicitado. Para más información, consultar la documentación de modelos. Cualquier otro resultado se devuelve como HTTP 4xx o 5xx con un cuerpo discriminado por el campo errorType.
| taskId required | string [ 1 .. 100 ] characters Example: task-12345-abcde Identificador devuelto por |
{- "data": [
- {
- "date": "2026-05-01",
- "amount": 100000,
- "currency": "CLP",
- "originAccount": "12345678",
- "destinationAccount": "87654321"
}
]
}