Saltar al contenido principal
API docs by Redocly

Servicios de Automatización Financiera (1.2.0)

E-mail: team@boufin.com URL: https://www.boufin.com

Introducción

Bienvenido a la documentación de la API de Boufin. Acá encontrarás toda la información necesaria para comenzar a utilizar nuestros servicios de Open Data.

Ambientes

Antes de empezar, es importante conocer los diferentes ambientes de uso disponibles:

  • Sandbox: Un ambiente de pruebas donde puedes realizar todas las pruebas necesarias sin utilizar credenciales reales y cuyos datos de respuesta son valores falsos que simulan una respuesta real.
  • Staging: Ambiente de pruebas previo a producción, con datos reales y que requiere el uso de credenciales válidas.
  • Producción: Ambiente de producción, con datos reales y que requiere el uso de credenciales válidas.

⚠️ Importante: Las URL y API Key de los ambientes serán entregados por el equipo de Boufin al momento de contratar el servicio.

Autenticación

Boufin utiliza dos mecanismos de autenticación de las solicitudes:

  • apiKey: Autenticación mediante una API Key.
  • token: Autenticación con token de sesión.

apiKey

Autenticarse enviando una API_KEY asociada a la organización.

Security Scheme Type: API Key
Header parameter name: X-API-Key

sessionToken

Autenticarse enviando un token de sesión obtenido previamente.

Security Scheme Type: HTTP
HTTP Authorization Scheme: bearer
Bearer format: Bearer

Flujo de extracción

  1. Para cada cliente (usuario final) se debe obtener un token de sesión en /auth/login.
  2. Con el token anterior verificamos que el username y la entidad no estén bloqueados en /users/status/by-entity.
  3. Una vez verificada la información anterior puedes realizar un proceso de extracción utilizando el endpoint /tasks, el cual entrega un identificador de tarea en curso.
  4. Consultar por el estado del proceso de extracción usando el endpoint /tasks/{taskId}.

Descripción de entidades y acciones

para mas información ver entidades y acciones

Cifrado en Procesos de extracción

Para mas información ir a Cifrado de datos.

Token

Obtener token de sesión

Permite obtener el token de sesión para autenticar las solicitudes posteriores

Authorizations:
apiKey
Request Body schema: application/json

El body es opcional y se puede utilizar para dar un tiempo de expiración custom.

expire
number
Default: 60

(Opcional): Este valor cambia el tiempo de expiración por defecto.

  • Valor por defecto 60 minutos.
  • Tiempo mínimo 10 min
  • Tiempo máximo 60 min

Responses

Request samples

Content type
application/json
{
  • "expire": 60
}

Response samples

Content type
application/json
{
  • "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6Ikp1YW4gUMOpcmV6IiwiaWF0IjoxNTE2MjM5MDIyfQ.78YlMjUXzOKM9NM2foapnjarcbI2Qfm93-0LM0iRF1g"
}

Validar token de sesión

Valida que el token de sesión utilizado es válido, es decir, que está correctamente firmado y no ha expirado. Actualmente el token dura 1 hora sin renovación.

Authorizations:
sessionToken

Responses

Request samples 

curl -X POST "https://${URL}/api/v1/auth/is-token-valid"  \
  -H "Authorization: Bearer ${TOKEN}"

Response samples

Content type
application/json
{
  • "message": "Jwt is expired"
}

Extracción

Esta sección describe los endpoints relacionados a los procesos de extracción de datos.

Requerimientos de Credenciales

Cada entidad tiene requisitos específicos en cuanto a contraseñas. El servicio realiza una comprobación en base a esto previo a intentar la conexión con la entidad para evitar errores o bloqueos. Al detectar que la solicitud no cumple su esquema, entrega como respuesta "password doesn't meet entity schema". Para evitar esto, considere los siguientes al definir el parámetro args.

Bancos Personas

Entidad Componentes Requeridos Longitud Contraseña Caracteres Permitidos
Chile username password 4 - 20 Alfanumérico y símbolos:
!@#$%^&*()-_=+{};:,<.>
Santander username password 4 - 15 Alfanumérico y símbolos:
~!@#$^*_=[]{}|;:,.?-
Estado username password 6 - 8 Alfanumérico
BCI username password 4 - 8 Alfanumérico
Falabella username password 6 Numérico
Itaú username password 8 - 10 Alfanumérico
Scotiabank username password 8 - 15 Alfanumérico
Ripley username password 4 Numérico
Security username password 4 - 20 Alfanumérico
Consorcio username password 4 - 16 Alfanumérico
Bice username password 4 - 10 Alfanumérico

Servicios

Entidad Componentes Requeridos Longitud Contraseña Caracteres Permitidos
Servipag username password 6 - 12 Alfanumérico
Sencillito username password 8 - 20 Alfanumérico

AFP

Entidad Componentes Requeridos Longitud Contraseña Caracteres Permitidos
Modelo username password 6 Numérico
Cuprum username password 8 - 20 Alfanumérico y símbolos:
!@#$%^&*()-_=+{};:,<.>
Habitat username password 6 - 10 Alfanumérico
Provida username password 4 - 20 Alfanumérico
Uno username password 4 Numérico
Planvital username password 4 - 16 Alfanumérico
Capital username password 6 Numérico

Servicios Estatales

Tipo Longitud Contraseña Caracteres Permitidos
Clave Única 7 - 30 Alfanumérico
Clave Tributaria 8 - 12 Alfanumérico

Iniciar proceso de extracción

Este endpoint da inicio a un proceso de extracción, retornando el id de la tarea de extracción recién creada. El proceso de extracción se ejecuta de manera asíncrona, con lo cual se debe llamar a /api/v1/tasks/{taskId} para consultar el estado y obtener los resultados de la tarea.

Requiere como parámetro una acción de entidad (véase Entidades y acciones disponibles) y la contraseña del usuario propietario.

En caso de intentos de extracción consecutivos con contraseña incorrecta, este endpoint devolverá un código HTTP 403, no permitiendo realizar extracciones a ese usuario sobre esa entidad hasta la fecha indicada en el campo message.

ℹ️ Nuevo campo ErrorCode

Hemos introducido un nuevo campo llamado errorCode en las respuestas HTTP 422 y 403 para mejorar la experiencia de desarrollo. Este errorCode proporciona información más detallada sobre el error, permitiendo a los desarrolladores:

  • Identificar y manejar escenarios de error específicos de manera más precisa.
  • Realizar pruebas más exhaustivas de diferentes situaciones de error.
  • Implementar lógica de manejo de errores más robusta en sus aplicaciones.

La adición de este campo no afecta el funcionamiento de los sistemas existentes en producción.

Este nuevo campo se encontrará en producción a mediados de octubre de este año.

Authorizations:
sessionToken
Request Body schema: application/json

Datos para la creación de la tarea de extracción.

One of
action
required
string (Action)
Enum: "banco-chile:tef" "banco-chile:bill" "banco-santander:tef" "banco-santander:bill" "banco-estado:tef" "banco-estado:bill" "banco-bci:tef" "banco-bci:bill" "banco-falabella:tef" "banco-falabella:bill" "banco-itau:tef" "banco-itau:bill" "banco-scotiabank:tef" "banco-scotiabank:bill" "servipag:bill" "afc:consolidate" "afc:job" "afc:contribution" "afc:personal-information" "afc:income-report"
object

Información con las credenciales del usuario.

Responses

Request samples

Content type
application/json
Example

Opción 1

{
  • "action": "banco-chile:tef",
  • "args": {
    }
}

Response samples

Content type
application/json
{
  • "taskId": "string"
}

Consultar el estado del proceso de extracción

Consultar el estado y/o obtener los resultados de la extracción.

Es importante que preste atención al campo taskStatusCode y al taskStatus. Mientras la extracción está encolada el estado será 202 con taskStatus: "pending"; cuando se esté ejecutando será taskStatus: "running". Los siguiente estados (taskStatusCode) son finales y corresponden al término de ese proceso de extracción en particular:

  • 200: Extracción Exitosa
  • 401: Contraseña Incorrecta.
  • 500: La entidad desde donde se está extrayendo los datos no está disponible o no responde.

Nota: Este endpoint no indicará si bloqueado (por parte de Boufin) la extracción para una determinada entidad, esto se señala mediante el código HTTP 403 al Iniciar un Proceso de Extracción.

Authorizations:
sessionToken
path Parameters
taskId
required
string

ID de la tarea

Responses

Request samples 

curl "https://${URL}/api/v1/tasks/${TASKID}"  \
  -H "Authorization: Bearer ${TOKEN}"

Response samples

Content type
application/json
Example

Extracción exitosa

{
  • "taskStatus": "success",
  • "taskStatusCode": 200,
  • "results": {
    }
}

Obtener entidades y acciones disponibles

Consulta las entidades disponibles para la extracción y el listado de las acciones disponibles por entidad.

Authorizations:
apiKeysessionToken

Responses

Request samples 

curl "https://${URL}/api/v1/entities"  \
  -H "X-API-Key: ${API_KEY}"

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Usuario

Esta sección describe los endpoints relacionados a los usuarios

Obtén el estado del usuario por entidad

El par usuario/entidad podría estar bloqueado por múltiples procesos de extracción con respuesta de contraseña incorrecta (401)

Authorizations:
sessionToken

Responses

Request samples 

curl -X POST "https://${URL}/api/v1/users/status/by-entity"  \
  -H "Authorization: Bearer ${TOKEN}" \
  -H "Content-Type: application/json" \
  --data '{
      "username": "${USERNAME}",
      "entity": "${ENTITY}"
    }'

Response samples

Content type
application/json
Example
{
  • "enabled": true,
  • "retryAfter": null
}

Modelos Banca Personas

A continuación se describen los modelos de los endpoints relacionados a Banca Personas.

Validación de Identidad

Action: [entityId]:identity-validation

isValid
required
boolean

Indica si la identidad de la persona fue validada exitosamente utilizando el acceso a la institución financiera

{
  • "taskStatus": "success",
  • "taskStatusCode": 200,
  • "results": {
    }
}

Destinatario TEF

Action: [entityId]:tef

name
required
string

Nombre del destinatario

rut
required
string

Rut del destinatario en formato 11.111.111-1

bankName
required
string

Banco del destinatario

bankCode
required
string (BankCode)
Enum: "001" "037" "012" "016" "504" "051" "039"

Código de la entidad. Este campo solo se muestra si la entidad tiene código de CMF https://www.sbif.cl/sbifweb/servlet/ConozcaSBIF?indice=7.5.1.1&idContenido=483

accountNumber
required
string

Número de cuenta del destinatario

accountType
required
string (AccountType)
Default: "corriente"
Enum: "vista" "corriente" "ahorro" "rut" "chequera_electronica" "otro"

Tipo de cuenta. Para Destinatarios TEF se usan corriente, vista y ahorro.

email
required
string

Email del destinatario.

alias
string

Alias o nombre corto del destinatario. Este campo es opcional y en caso de para las entidades que no lo usen entonces no sera agregado al registro.

{
  • "taskStatus": "success",
  • "taskStatusCode": 200,
  • "results": {
    }
}

Cuentas de Servicio

Action: [entityId]:bill

company
required
string

Compañia de servicio

alias
string

Nombre de la cuenta

userId
required
string

Número o identificador de cuenta

{
  • "taskStatus": "success",
  • "taskStatusCode": 200,
  • "results": {
    }
}

Saldos de Productos

Action: [entityId]:product-balance

required
Array of objects (AccountDetail)

Saldos de cuentas

required
object or null

Totales Saldos de cuentas

required
Array of objects

Líneas de crédito

required
Array of objects (CreditCardDetail)

Tarjetas de crédito

required
object or null

Totales Tarjetas de crédito

{
  • "taskStatus": "success",
  • "taskStatusCode": 200,
  • "results": {
    }
}

Movimientos de Cuenta

Action: [entityId]:movement

Array
accountNumber
required
string

Número de cuenta

accountType
required
string

Tipo de cuenta. Ejemplos: "corriente", "vista", "rut"

productName
required
string

Ejemplos: "Cuenta RUT", "Chequera Electrónica", "Cuenta Corriente"

currentBalance
required
number

Saldo contable (Saldo disponible más saldo retenido)

availableBalance
required
number

Saldo disponible

withholdings
required
number

Saldo retenido

currency
required
string

Tipo de moneda. Ejemplo: CLP, USD

required
Array of objects

Movimientos de la cuenta

{
  • "taskStatus": "success",
  • "taskStatusCode": 200,
  • "results": {
    }
}

Transferencia

Action: [entityId]:transfer

type
required
string (TransferType)
Enum: "sent" "received"

Tipo de transferencia:

  • sent: Transferencia enviada
  • received: Transferencia recibida
amount
required
number

Monto

date
string <date>

Fecha de la transferencia

time
string\d{2}:\d{2}:\d{2}

Hora, minuto y segundo de la transferencia, formato HH:mm:ss

required
object (TransferAccount)

Representa al origen o destinatario de una transferencia

required
object (TransferAccount)

Representa al origen o destinatario de una transferencia

accountingDate
string <date>

Fecha contable de la transferencia

transactionId
string

Código de transacción

transactionType
string

Tipo de transferencia (glosa de la institución financiera)

status
string

Estado de la transacción

channel
string

Canal

{
  • "taskStatus": "success",
  • "taskStatusCode": 200,
  • "results": {
    }
}

Crédito de Consumo

Action: [entityId]:consumer-loan

Array
id
required
string

Identificador del crédito de consumo, también llamado Número de Operación o Número de Crédito

loanAmount
required
number

Monto solicitado del crédito

balance
number

Saldo actual, también llamado saldo contable

monthlyPayment
required
number

Valor de la cuota mensual

totalPaidFees
number

Número de cuotas pagadas

totalPayments
number

Número total de cuotas

monthlyInterestRate
number

Tasa de interés mensual

caev
number

Carga Anual Equivalente Vigente (CAEV), en %. Ejemplo, un valor de 4.12 representa un CAEV de 4.12%.

nextPaymentDate
required
string <date>

Fecha del próximo pago, tambien llamado fecha de próximo vencimiento

description
string

Descripción del crédito

type
string (ConsumerLoanType)
Enum: "direct" "indirect"

Tipo de deuda del crédito:

  • direct: Deuda directa
  • indirect: Deuda indirecta
state
string (ConsumerLoanState)
Enum: "active" "in-arrears"

Estado del crédito:

  • active: Activo o Válido
  • in-arrears: En Mora
expiredPayments
number

Número de cuotas vencidas

previousMonthPayment
number

Valor de la cuota pagada en mes anterior

lastPaymentAmount
number

Valor de la última cuota a pagar

protectionInsurance
boolean

Si tiene seguro de desgravamen

unemploymentInsurance
boolean

Si tiene seguro de cesantía

currency
string

Tipo de moneda

{
  • "taskStatus": "success",
  • "taskStatusCode": 200,
  • "results": {
    }
}

Crédito Hipotecario

Action: [entityId]:mortgage

Array
id
required
string

Identificador del crédito hipotecario, también llamado Número de Operación o Número de Mutuo

productName
required
string

Nombre del producto

initialBalanceUf
number

Monto solicitado en UF

balanceUf
required
number

Saldo actual en UF

term
required
number

Plazo en años

totalPayments
required
number

Número total de cuotas

currentPaymentNumber
required
number

Número de la cuota actual

closedPayments
required
number

Número de cuotas pagadas

nextPaymentDate
string <date>

Fecha del próximo pago

nextPaymentAmountUf
required
number

Monto del próximo dividendo en UF

caev
number

Carga Anual Equivalente Vigente (CAEV), en %. Ejemplo, un valor de 4.12 representa un CAEV de 4.12%.

interestRateType
string
Enum: "fixed" "variable" "mixed"

Tipo de tasa de interés aplicada:

  • fixed: Tasa de interés fija
  • variable: Tasa de interés variable
  • mixed: Tasa de interés mixta
interestRate
number

Tasa de interés

interestRateChangeDate
string <date>

Fecha en que corresponde un cambio de tasa si es variable

lastPaymentDate
string <date>

Fecha último pago

latePayments
number

Si tiene dividendos morosos/vencidos no pagados

latePaymentsAmountUf
number

Monto vencido no pagado, en UF

insurancesAmountUf
number

Monto de seguros en UF

{
  • "taskStatus": "success",
  • "taskStatusCode": 200,
  • "results": {
    }
}

Reporte de Inversiones

Action: [entityId]:investment-report

totalInvestmentAmountClp
required
number

Monto total de inversiones en CLP

required
object (TotalsByCurrency)
required
object

Instrumentos de inversión

investorProfile
required
string

Perfil de inversionista:

  • conservative: Conservador
  • moderate: Moderado
  • balanced: Balanceado
  • decisive: Decidido
  • aggressive: Agresivo
{
  • "taskStatus": "success",
  • "taskStatusCode": 200,
  • "results": {
    }
}

Estados de Cuenta Tarjetas de Crédito

Action: [entityId]:credit-card-statement

type
string

Tipo de tarjeta de crédito (Visa, Mastercard, etc)

name
string

Nombre asociado a la tarjeta de crédito.

singleCreditLimit
boolean

Indica si la tarjeta tiene cupo único.

cardHolderName
string

El nombre del titular de la tarjeta.

object

Estados de cuentas de la tarjeta por tipo de moneda

{
  • "taskStatus": "success",
  • "taskStatusCode": 200,
  • "results": {
    }
}

Reporte Financiero Consolidado

Action: [entityId]:financial-report

required
object (ProductBalanceData)

Saldos de Productos

required
Array of objects (AccountMovementData)

Movimientos de Cuenta

required
Array of objects (consumer-loan_ConsumerLoanData)

Crédito de Consumo

required
Array of objects (mortgage_MortgageData)

Crédito Hipotecario

required
object (investment-report_InvestmentReportData)

Reporte de inversiones

{
  • "taskStatus": "success",
  • "taskStatusCode": 200,
  • "results": {
    }
}

PAC

Action: [entityId]:pac

companyName
required
string

Nombre de la empresa

companyType
string

Rubro de la empresa nota: Este valor no se encuentra disponible para todas las entidades.

userId
required
string

Número o identificador de cuenta

paymentLimit
required
number

Monto límite de pago mensual

currency
required
string
Enum: "usd" "clp" "eur" "uf"

Tipo de moneda del límite de pago

{
  • "taskStatus": "success",
  • "taskStatusCode": 200,
  • "results": {
    }
}

PAT

Action: [entityId]:pat

alias
required
string

Nombre dado por el usuario

state
required
string

Estado

cardType
required
string

Tipo de tarjeta. Ejemplo: Mastercard, Visa

category
required
string

Rubro o tipo de servicio

companyName
required
string

Empresa/Producto

companyCode
string

Código de empresa

serviceId
required
string

Id del servicio

cardNumber
required
string

Número de la tarjeta de crédito (con últimos dígitos)

patStartDate
string

Inicio PatPass tarjeta

lastPaymentDate
string <date>

Fecha de último pago realizado

nextPaymentDate
string <date>

Fecha de próximo pago

firstPaymentDate
string <date>

Fecha de primer pago

number or string

Monto máximo a pagar

object

Datos de la persona a la cual pertenece el PAT

origin
string

Ejemplo: Emisor, Establecimiento

instructionType
string

Ejemplo: Mandato Electrónico, Mandato Físico

channel
string

Ejemplo: Web Cliente, Archivo

{
  • "taskStatus": "success",
  • "taskStatusCode": 200,
  • "results": {
    }
}

Análisis Financiero Bancario

Action: [entityId]:income-report

employerName
required
string

Nombre de la fuente del salario principal

seniority
required
number

Número de veces en que ha recibido el salario en los últimos 11 meses. (considerando desde hoy hacia atrás y solo de manera consecutiva)

salary
required
number

Monto promedio de salario pagado por employerName recibido en los últimos seniority meses

monthlyVariableIncome3Months
required
number

Monto promedio de ingresos extra de los últimos 3 meses

monthlyVariableIncome12Months
required
number

Monto promedio de ingresos extra de los últimos 12 meses

monthlyAccountFlow3Months
required
number

Monto promedio de ingresos menos egresos, de los últimos 3 meses

monthlyAccountFlow12Months
required
number

Monto promedio de ingresos menos egresos, de los últimos 12 meses

required
Array of objects (AccountFlowSource)

Detalle de las transacciones utilizadas para obtener monthlyAccountFlow12Months y monthlyAccountFlow3Months

required
Array of objects (IncomeSource)

Detalle de las transacciones utilizadas para obtener monthlyVariableIncome12Months, monthlyVariableIncome3Months y salary

{
  • "taskStatus": "success",
  • "taskStatusCode": 200,
  • "results": {
    }
}

Modelos Banca Empresas

A continuación se describen los modelos de los endpoints relacionados a Banca Empresas.

Validación de Identidad

Action: [entityId]:identity-validation

isValid
required
boolean

Indica si la identidad de la persona fue validada exitosamente utilizando el acceso a la institución financiera

{
  • "taskStatus": "success",
  • "taskStatusCode": 200,
  • "results": {
    }
}

Movimientos de Cuenta

Action: [entityId]:movement

Array
accountNumber
required
string

Número de cuenta

accountType
required
string

Tipo de cuenta. Ejemplos: "corriente", "vista", "rut"

productName
required
string

Ejemplos: "Cuenta RUT", "Chequera Electrónica", "Cuenta Corriente"

currentBalance
required
number

Saldo contable (Saldo disponible más saldo retenido)

availableBalance
required
number

Saldo disponible

withholdings
required
number

Saldo retenido

currency
required
string

Tipo de moneda. Ejemplo: CLP, USD

required
Array of objects

Movimientos de la cuenta

{
  • "taskStatus": "success",
  • "taskStatusCode": 200,
  • "results": {
    }
}

Saldos de Cuentas AFP

Action: [entityId]:account-balance

balance
required
number

Saldo Total

institutionCode
string

Código de institución de la Superintendencia de Pensiones

projectedPension
number or null

Pensión Proyectada

required
object

Cuentas

{
  • "taskStatus": "success",
  • "taskStatusCode": 200,
  • "results": {
    }
}

Modelos Servicios

A continuación se describen los modelos de los endpoints relacionados a Servicios.

Cuentas de Servicio

Action: [entityId]:bill

company
required
string

Compañia de servicio

alias
string

Nombre de la cuenta

userId
required
string

Número o identificador de cuenta

{
  • "taskStatus": "success",
  • "taskStatusCode": 200,
  • "results": {
    }
}

Modelos Servicios Estatales

A continuación se describen los modelos de los endpoints relacionados a Servicios Estatales.

Validación de Identidad

Action: [entityId]:identity-validation

isValid
required
boolean

Indica si la identidad de la persona fue validada exitosamente utilizando el acceso a la institución financiera

{
  • "taskStatus": "success",
  • "taskStatusCode": 200,
  • "results": {
    }
}

Carpeta Tributaria SII

Action: sii:tax-folder sii:tax-folder-clave-unica.
Action sii:tax-folder-pdf y sii:tax-folder-pdf-clave-unica incluyen en la key taxFolderPDF el pdf en base64 y el checksum en SHA-1 para su verificación

name
string

Nombre o razón social del contribuyente

rut
string

RUT

generationDatetime
string

Fecha y hora de generación de la carpeta

object

Datos del Contribuyente

object

Información proporcionada por el contribuyente para fines tributarios

Array of objects

Propiedades y bienes raíces

object

Boletas de honorarios electrónicas

object

Declaraciones de IVA (F29)

object

Declaraciones de Renta (F22)

object

PDF generado por el SII en formato base64 con su hash SHA-1 (solo incluido en sii:tax-folder-pdf y sii:tax-folder-pdf-clave-unica)

{
  • "taskStatus": "success",
  • "taskStatusCode": 200,
  • "results": {
    }
}

Situación Tributaria SII

Action: sii:tax-situation

fechaConsulta
string <date-time>
contribuyenteInicioActividades
boolean

Indica si el contribuyente presenta inicio de actividades

fechaInicioActividades
string <date>

Fecha de inicio de actividades

autorizadoImpuestosMonedaExtranjera
boolean

Indica si el contribuyente está autorizado para declarar y pagar impuestos en moneda extranjera

esEmpresaMenorTamanoProPyme
boolean

Es empresa de menor tamaño, según Ley N°20.416

Array of objects

Documentos timbrados

Array of objects

Actividades económicas vigentes

{
  • "taskStatus": "success",
  • "taskStatusCode": 200,
  • "results": {
    }
}

Pagos de Contribuciones SII

Action: sii:property-tax sii:property-tax-clave-unica

rollNumber
required
string

Número de Rol

communeName
required
string

Nombre de la comuna

siiCommuneId
integer

Id comuna del SII

trgCommuneId
integer

Id comuna de Tesoreria

blockId
required
integer

Id manzana

lotId
required
integer

Id predio

address
required
string

Dirección o nombre de la propiedad

ownerName
required
string

Nombre del propietario

hasPac
required
boolean

Indica si tiene PAC con la Tesoreria General de la República

userIsOwner
required
boolean

Indica si la persona que está consultando es el propietario

propertyUse
required
string

Destino o uso de la propiedad

required
Array of objects

Pagos

{
  • "taskStatus": "success",
  • "taskStatusCode": 200,
  • "results": {
    }
}

Documentos Tributarios Electrónicos (DTE) SII

Action: sii:invoice sii:invoice-clave-unica

Array of objects

DTE Emitidos

Array of objects

DTE Recibidos

{
  • "taskStatus": "success",
  • "taskStatusCode": 200,
  • "results": {
    }
}

Declaraciones Juradas SII

Action: sii:sworn-declaration sii:sworn-declaration-clave-unica

id
number

ID

dj
number

N° de formulario de la Declaración Jurada

folio
number

Folio

name
string

Titulo de la Declaración Jurada

status
string

Estado:

  • aceptada: Aceptada
  • observada: Observada
filingDatetime
string

Fecha y hora de presentación

filingChannel
string

Medio presentación

declarationType
string

Tipo de declaración

  • original: Original
  • rectificatoria: Rectificatoria
reportedCases
number

Casos reportados

object

Resumen de la Declaración

object

Detalle de la Declaración

{
  • "taskStatus": "success",
  • "taskStatusCode": 200,
  • "results": {
    }
}

Reporte de Deudas CMF

Action: cmf:debt

lastUpdatedDate
required
string

Última fecha de actualización

required
Array of objects (Debt)

Deuda directa

required
object (DirectOrIndirecDebtTotal)
required
Array of objects (Debt)

Deuda indirecta

required
object (DirectOrIndirecDebtTotal)
required
Array of objects (Credit)

Créditos disponibles (líneas de crédito)

required
object (AvailableOrOtherCreditTotal)
required
Array of objects (Credit)

Otros créditos disponibles

required
object (AvailableOrOtherCreditTotal)
{
  • "taskStatus": "success",
  • "taskStatusCode": 200,
  • "results": {
    }
}

Reporte de Seguros CMF

Action: cmf:insurance

company
required
string

Nombre de la aseguradora

type
required
string

Tipo de Seguro

branchCode
required
string

Ramo

code
required
string

Número o código del contrato

status
required
string

Estado

required
object

Asegurado

required
object

Contratante

object

Corredor

category
required
string
Enum: "individual" "collective"

Categoria (Colectiva/Individual)

collectiveStartDate
string <date>

Fecha inicio colectiva

collectiveEndDate
string <date>

Fecha termino colectiva

lastUpdatedDate
required
string

Fecha de última actualización

required
Array of objects (InsuranceCoverage)

Coverturas

{
  • "taskStatus": "success",
  • "taskStatusCode": 200,
  • "results": {
    }
}

Consolidado AFC

Action: afc:consolidate

balance
required
string

Saldo total

lastCreditedContributionDate
required
string <date>

Fecha de la última cotización acreditada

contributionsUpToDate
required
boolean

Cotizaciones al día

required
object (personal-information_PersonalInformationData)

Información Personal AFC

required
Array of objects (contribution_ContributionData)

Cotizaciones pagadas

required
Array of objects (job_JobData)

Empleadores

required
Array of objects (IncomeReportData)

Reporte de ingresos

{
  • "taskStatus": "success",
  • "taskStatusCode": 200,
  • "results": {
    }
}

Información Personal AFC

Action: afc:personal-information

name
required
string

Nombre

rut
required
string

RUT

birthDate
required
string <date>

Fecha de nacimiento

affiliationDate
required
string <date>

Fecha de afiliación

phone
string

Número de teléfono

email
string

Correo electrónico

street
string

Calle

number
string

Número

extra
string

Depto/block/sector/población/villa

region
string

Región

commune
string

Comuna

{
  • "taskStatus": "success",
  • "taskStatusCode": 200,
  • "results": {
    }
}

Cotizaciones AFC

Action: afc:contribution

date
required
string <date>

Periodo de la cotización

employerName
required
string

Razón social del empleador

monthlyIncome
required
number

Renta imponible

employerContribution
required
number

Monto cotizado por el empleador

employeeContribution
required
number

Monto cotizado por el empleado

{
  • "taskStatus": "success",
  • "taskStatusCode": 200,
  • "results": {
    }
}

Empleadores AFC

Action: afc:job

employerRut
required
string

RUT empleador

employerName
required
string

Razón social del empleador

contractType
required
string

Tipo de contrato

subscriptionDate
required
string <date>

Fecha de suscripción

startDate
required
string <date>

Fecha de inicio laboral

endDate
string <date>

Fecha de término laboral

activeEmployer
boolean

Empleador vigente

{
  • "taskStatus": "success",
  • "taskStatusCode": 200,
  • "results": {
    }
}

Reporte de ingresos AFC

Action: afc:income-report

activeEmployers
required
Array of strings

Empleadores activos

isEmployed
required
boolean

El afiliado tiene un contrato vigente con al menos un empleador de la key activeEmployers

averageMonthlyIncomeLastYear
required
number

Monto promedio de ingresos en el último año

averageMonthlyIncomeLast3Years
required
number

Monto promedio de ingresos en los útlimos 3 años

pnlIncomeLastYear
required
number

Variacion del ingreso del último año

monthlyIncome1YearAgo
required
number

Monto del ingreso de hace 1 año

monthlyIncome3YearsAgo
required
number

Monto del ingreso de hace 3 años

monthlyIncome
required
number

Monto del ingreso actual

monthsWithoutContributionsLastYear
required
number

Cantidad de meses sin cotizaciones en el último año

monthsWithoutContributionsLast3Years
required
number

Cantidad de meses sin cotizaciones en los últimos 3 años

monthsOfContributionsContinuity
required
number

Número de meses con continuidad de cotizaciones

{
  • "taskStatus": "success",
  • "taskStatusCode": 200,
  • "results": {
    }
}

Cartola Fiscal TGR

Action: sii:fiscal-statement sii:fiscal-statement-clave-unica

object

Datos del contribuyente

object

Cartola

{
  • "taskStatus": "success",
  • "taskStatusCode": 200,
  • "results": {
    }
}

Certificado de Nacimiento

Action: registro-civil:birth-certificate

folio
required
string

Folio

verificationCode
required
string

Código de verificación

issuingDatetime
required
string

Fecha y hora de emisión

expirationDate
required
string

Fecha de vencimiento

purpose
required
string

Uso del certificado

required
object

Datos del solicitante

district
required
string

Circunscripción

registrationNumber
required
integer

Número de inscripción

registry
string or null

Registro

registryYear
required
integer

Año de registro

run
required
string

RUN

registeredName
required
string

Nombre inscrito

birthDate
required
string

Fecha de nacimiento

birthTime
string or null

Hora de nacimiento

age
required
integer

Edad

gender
required
string

Sexo

fatherRun
string or null

RUN del Padre

fatherName
string or null

Nombre del Padre

motherRun
string or null

RUN de la Madre

motherName
string or null

Nombre de la Madre

required
Array of objects

Anotaciones

required
object

Certificado en PDF original en base64 y su checksum

{
  • "taskStatus": "success",
  • "taskStatusCode": 200,
  • "results": {
    }
}

Reporte Advanced Experian

Action: experian:advanced-report

required
object

Identificación

required
object

Resumen ejecutivo

required
object

Información adicional

required
object

Socios y Sociedades

required
object

Flags

{
  • "taskStatus": "success",
  • "taskStatusCode": 200,
  • "results": {
    }
}

Modelos Criptoactivos

A continuación se describen los modelos de los endpoints relacionados a Criptoactivos.

Balance de Criptoactivos

exchangeName
required
string

Nombre del Exchange desde donde se extrajo la información

totalBalanceUSD
required
number

Valor total, en USD, de los criptoactivos que el usuario posee en el Exchange (según precios al momento de la extracción de la información)

required
Array of objects (CryptoBalancePair)

Listado de criptoactivos que el usuario posee en el Exchange

{
  • "taskStatus": "success",
  • "taskStatusCode": 200,
  • "results": {
    }
}