Servicios de Automatización Financiera (1.0.0)
A continuación se describen los diferentes endpoints usados para los servicios de portabilidad disponibles con Synaptic.
- Para cada cliente (usuario final) se debe obtener un token de sesión en
/auth/login
. - Con el token obtenido, crear una tarea de extracción usado el endpoint
/tasks
, el cual entrega un identificador de tarea en curso. - Consultar por el estado del proceso de extracción usando el endpoint
/tasks/{taskId}
.
para mas información ver entidades y acciones
El servicio de portabilidad utiliza dos mecanismos de autenticación:
apiKey
: Autenticación mediante una API Key.token
: Autenticación con token de sesión.
Obtener token de sesión
Permite obtener el token de sesión para autenticar las solicitudes posteriores
Authorizations:
Responses
Request samples
- cURL
curl -X POST "https://${URL}/api/v1/auth/login" \ -H "X-API-Key: ${API_KEY}"
Response samples
- 200
- 401
- 429
{- "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:
Responses
Request samples
- cURL
curl -X POST "https://${URL}/api/v1/auth/is-token-valid" \ -H "Authorization: Bearer ${SESSION_TOKEN}"
Response samples
- 401
{- "message": "Jwt is expired"
}
Cada entidad tiene requisitos específicos en cuanto a contraseñas. El servicio realiza una comprobación en base a esto 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
.
Entidad | Componentes Requeridos | Longitud Contraseña | Caracteres Permitidos |
---|---|---|---|
Banco Chile | username password |
4 - 20 | Alfanumérico y símbolos:!@#$%^&*()-_=+{};:,<.> |
Banco Santander | username password |
4 - 10 | Alfanumérico y símbolos:~!@#$^*_=[]{}|;:,.?- |
Banco Estado | username password |
4 - 8 | Alfanumérico |
Banco BCI | username password |
4 - 8 | Alfanumérico |
Banco Falabella | username password |
6 | Numérico |
Banco Itaú | username password |
8 - 10 | Alfanumérico |
Banco Scotiabank | username password |
8 - 15 | Alfanumérico |
Banco Ripley | username password |
4 | Numérico |
Banco Security | username password |
4 - 20 | Alfanumérico |
Servipag | username password |
6 - 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.
Authorizations:
Request Body schema: application/json
Datos para la creación de la tarea de extracción.
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
- Payload
- cURL
Opción 1
{- "action": "banco-chile:tef",
- "args": {
- "username": "11.111.111-1",
- "password": "P4ssw0rd"
}
}
Response samples
- 200
- 401
- 403
- 422
- 429
{- "taskId": "string"
}
Consultar el estado del proceso de extracción
Consultar el estado y/o obtener los resultados de la extracción.
Authorizations:
path Parameters
taskId required | string ID de la tarea |
Responses
Request samples
- cURL
curl "https://${URL}/api/v1/tasks/${TASKID}" \ -H "Authorization: Bearer ${SESSION_TOKEN}"
Response samples
- 200
- 401
- 403
Extracción exitosa
{- "taskStatus": "success",
- "taskStatusCode": 200,
- "results": [
- {
- "entityId": "banco-chile",
- "data": [
- {
- "name": "Juan Pérez",
- "rut": "22.222.222-2",
- "bankName": "Banco Estado",
- "bankCode": "012",
- "accountNumber": "0-000-22-22222-2",
- "accountType": "corriente",
- "email": "juan.perez@gmail.com"
}
]
}
]
}
Obtener entidades y acciones disponibles
Consulta las entidades disponibles para la extracción y el listado de las acciones disponibles por entidad.
Authorizations:
Responses
Request samples
- cURL
curl "https://${URL}/api/v1/entities" \ -H "X-API-Key: ${API_KEY}"
Response samples
- 200
- 401
- 403
[- {
- "name": "Banco de Chile",
- "id": "banco-chile",
- "enabled": true,
- "actions": [
- {
- "name": "banco-chile:tef",
- "actionType": "tef",
- "enabled": true
}, - {
- "name": "banco-chile:bill",
- "actionType": "bill",
- "enabled": true
}
]
}, - {
- "name": "Banco Santander",
- "id": "banco-santander",
- "enabled": true,
- "actions": [
- {
- "name": "banco-santander:tef",
- "actionType": "tef",
- "enabled": true
}, - {
- "name": "banco-santander:bill",
- "actionType": "bill",
- "enabled": false
}
]
}
]
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:
Responses
Request samples
- cURL
curl -X POST "https://${URL}/api/v1/users/status/by-entity" \ -H "Authorization: Bearer ${SESSION_TOKEN}" \ -H "Content-Type: application/json" \ --data '{ "username": "${USERNAME}" "entity": "${ENTITY}" }'`
Response samples
- 200
- 401
{- "enabled": true,
- "retryAfter": null
}
A continuación se describen los modelos de los endpoints relacionados a Banca Personas.
isValid required | boolean Indica si la identidad de la persona fue validada exitosamente utilizando el acceso a la institución financiera |
{- "isValid": true
}
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 |
{- "company": "ENEL",
- "alias": "Luz",
- "userId": "1234567-8"
}
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 |
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. |
{- "name": "Juan Pérez",
- "rut": "11.111.111-1",
- "bankName": "Banco Estado",
- "bankCode": "012",
- "accountNumber": "0-000-22-22222-2",
- "accountType": "corriente",
- "email": "juan.perez@gmail.com"
}
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 |
{- "companyName": "ASEGURADORA X",
- "companyType": "Seguros",
- "userId": 1111111111,
- "paymentLimit": 2,
- "currency": "uf"
}
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 |
{- "alias": "Pat Alias",
- "state": "Inscrito",
- "cardType": "VISA",
- "category": "SEGUROS",
- "companyName": "ASEGURADORA X",
- "companyCode": "123123",
- "serviceId": "234234",
- "cardNumber": "***************2000",
- "patStartDate": "2019-09-11",
- "lastPaymentDate": "2021-04-13",
- "nextPaymentDate": "",
- "firstPaymentDate": "2019-11-08",
- "paymentLimit": "NO_LIMIT",
- "origin": "Establecimiento",
- "instructionType": "Mandato Físico",
- "channel": "Archivo",
- "owner": {
- "rut": "12312312-3",
- "name": "",
- "lastName": "",
- "mobilePhone": "",
- "phone": "",
- "address": "",
- "city": ""
}
}
type required | string (MovementType) Enum: "inflow" "outflow" Tipo de movimiento:
|
accountNumber required | string Identificador de la cuenta asociada al movimiento |
date required | string <date> Fecha del movimiento |
description | string Descripción |
channel | string Canal o sucursal |
documentNumber | string Número de documento |
amount required | number Monto |
balance | number Balance de la cuenta después de efectuado el movimiento |
{- "type": "outflow",
- "accountNumber": "0011111111",
- "date": "2021-04-01",
- "channel": "STGO. PRINCIPAL",
- "description": "TEF A CUENTA PROPIA N. 123123",
- "amount": 10959,
- "balance": 237130
}
type required | string (TransferType) Enum: "sent" "received" Tipo de transferencia:
|
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 |
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 |
{- "type": "sent",
- "amount": 190000,
- "date": "2021-05-05",
- "time": "10:39:56",
- "origin": {
- "accountNumber": "000076543218"
}, - "recipient": {
- "accountNumber": "000987654321",
- "bank": "Scotiabank",
- "email": "juan.perez@email.com",
- "rut": "111111111",
- "name": "Juan Pérez"
}, - "transactionId": "01000801234567891234567U",
- "transactionType": "Transferencia En Línea",
- "channel": "Internet",
- "status": "Realizada"
}
id required | string Identificador del crédito de consumo, también llamado Número de Operación o Número de Crédito |
humanReadableId required | string Versión legible para humanos del campo id |
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 | 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:
|
state | string (ConsumerLoanState) Enum: "active" "in-arrears" Estado del crédito:
|
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 Tiene seguro de desgravamen |
unemploymentInsurance | boolean Tiene seguro de desempleo |
currency | string Tipo de moneda |
{- "id": "50966556",
- "humanReadableId": "50966556",
- "loanAmount": 15000000,
- "monthlyPayment": 644686,
- "balance": 7091546,
- "totalPaidFees": 11,
- "totalPayments": 36,
- "monthlyInterestRate": 2.58,
- "caev": 19.08,
- "nextPaymentDate": "2022-06-05",
- "description": "CONSUMONLINE",
- "type": "direct",
- "state": "active",
- "expiredPayments": 0,
- "previousMonthPayment": 644686,
- "lastPaymentAmount": 644686,
- "protectionInsurance": true,
- "unemploymentInsurance": false,
- "currency": "CLP"
}
id required | string Identificador del crédito hipotecario, también llamado Número de Operación o Número de Mutuo |
humanReadableId required | string Versión legible para humanos del campo id |
productName | string Nombre del producto |
deedSignDate | string <date> Fecha de escritura |
initialBalanceUf | number Saldo inicial en UF |
balanceUf | number Saldo actual en UF |
totalPayments | number Total de cuotas del crédito hipotecario |
currentPaymentNumber | number Número de la cuota actual |
closedPayments | number Cuotas pagadas |
latePayments | number Cuotas morosas/vencidas no pagadas |
latePaymentsAmountUf | number Monto vencido no pagado, en UF |
caev | number Carga Anual Equivalente Vigente (CAEV), en %. Ejemplo, un valor de 4.12 representa un CAEV de 4.12%. |
interestRateType | string Tipo de tasa de interés aplicada. Ejemplo: Fija |
interestRateChangeDate | string <date> Fecha en que corresponde un cambio de tasa |
accountChargeDay | number Día de cargo a cuenta corriente |
nextPaymentDate | string <date> Próximo vencimiento |
lastPaymentDate | string <date> Fecha último pago |
valuationUf | number Valor tasación en UF |
insuredAmountUf | number Monto asegurado en UF |
nextPaymentAmountUf | number Monto del próximo pago en UF |
object Datos de la propiedad |
{- "id": "011-2-33-0555-100",
- "humanReadableId": "011-2-33-0555-100",
- "productName": "MHP Flexible Vivienda UF BCH -UF",
- "balanceUf": 1433.734,
- "nextPaymentAmountUf": 15.52,
- "nextPaymentDate": "2021-11-10",
- "currentPaymentNumber": 116,
- "totalPayments": 240,
- "closedPayments": 116,
- "caev": 4.32,
- "latePayments": 0,
- "latePaymentsAmountUf": 0,
- "interestRateType": "Fija",
- "interestRateChangeDate": "1900-01-01"
}
required | object Información de cuentas |
required | object or null |
required | object or null |
{- "accounts": {
- "totals": {
- "currentBalance": 4654956,
- "availableBalance": 4654956
}, - "details": [
- {
- "accountType": "corriente",
- "name": "Cuenta Corriente",
- "currentBalance": 4611431,
- "availableBalance": 4611431
}, - {
- "accountType": "rut",
- "name": "Cuenta RUT",
- "currentBalance": 43525,
- "availableBalance": 43525
}
]
}, - "creditLine": {
- "creditLimit": 5000000,
- "availableBalance": 5000000,
- "currentBalance": 0
}, - "creditCards": {
- "totals": {
- "clp": {
- "creditLimit": 1500000,
- "currentBalance": 0,
- "availableCredit": 1500000
}, - "usd": {
- "creditLimit": 3000,
- "currentBalance": 100,
- "availableCredit": 2900
}
}, - "details": [
- {
- "type": "Mastercard",
- "totals": {
- "clp": {
- "creditLimit": 1500000,
- "currentBalance": 0,
- "availableCredit": 1500000
}, - "usd": {
- "creditLimit": 3000,
- "currentBalance": 100,
- "availableCredit": 2900
}
}
}
]
}
}
Action: [entityId]:investment-report
totalInvestmentAmountClp required | number Monto total de inversiones en CLP |
required | object (TotalsByCurrency) |
required | object Instrumentos de inversión |
investorProfile | string Perfil de inversionista:
|
{- "totalInvestmentAmountClp": 38280282,
- "totalsByCurrency": {
- "usd": 2210.24,
- "clp": 20909844,
- "uf": 467.5222,
- "eur": 0
}, - "instruments": {
- "termDeposits": {
- "totalAmountClp": 11803222,
- "totalsByCurrency": {
- "usd": 2210.24,
- "clp": 0,
- "uf": 298.788,
- "eur": 0
}, - "data": [
- {
- "type": "fixed-term",
- "investmentDate": "2021-09-28",
- "expirationDate": "2021-12-26",
- "investmentAmount": 2168.94,
- "finalAmount": 2210.24,
- "termDays": 89,
- "periodInterestRate": 0.0781,
- "currency": "usd"
}, - {
- "type": "renewal-term",
- "investmentDate": "2021-08-28",
- "expirationDate": "2021-09-04",
- "investmentAmount": 298.3486,
- "finalAmount": 298.788,
- "termDays": 7,
- "periodInterestRate": 0.0768,
- "currency": "uf"
}
]
}, - "mutualFunds": {
- "totalAmountClp": 15872497,
- "totalsByCurrency": {
- "usd": 0,
- "clp": 10305281,
- "uf": 168.7342,
- "eur": 0
}, - "data": [
- {
- "description": "FONDO MUTUO CLEVER ACCIONARIO",
- "assetAmount": 1716.5227,
- "netAssetValue": 0.0983,
- "balance": 168.7342,
- "currency": "uf"
}, - {
- "description": "FONDO MUTUO SANTANDER CONSERVADOR",
- "assetAmount": 3981.9477,
- "netAssetValue": 2588,
- "balance": 10305281,
- "currency": "clp"
}
]
}, - "apvs": {
- "totalAmountClp": 10307753,
- "totalsByCurrency": {
- "usd": 0,
- "clp": 10307753,
- "uf": 0,
- "eur": 0
}, - "data": [
- {
- "description": "FONDO CONSERVADOR",
- "investmentAmount": 9737156,
- "fiscalDeposit": 570597,
- "balance": 10307753,
- "currency": "clp"
}
]
}, - "equities": {
- "totalAmountClp": 296810,
- "totalsByCurrency": {
- "usd": 0,
- "clp": 296810,
- "uf": 0,
- "eur": 0
}, - "data": [
- {
- "stockName": "CENCOSUD",
- "quantity": 18,
- "purchasePrice": 1217,
- "currentPrice": 1788.99,
- "totalAmount": 32202,
- "dividends": 6118,
- "profitPct": 0.0007,
- "currency": "clp"
}, - {
- "stockName": "CAP",
- "quantity": 28,
- "purchasePrice": 8670,
- "currentPrice": 9450.3,
- "totalAmount": 264608,
- "dividends": 34399,
- "profitPct": -0.3169,
- "currency": "clp"
}
]
}
}, - "investorProfile": "conservative"
}
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 |
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 |
required | Array of objects (IncomeSource) Detalle de las transacciones utilizadas para obtener |
{- "employerName": "TEF 12312312-5 SYNAPTIC SERVICIOS INF.",
- "seniority": 11,
- "salary": 866667,
- "monthlyVariableIncome3Months": 1148325,
- "monthlyVariableIncome12Months": 287081,
- "monthlyAccountFlow3Months": -460042,
- "monthlyAccountFlow12Months": -115010,
- "accountFlowSources": [
- {
- "type": "outflow",
- "name": "TEF 12312312-5 JUAN PEREZ",
- "amount": 2137300,
- "date": "2021-05-31"
}, - {
- "type": "outflow",
- "name": "TEF 12121212-5 COMUNIDAD EDIFI",
- "amount": 15000,
- "date": "2021-06-03"
}, - {
- "type": "inflow",
- "name": "TEF 12312312-5 SYNAPTIC SERVICIOS INF.",
- "amount": 1000000,
- "date": "2021-06-03"
}
], - "incomeSources": [
- {
- "type": "main",
- "name": "TEF 12312312-5 SYNAPTIC SERVICIOS INF.",
- "amount": 1000000,
- "date": "2021-06-03"
}, - {
- "type": "variable",
- "name": "TEF 76810627-4 FINTUAL ADMINIS",
- "amount": 5314,
- "date": "2021-06-08"
}
]
}
A continuación se describen los modelos de los endpoints relacionados a Banca Empresas.
isValid required | boolean Indica si la identidad de la persona fue validada exitosamente utilizando el acceso a la institución financiera |
{- "isValid": true
}
type required | string (MovementType) Enum: "inflow" "outflow" Tipo de movimiento:
|
accountNumber required | string Identificador de la cuenta asociada al movimiento |
date required | string <date> Fecha del movimiento |
description | string Descripción |
channel | string Canal o sucursal |
documentNumber | string Número de documento |
amount required | number Monto |
balance | number Balance de la cuenta después de efectuado el movimiento |
{- "type": "outflow",
- "accountNumber": "0011111111",
- "date": "2021-04-01",
- "channel": "STGO. PRINCIPAL",
- "description": "TEF A CUENTA PROPIA N. 123123",
- "amount": 10959,
- "balance": 237130
}
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 |
{- "company": "ENEL",
- "alias": "Luz",
- "userId": "1234567-8"
}
A continuación se describen los modelos de los endpoints relacionados a Servicios Estatales.
isValid required | boolean Indica si la identidad de la persona fue validada exitosamente utilizando el acceso a la institución financiera |
{- "isValid": true
}
Action: sii:tax-folder
nombre | string |
rut | string |
fechaGeneracion | string <date-time> |
object Datos del contribuyente | |
Array of objects (CompaniesInfo) Información proporcionada por el contribuyente para fines tributarios | |
Array of objects (Property) Propiedades y bienes raíces | |
Array of objects (BoletasInfo) Boletas de honorarios electrónicas | |
Array of objects (IvaDeclaration) Declaraciones de IVA Los códigos de cada campo del formulario se agregan como llaves a este objeto. | |
Array of objects (IncomeDeclaration) Declaraciones de renta (F22) Los códigos de cada campo del formulario se agregan como llaves a este objeto. |
{- "nombre": "NOMBRE APELLIDO",
- "rut": "11111111-1",
- "fechaGeneracion": "01/01/2021 11:05",
- "contribuyente": {
- "Fecha de Inicio de Actividades": "01-01-2021",
- "Actividades Económicas": [
- "ACTIVIDAD ECONOMICA 1",
- "000001 ACTIVIDADES DE XYZ"
], - "Categoría tributaria": "Segunda categoría",
- "Domicilio": "CALLE 123, SANTIAGO",
- "Sucursales": "",
- "Últimos documentos timbrados": {
- "BOLETAS DE HONORARIOS ELECTRONICAS": "01-01-2021"
}, - "Observaciones tributarias": "No tiene observaciones."
}, - "empresas": {
- "Representante(s) Legal(es)": [ ],
- "Conformación de la sociedad": [ ],
- "Participación en sociedades vigentes": [ ]
}, - "propiedadesBienesRaices": [
- {
- "comuna": "SANTIAGO",
- "rol": "00001-00001",
- "direccion": "CALLE 123",
- "destino": "HABITACIONAL",
- "avaluoFiscal": "20.000.000",
- "cuentasVencidasPorPagar": false,
- "cuentasVigentesPorPagar": false,
- "condicion": "AFECTO"
}
], - "boletas": {
- "porMes": [
- {
- "mes": "MARZO-21",
- "honorarioBruto": "10000",
- "retencionTerceros": "100",
- "ppm": "0"
}
], - "totales": {
- "honorarioBruto": "10000",
- "retencionTerceros": "100",
- "ppm": "0"
}
}, - "iva": [
- {
- "15": {
- "codigo": "15",
- "nombre": "PERIODO",
- "valor": "02 /2021"
}, - "periodo": "202102",
- "piePagina": {
- "Fecha de Presentación": {
- "nombre": "Fecha de Presentación",
- "valor": "02/02/2021"
}
}
}
], - "renta": [
- {
- "94": {
- "codigo": "94",
- "nombre": "TOTAL A PAGAR (Líneas 71+72+73)",
- "valor": "10000",
- "operacion": "=",
- "linea": "74"
}, - "119": {
- "codigo": "119",
- "nombre": "Remanente de crédito por Reliquidación del Impuesto Único de Segunda Categoría y/o por Ahorro Neto Positivo, proveniente de líneas 40 y/o 41.",
- "valor": "20000"
}, - "folio": "20123456",
- "periodo": "2019"
}
]
}
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 |
{- "fechaConsulta": "01-01-2021 17:01",
- "contribuyenteInicioActividades": true,
- "fechaInicioActividades": "01-01-2021",
- "autorizadoImpuestosMonedaExtranjera": false,
- "esEmpresaMenorTamanoProPyme": false,
- "documentosTimbrados": [
- {
- "nombre": "Facturas",
- "annoUltimoTimbraje": 2021
}, - {
- "nombre": "Factura No Afecta O Exenta Iva",
- "annoUltimoTimbraje": 2021
}
], - "actividadesEconomicas": [
- {
- "nombre": "ACTIVIDAD ECONOMICA",
- "codigo": "000001",
- "categoria": "Primera",
- "afectaIVA": true,
- "fecha": "01-01-2021"
}
]
}
Action: cmf:debt
required | Array of objects (Debt) Deuda directa |
object (DirectOrIndirecDebtTotal) | |
required | Array of objects (Debt) Deuda indirecta |
object (DirectOrIndirecDebtTotal) | |
required | Array of objects (Credit) Créditos disponibles (líneas de crédito) |
object (AvailableOrOtherCreditTotal) | |
required | Array of objects (Credit) Otros créditos disponibles |
object (AvailableOrOtherCreditTotal) |
{- "availableCredits": [
- {
- "directAmount": 2873878,
- "indirectAmount": 0,
- "entity": "Banco de Chile"
}, - {
- "directAmount": 460000,
- "indirectAmount": 0,
- "entity": "CMR Falabella"
}
], - "availableCreditsTotal": {
- "directAmount": 3333878,
- "indirectAmount": 0
}, - "directDebts": [
- {
- "currentDebt": 590822,
- "delay30to89": 0,
- "delay90": 0,
- "entity": "Banco de Chile",
- "total": 590822
}
], - "directDebtsTotal": {
- "currentDebt": 590822,
- "delay30to89": 0,
- "delay90": 0,
- "total": 590822
}, - "indirectDebts": [ ],
- "otherCredits": [ ]
}
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 |
{- "balance": 4954936,
- "lastCreditedContributionDate": "2022-10",
- "contributionsUpToDate": true,
- "personalInformation": {
- "name": "JUAN PEREZ",
- "rut": "12.312.312-5",
- "birthDate": "01-01-1988",
- "affiliationDate'": "01-01-2009",
- "phone": "54321054",
- "email": "juan.perez@email.com",
- "street": "Av. Siempre Viva",
- "number": "123",
- "extra": "Block A",
- "region": "Región RM",
- "commune": "SANTIAGO"
}, - "contributions": [
- {
- "date": "10-2022",
- "employerName": "SERVICIOS INFORMAT",
- "monthlyIncome": 2050872,
- "employerContribution": 32814,
- "employeeContribution": 12305
}, - {
- "date": "09-2022",
- "employerName": "SERVICIOS INFORMAT",
- "monthlyIncome": 2050872,
- "employerContribution": 32814,
- "employeeContribution": 12305
}, - {
- "date": "08-2022",
- "employerName": "SERVICIOS INFORMAT",
- "monthlyIncome": 2050872,
- "employerContribution": 32814,
- "employeeContribution": 12305
}, - {
- "date": "07-2022",
- "employerName": "SERVICIOS INFORMAT",
- "monthlyIncome": 2050872,
- "employerContribution": 32814,
- "employeeContribution": 12305
}
], - "employers": [
- {
- "employerRut": "77.777.777-7",
- "employerName": "SERVICIOS INFORMAT",
- "contractType": "DURACIÓN INDEFINIDA",
- "subscriptionDate": "10-04-2017",
- "startDate": "01-12-2016",
- "endDate": "",
- "activeEmployer": true
}, - {
- "employerRut": "88.888.888-8",
- "employerName": "SERVICIOS GENERALES LTDA",
- "contractType": "A PLAZO",
- "subscriptionDate": "13-05-2013",
- "startDate": "01-04-2013",
- "endDate": "17-06-2013",
- "activeEmployer": false
}
], - "incomeReport": {
- "activeEmployers": [
- "SERVICIOS INFORMAT"
], - "isEmployed": true,
- "averageMonthlyIncomeLastYear": 2000000,
- "averageMonthlyIncomeLast3Years": 2300000,
- "pnlIncomeLastYear": 500000,
- "monthlyIncome1YearAgo": 1700000,
- "monthlyIncome3YearsAgo": 2400000,
- "monthlyIncome": 2400000,
- "monthsWithoutContributionsLastYear": 2,
- "monthsWithoutContributionsLast3Years": 0,
- "monthsOfContributionsContinuity": 36
}
}
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 |
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 |
{- "name": "JUAN PEREZ",
- "rut": "12.312.312-5",
- "birthDate": "01-01-1988",
- "affiliationDate'": "01-01-2009",
- "phone": "54321054",
- "email": "juan.perez@email.com",
- "street": "Av. Siempre Viva",
- "number": "123",
- "extra": "Block A",
- "region": "Región RM",
- "commune": "SANTIAGO"
}
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 |
{- "date": "05-2022",
- "employerName": "SERVICIOS INFORMAT",
- "monthlyIncome": 2050872,
- "employerContribution": 32814,
- "employeeContribution": 12305
}
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 |
{- "employerRut": "77.777.777-7",
- "employerName": "SERVICIOS INFORMAT",
- "contractType": "DURACIÓN INDEFINIDA",
- "subscriptionDate": "10-04-2017",
- "startDate": "01-12-2016",
- "endDate": "",
- "activeEmployer": true
}
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 |
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 |
{- "activeEmployers": [
- "SERVICIOS INFORMAT"
], - "isEmployed": true,
- "averageMonthlyIncomeLastYear": 2000000,
- "averageMonthlyIncomeLast3Years": 2300000,
- "pnlIncomeLastYear": 500000,
- "monthlyIncome1YearAgo": 1700000,
- "monthlyIncome3YearsAgo": 2400000,
- "monthlyIncome": 2400000,
- "monthsWithoutContributionsLastYear": 2,
- "monthsWithoutContributionsLast3Years": 0,
- "monthsOfContributionsContinuity": 36
}
A continuación se describen los modelos de los endpoints relacionados a 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 |
{- "exchangeName": "BINANCE",
- "totalBalanceUSD": 377.39,
- "balances": [
- {
- "symbol": "BTC",
- "balance": 0.00288804,
- "balanceUSD": 138.03
}, - {
- "symbol": "ETH",
- "balance": 0.61982485,
- "balanceUSD": 214.78
}, - {
- "symbol": "BNB",
- "balance": 0.02274305,
- "balanceUSD": 24.58
}
]
}