Produtos
Desenvolvemos 11 tipos de produtos com propósitos diferentes:
Contas pessoais
- Category_checking
- Category_creditcard
- Income
- Liabilities
- Financial_insight
- Score_k1 (beta)
- FGTS
Investimento
- Investment
Contas de empresas
- Corporate_checking
Economia compartilhada
- Gig_economy
KYC
- Identity
- Balance
- Auth_account(em breve)
- Auth_creditcard(em breve)
Estrutura comum em todos os relatórios de dados
Além da estrutura comum, a especificação do relatório é diferente para cada tipo de relatório e você pode encontrar informações completas dos pontos de dados conforme abaixo.
Category_checking
Transações de conta corrente dos últimos 3 a 6 meses incluindo data, valores, descrição, saldo após transação e categoria da transação.
Campo | Tipo | Descrição |
enquiry_cpf | string | CPF providenciado pelo usuário |
user_consent | string | Consentimento do usuário para acesso e uso dos dados (“Yes” ou “No”) |
allow_autoupdate | string | Opt-in do usuário para atualização automática (“Yes” ou “No”) |
connection_key | string | Chave específica por conexão |
connection_id | string | ID único para uma conexão específica |
institution_id | string | ID da instituição |
report_type | string | Indica o tipo de relatório |
report_id | string | ID único de cada relatório |
report_version | string | Código de versão de relatório |
Category_checking | object | Objeto, mais de um podem existir |
bank_name | string | Nome do banco |
bacen_name | string | Nome da instituição no Banco Central |
bacen_id | string | Código da instituição no Banco Central |
bank_branch | string | Número da agência |
account | string | Número da conta |
operation_code | string | Tipo de operação da conta |
cpf_verified | string | CPF na instituição |
holder_name | string | Nome do dono da conta |
balance | number | Saldo da conta no momento da conexão |
transactionDetail | object | Detalhes das transações |
trans_date | string | Data da transação |
trans_amount | number | Valor da transação |
trans_description | string | Descrição da transação |
balance | number | Saldo após a transação |
category | string | Categoria da transação |
Exemplo de resposta
Category_creditcard
Transações de cartão de crédito dos últimos 3 a 6 meses incluindo data, valores, descrição e categoria da transação. Dados de limite de crédito incluso.
Campo | Tipo | Descrição |
enquiry_cpf | string | CPF providenciado pelo usuário |
user_consent | string | Consentimento do usuário para acesso e uso dos dados (“Yes” ou “No”) |
allow_autoupdate | string | Opt-in do usuário permitindo atualização automática (“Yes” ou “No”) |
connection_key | string | Chave específica por conexão |
connection_id | string | ID único para uma conexão específica |
institution_id | string | ID da instituição |
report_type | string | Indica o tipo de relatório |
report_id | string | ID único de cada relatório |
report_version | string | Código de versão de relatório |
Category_creditcard | Object | Objeto, mais de um podem existir |
bank_name | string | Nome do banco |
bacen_name | string | Nome da instituição no Banco Central |
bacen_id | string | Código da instituição no Banco Central |
card_last4num | string | Últimos dígitos do cartão |
cpf_verified | string | CPF na instituição |
holder_name | string | Nome no cartão |
card_type | string | Tipo de cartão |
credit_limit | number | Limit de crédito total (se is_vip=1, mostrar “999999”) |
available_limit | number | Limite de crédito disponível (se is_vip=1, mostrar “999999”) |
agency_number | string | Número da agência |
bank_account | string | Número da conta |
is_active | number | Se o cartão é ativo (0:No, 1:Yes) |
is_vip | number | Cartão sem limite (0:No, 1:Yes) |
openStatement | object | Fatura aberta |
bill_amount | number | Valor da fatura |
due_date | string | Data de pagamento |
billing_date | string | Data de fechamento |
bill_month | string | Mês da fatura |
transactionDetail | object | Detalhes das transações |
trans_date | string | Data |
trans_amount | number | Valor total |
trans_currency | string | Moeda (USD: US$, BRL: R$) |
trans_description | string | Descrição |
category | string | Categoria da transação |
payment_type | string | Tipo de transação em parcelas, "A_PRAZO" para parcelas, "A_VISTA" para parcelas não-instaladas |
charge_identificator | string | Identificador da parcela que está sendo informada, "PARCELA_x". Para transações de não-instalação, é "PARCELA_0". |
charge_number | number | Quantidade de parcelas. Para transações de não-instalação, é "0". |
closedStatement | object | Faturas fechadas |
billing_date | string | Data de fechamento |
bill_month | string | Mês da fatura |
bill_amount | number | Valor total |
minimum_payment | number | Valor mínimo |
payment_amount | number | Valor pago |
payment_date | string | Dia do valor pago |
transactionDetail | object | Detalhes das transações |
trans_date | string | Data |
trans_amount | number | Valor total |
trans_currency | string | Moeda (USD: US$, BRL: R$) |
trans_description | string | Descrição |
category | string | Categoria da transação |
payment_type | string | Tipo de transação em parcelas, "A_PRAZO" para parcelas, "A_VISTA" para parcelas não-instaladas |
charge_identificator | string | Identificador da parcela que está sendo informada, "PARCELA_x". Para transações de não-instalação, é "PARCELA_0". |
charge_number | number | Quantidade de parcelas. Para transações de não-instalação, é "0". |
Exemplo de resposta
Income
Este relatório cobre diferentes fontes de renda como salário e pensão.
Campo | Tipo | Descrição |
enquiry_cpf | string | CPF providenciado pelo usuário |
user_consent | string | Consentimento do usuário para acesso e uso dos dados (“Yes” ou “No”) |
allow_autoupdate | string | Opt-in do usuário permitindo atualização automática (“Yes” ou “No”) |
connection_key | string | Chave específica por conexão |
connection_id | string | ID único para uma conexão específica |
institution_id | string | ID da instituição |
report_type | string | Indica o tipo de relatório |
report_id | string | ID único de cada relatório |
report_version | | Código de versão de relatório |
income | object | Detalhes de renda nos últimos 180 dias (se existirem) |
bank_name | string | Nome do banco |
bacen_name | string | Nome da instituição no Banco Central |
bacen_id | string | Código da instituição no Banco Central |
agency_number | string | Número da agência |
account_number | string | Número de conta corrente |
cpf_verified | string | CPF na instituição |
account_holder | string | Nome do dono da conta |
days_covered | number | Número de dias cobertos |
number_of_income_streams | number | Número de fontes de rendas identificados |
total_income_last_30_days | number | Renda total nos últimos 30 dias (ou até os dias cobertos se menos dias estiverem disponíveis) |
total_income_last_60_days | number | Renda total nos últimos 60 dias (ou até os dias cobertos se menos dias estiverem disponíveis) |
total_income_last_90_days | number | Renda total nos últimos 90 dias (ou até os dias cobertos se menos dias estiverem disponíveis) |
total_income_last_180_days | number | Renda total nos últimos 180 dias (ou até os dias cobertos se menos dias estiverem disponíveis) |
incomeStream | object | Detalhes de fontes de renda nos últimos 180 dias (se existirem) |
income_stream_type | string | Fontes de renda podem ser: salário, bônus, rendimentos de empresa, aposentadoria, pensão |
incomeDay | object | Dia de recebimento da renda (aplicável ao salário, pensão de aposentadoria, pensão de patrocínio, apoio governamental apenas) |
1st_income_day | string | 1º dia de recebimento de renda (aplicável ao salário, pensão de aposentadoria, pensão de apadrinhamento, apoio governamental apenas) |
2nd_income_day | string | 2º dia de recebimento de renda (aplicável ao salário, pensão de aposentadoria, pensão de apadrinhamento, apoio governamental apenas) |
incomeTransactions | object | Detalhes das transações de receita por fluxo de receita |
trans_date | string | Data da transação |
trans_amount | number | Valor da transação |
trans_description | string | Descrição da transação |
Exemplo de resposta
Liabilities
Este relatório cobre diferentes fontes de dívidas como cartão de crédito e hipoteca.
Campo | Tipo | Descrição |
enquiry_cpf | string | CPF providenciado pelo usuário |
user_consent | string | Consentimento do usuário para acesso e uso dos dados (“Yes” ou “No”) |
allow_autoupdate | string | Opt-in do usuário permitindo atualização automática (“Yes” ou “No”) |
connection_key | string | Chave específica por conexão |
connection_id | string | ID único para uma conexão específica |
institution_id | string | ID da instituição |
report_type | string | Indica o tipo de relatório |
report_id | string | ID único de cada relatório |
report_version | string | Código de versão de relatório |
liabilities | object | Detalhes de renda nos últimos 180 dias (se existirem) |
bank_name | string | Nome do banco |
bacen_name | string | Nome da instituição no Banco Central |
bacen_id | string | Código da instituição no Banco Central |
agency_number | string | Número da agência |
account_number | string | Número de conta corrente |
cpf_verified | string | CPF na instituição |
account_holder | string | Nome do dono da conta |
days_covered | number | Número de dias cobertos |
number_of_liability_streams | number | Número de fontes de dívidas identificados |
total_liabilities_last_30_days | number | Dívida total nos últimos 30 dias (ou até os dias cobertos se menos dias estiverem disponíveis) |
total_liabilities_last_60_days | number | Dívida total nos últimos 60 dias (ou até os dias cobertos se menos dias estiverem disponíveis) |
total_liabilities_last_90_days | number | Dívida total nos últimos 90 dias (ou até os dias cobertos se menos dias estiverem disponíveis) |
total_liabilities_last_180_days | number | Dívida total nos últimos 180 dias (ou até os dias cobertos se menos dias estiverem disponíveis) |
liabilityStream | object | Detalhes de fontes de dívida nos últimos 180 dias (se existirem) |
liability_stream_type | string | Fontes de dívidas podem ser: cartão de crédito, hipoteca, empréstimo para estudante, empréstimo bancário, outras transferências recorrentes |
liabilityTransactions | object | Detalhes de faturas fechadas |
trans_date | string | Date |
trans_amount | number | Valor total |
trans_description | string | Descrição |
Exemplo de resposta
Financial_insight
Este relatório cobre análises de fluxo de caixa, crédito (cheque especial e empréstimo pré aprovado), cartão de crédito, e outros dados relevantes como pagamento de IPVA e IPTU.
Campo | Tipo | Descrição |
enquiry_cpf | string | CPF providenciado pelo usuário |
user_consent | string | Consentimento do usuário para acesso e uso dos dados (“Yes” ou “No”) |
allow_autoupdate | string | Opt-in do usuário permitindo atualização automática (“Yes” ou “No”) |
connection_key | string | Chave específica por conexão |
connection_id | string | ID único para uma conexão específica |
institution_id | string | ID da instituição |
report_type | string | Indica o tipo de relatório |
report_id | string | ID único de cada relatório |
report_version | string | Código de versão de relatório |
cashflowAnalysis | object | Análise de fluxo de caixa de 180 dias (se existir) |
bank_name | string | Nome do banco |
bacen_name | string | Nome da instituição no Banco Central |
bacen_id | string | Código da instituição no Banco Central |
agency_number | string | Número Da agência |
account_number | string | Número de conta corrente |
cpf_verified | string | CPF na instituição |
account_holder | string | Titular Da conta |
days_covered | number | Número de dias cobertos |
checking_account_balance | number | Saldo |
avg_daily_balance_last_30_days | number | Média de saldo no final do dia nos últimos 30 dias (ou até os dias cobertos se menos dias estiverem disponíveis) |
avg_daily_balance_last_60_days | number | Média de saldo no final do dia nos últimos 60 dias (ou até os dias cobertos se menos dias estiverem disponíveis) |
avg_daily_balance_last_90_days | number | Média de saldo no final do dia nos últimos 90 dias (ou até os dias cobertos se menos dias estiverem disponíveis) |
avg_daily_balance_last_180_days | number | Média de saldo no final do dia nos últimos 180 dias (ou até os dias cobertos se menos dias estiverem disponíveis) |
inflow_last_30_days | number | Total de entradas nos últimos 30 dias (ou até os dias cobertos se menos dias estiverem disponíveis) |
inflow_last_60_days | number | Total de entradas nos últimos 60 dias (ou até os dias cobertos se menos dias estiverem disponíveis) |
inflow_last_90_days | number | Total de entradas nos últimos 90 dias (ou até os dias cobertos se menos dias estiverem disponíveis) |
inflow_last_180_days | number | Total de entradas nos últimos 180 dias (ou até os dias cobertos se menos dias estiverem disponíveis) |
outflow_last_30_days | number | Total de saídas nos últimos 30 dias (ou até os dias cobertos se menos dias estiverem disponíveis) |
outflow_last_60_days | number | Total de entradas nos últimos 60 dias (ou até os dias cobertos se menos dias estiverem disponíveis) |
outflow_last_90_days | number | Total de entradas nos últimos 90 dias ou até os dias cobertos se menos dias estiverem disponíveis) |
outflow_last_180_days | number | Total de entradas nos últimos 180 dias ou até os dias cobertos se menos dias estiverem disponíveis) |
savings_account_balance | number | Saldo atual da poupança (“-1” se não disponível) |
creditAnalysis | object | Análise de crédito de 180 dias (se existir) |
bank_name | string | Nome do banco |
bacen_name | string | Nome da instituição no Banco Central |
bacen_id | string | Código da instituição no Banco Central |
account_number | string | Número de conta corrente |
overdraft_limit | number | Limite de cheque especial (“-1” se não disponível) |
preapproved_loan | number | Empréstimo pré aprovado (“-1” se não disponível) |
creditcardSpending | object | Análise de cartão de crédito de 180 dias (se existir) |
bank_name | string | Nome do banco |
bacen_name | string | Nome da instituição no Banco Central |
bacen_id | string | Código da instituição no Banco Central |
card_holder | string | Nome do usuário do cartão |
card_last_4_digit | string | Últimos 4 dígitos do cartão |
card_type | string | Tipo do cartão |
credit_limit | number | Limite de crédito |
closed_bills_covered | number | Número de faturas fechadas cobertas |
open_bill_balance | number | Valor da fatura em aberto |
last_closed_bill | number | Valor da última fatura fechada |
avg_last_3_closed_bills | number | Média de valores das últimas 3 faturas fechadas (ou até os dias cobertos se menos dias estiverem disponíveis) |
days_covered | number | Extent of data covered for the credit card account |
has_late_payment | string | Pagamento atrasado nos dias cobertos? ("Yes" ou "No") |
pay_bills_in_installment | string | Compras parceladas nos últimos 180 dias? ("Yes" ou "No") |
financialProfile | object | Perfil financeiro de 180 dias (se existir) |
bank_name | string | Nome do banco |
bacen_name | string | Nome da instituição no Banco Central |
bacen_id | string | Código da instituição no Banco Central |
account_number | string | Número da conta corrente |
days_covered | number | Número de dias cobertos |
has_severance | string | Recebimento de rescisão ("Yes" ou "No") |
has_inss | string | Transação de INSS ("Yes" ou "No") |
has_returned_cheque | string | Cheque retornado ("Yes" or "No") |
has_ipva_payment | string | Transação de IPVA ("Yes" ou "No") |
has_iptu_payment | string | Transação de IPTU ("Yes" ou "No") |
overdraft_interest | number | Valor de juros pagos no cheque especial |
additional_overdraft_interest | number | Valores de juros adicionais pagos no cheque especial |
atm_withdrawal | number | Total de saques |
iof | number | Total de IOF pago |
Examplo de resposta
Score_k1
Com base em dados de transações bancárias, essa pontuação de crédito prevê a possibilidade de inadimplência no pagamento com cartão de crédito. Pode ser usado como pontuação de referência para avaliação de risco.
Campo | Tipo | Descrição |
enquiry_cpf | string | CPF providenciado pelo usuário |
user_consent | string | Consentimento do usuário para acesso e uso dos dados (“Yes” ou “No”) |
allow_autoupdate | string | Opt-in do usuário permitindo atualização automática (“Yes” ou “No”) |
connection_key | string | Chave específica por conexão |
connection_id | string | ID único para uma conexão específica |
institution_id | string | ID da instituição |
report_type | string | Indica o tipo do relatório |
report_id | string | ID único de cada relatório |
report_version | string | Código de versão de relatório |
accountInfo | object | Informação da conta |
bank_name | string | Nome do banco |
bacen_name | string | Nome da instituição no Banco Central |
bacen_id | string | Código da instituição no Banco Central |
agency_number | string | Número da agência |
account_number | string | Número da conta corrente |
cpf_verified | string | CPF na instituição |
holder_name | string | Nome da instituição |
scoreDetail | object | Detalhe da pontuação |
score_k1 | number | Klavi Score_k1 do usuário |
version | string | Versão da pontuação |
Exemplo de resposta
FGTS
Informações sobre a conta do FGTS
Campo | Tipo | Descrição |
enquiry_cpf | string | CPF providenciado pelo usuário |
user_consent | string | Consentimento do usuário para acesso e uso dos dados (“Yes” ou “No”) |
allow_autoupdate | string | Opt-in do usuário para atualização automática (“Yes” ou “No”) |
connection_key | string | Chave específica por conexão |
connection_id | string | ID único para uma conexão específica |
institution_id | string | ID da instituição |
report_type | string | Indica o tipo de relatório |
report_id | string | ID único de cada relatório |
report_version | string | Código de versão de relatório |
personalInfo | Object | Informação pessoal |
cpf_verified | string | CPF registrado na Instituição |
holder_name | string | Nome registrado na Instituição |
address | string | Rua do endereço de correspondência |
city | string | Cidade do endereço de correspondência |
state | string | Estado do endereço de correspondência |
country | string | País do endereço de correspondência |
post_code | string | Código postal do endereço de correspondência |
latest_withdraw_type | string | O tipo de saque mais recente do usuário |
has_birthday_withdrawal | string | Se o usuário tem ou não saque aniversário |
latest_birthday_withdrawal_date | string | A data da última saque aniversário |
string | Endereço de e-mail registrado na Instituição | |
withdrawalDetail | object | Detalhes do registro de saque |
withdrawal_date | string | A data de saque |
withdrawal_description | string | A descrição da saque |
withdrawal_amount | string | O valor do saque |
bankAccount | object | As informações da conta bancária para saque |
bank_name | string | Nome do banco |
agency_number | string | Número da agência |
account_number | string | Número da conta |
account_type | string | Tipo da conta |
accountInfo | Object | As informações da conta do FGTS |
pis_pasep | string | O número de PIS/PASEP |
company_name | string | O nome da empresa |
company_cnpj | string | O número do CNPJ da campanhia |
work_permit | string | Carteira de trabalho |
account_type | string | Tipo da conta |
category | string | Categoria |
fgts_account | string | Número da conta |
admission_date | string | Data de admissão |
movement_code | string | Código do afastamento |
operation_date | string | Data do afastamento |
interest_rate | number | Taxa de juros |
amount_for_termination | number | Valor para fins rescisórios |
balance | number | Saldo de conta |
transactionDetail | object | Detalhes das transações |
trans_date | string | Data da transação |
trans_description | string | Descrição da transação |
trans_amount | number | Valor da transação |
trans_balance | number | Saldo após a transação |
exceptionalWithdrawal | object | Detalhes das saque extraordinário |
available_for_exc_withdrawal | number | Valor disponível para saque |
excpected_payment_date | string | Data prevista para pagamento |
exceptionalWithdrawalBank | object | As informações da conta bancária do saque extraordinário |
bank_name | string | Nome do banco |
agency_number | string | Número da agência |
account_number | string | Número da conta |
account_type | string | Tipo da conta |
Example responses
Investment
Dados de investimento incluindo detalhes de conta, produtos e portfólio.
Campo | Tipo | Descrição |
enquiry_cpf | string | CPF providenciado pelo usuário |
user_consent | string | Consentimento do usuário para acesso e uso dos dados (“Yes” ou “No”) |
allow_autoupdate | string | Opt-in do usuário permitindo atualização automática (“Yes” ou “No”) |
connection_key | string | Chave específica por conexão |
connection_id | string | ID único para uma conexão específica |
institution_id | string | ID da instituição |
report_type | string | Indica o tipo do relatório |
report_id | string | ID único de cada relatório |
report_version | string | Código de versão de relatório |
personalInfo | Object | Informação pessoal |
cpf_verified | string | CPF registrado na Instituição |
name | string | Nome registrado na Instituição |
birthday | string | Aniversário registrado na Instituição |
cellphone | string | Celular registrado na Instituição |
home_phone | string | Telefone residencial registrado na Instituição |
string | Endereço de e-mail registrado na Instituição | |
id_type | string | Tipo de identificação registrada na instituição |
id_number | string | Número de identificação registrado na instituição |
gender | string | Gênero registrado na Instituição |
fathers_name | string | Nome do pai registrado na Instituição |
marital_status | string | Estado civil registrado na Instituição |
spouse_name | string | Nome do cônjuge registrado na Instituição |
profession | string | Profissão registrada na Instituição |
title | string | Título registrado na Instituição |
company | string | Empresa registrada na Instituição |
correspondenceAddress | Object | Endereço para correspondência registrado na Instituição |
post_code | string | Código postal do endereço de correspondência |
address | string | Rua do endereço de correspondência |
address_number | string | Número da rua do endereço de correspondência |
neighborhood | string | Bairro do endereço de correspondência |
complement | string | Complemento do endereço de correspondência |
city | string | Cidade do endereço de correspondência |
state | string | Estado do endereço de correspondência |
country | string | País do endereço de correspondência |
suitability | string | Estilo de investimento ou resultado da avaliação de aptidão |
accountInfo | object | Dados da conta |
institution | string | Nome da instituição |
bacen_name | string | Nome da instituição no Banco Central |
bacen_id | string | Código da instituição no Banco Central |
agency | string | Agência |
account_number | string | Conta |
total_balance | number | Saldo total (saldo da conta + saldo investimento + saldo poupança) |
account_balance | number | Saldo da conta |
investment_balance | number | Saldo investimento |
savings_balance | number | Saldo da poupança (se aplicável) |
investmentDetail | object | Detalhes do produto de investimento |
investmentType | object | Dados de tipos de investimento |
investment_type | string | Tipo de investimento |
investment_type_balance | number | Saldo desse investimento |
productInfo | object | Saldo do produto de investimento |
productInfo de Fixed Income (renda fixa)
Campo | Tipo | Descrição |
productInfo | object | Detalhes de renda fixa |
product_type | string | Tipo de produto específico |
product_id | string | Nome do produto de investimento |
bank_issuer | string | Banco emissor |
fund_type | string | Tipo do fundo |
index | string | Índex |
index_rate | string | Taxa de índex |
spread | string | Spread (apenas juros prefixado) |
issue_date | date | Data de emissão |
due_date | date | Data de vencimento |
liquidity_date | date | Data de liquidez |
custody | string | Custódia |
ISIN | string | ISIN |
balance | number | Saldo do produto |
productInfo de Variable Income (renda variável)
Campo | Tipo | Descrição |
productInfo | object | Detalhe de renda variável |
product_type | string | Tipo de produto específico |
product_id | string | Nome do produto de investimento |
balance | number | Saldo do produto |
quantity | number | Quantidade atual do produto |
profitability | number | Rentabilidade atual do produto |
average_price | number | Preço médio atual do produto |
position | number | 1: Sim, 0: Não |
productInfo de Direct Treasury and Government Bonds (tesouro direto e título público)
Campo | Tipo | Descrição |
productInfo | object | Detalhes de tesouro direto e título público |
product_type | string | Tipo do produto específico |
product_id | string | Nome do produto de investimento |
balance | number | Saldo do produto |
due_date | date | Data de vencimento |
productInfo para produtos de investimento estilo de reserva de IPO
Campo | Tipo | Descrição |
productInfo | object | Detalhes do produto de investimento |
product_type | string | Tipo de produto de investimento específico (reserva de IPO) |
product_code | string | Código do produto |
ipo_company | string | Nome da empresa deste IPO |
ipo_available_period | date | Data do período disponível deste IPO |
ipo_type | string | Tipo deste IPO |
ipo_offer | string | Instituição que oferece este IPO |
ipo_broker | string | Instituição da corretora onde os usuários reservam este IPO |
quantity | number | Quantidade desta reserva de IPO |
price | number | Preço desta reserva IPO |
applied_amount | number | Valor desta reserva de IPO |
product_isin | string | Código ISIN (International Securities Identification Number) deste produto |
book_method | string | Método de reserva deste IPO |
booked_quantity | number | Quantidade reservada com sucesso deste IPO |
booked_amount | number | Valor reservado com sucesso para este IPO |
Examplo de resposta