Segurança

📘
BTG Id
O Authorization Server do BTG Empresas se chama BTG Id. Usando o BTG Id, um aplicativo parceiro consegue consentimento e autorização para executar operações nas APIs do BTG em nome do cliente. Para saber mais, acesse a documentação do BTG Id

Escopos necessários

O token para consumir a API de leads de crédito deve ser gerado usando o Client credentials.

É necessário informar o seguinte escopo na realização do fluxo:

Escopo	Descrição
brn:btg:empresas:kgiro:workflow	Acesso ao workflow de leads de crédito

Eventos de Webhook

A API de Leads de crédito tem seus webhooks divididos em duas famílias de eventos: Eventos de motor de crédito e evento de mudança de status.

Os payloads disponíveis abaixo representam o conteúdo do campo data, seguindo o formato do envio descrito em Eventos.

Eventos de motor de crédito

Evento	Descrição
credit-kgiro.kgiro-analyzed	Resposta da análise de capital de giro
credit-kgiro.overdraft-analyzed	Resposta da análise de limite da conta
credit-kgiro.card-analyzed	Resposta da análise de cartão de crédito
credit-kgiro.collection-receivable-analyzed	Resposta da análise de desconto de duplicatas
credit-kgiro.card-receivable-analyzed	Resposta da análise de antecipação de recebíveis de cartão

Payload

{
        "externalId": "593211b78a1-60d-4155-bb812322133123",
        "status": "Released",
        "approvedAmount": 100000.00,
        "expirationDate": "2025-12-31",
        "taxId": "CNPJ",
        "indexCode": "PRE", // CDI, PRE, NIPCA
        "fundingType": "BTG", //BTG, BNDES
        "product": "KGIRO",
        "quotes": [
            {
                "rate": 0.5,
                "minTerm": 12,
                "maxTerm": 60,
                "minGracePeriod": 3,
                "maxGracePeriod": 12,
                "rateFrequency": "MENSAL"
            }
        ],
        "guarantors": [
            {
                "type": "SIMPLES",
                "guarantorIdentification": "CPF"
            },
            {
                "type": "COMPLETO",
                "guarantorIdentification": "CPF"
            }
        ]
}

Campo	Descrição
externalId	Identificador da proposta, informado pelo sistema externo na criação da proposta
status	Status da proposta - `Released` (Aprovado), `NotApproved` (Não aprovado)
approvedAmount	Valor aprovado em reais
expirationDate	Data de expiração da proposta
taxId	Documento do cliente
indexCode	Indexador da taxa aprovada na proposta - `PRE`, `CDI`, `NIPCA`
product	Produto analisado - `KGIRO`, `LIMITE_MAIS`, `CARTAO_DE_CREDITO`, `ANTECIPACAO_DE_RECEBIVEIS_CARTAO`, `ANTECIPACAO_DE_RECEBIVEIS_BOLETOS`
quotes	Condições financeiras aprovadas (apenas quando o `product` tem os valores `ANTECIPACAO_DE_RECEBIVEIS_BOLETOS` ou `KGIRO`)
quotes.rate	Taxa aprovada
quotes.minTerm	Mínimo de parcelas
quotes.maxTerm	Máximo de parcelas
quotes.minGracePeriod	Mínimo de tempo de carência
quotes.maxGracePeriod	Máximo de tempo de carência
quotes.rateFrequency	Frequência da taxa - `MENSAL`, `ANUAL`
guarantors	Avalistas da operação
guarantors.type	Tipo de avalista - `SIMPLES`, `COMPLETO`
guarantors.guarantorIdentification	Documento do avalista

Eventos de mudança de status

Evento	Descrição
credit-kgiro.changed-status	Mudança de status

Payload

{
        "taxId": "CNPJ",
        "status": "CreditAnalysisDisapproved",
        "originId": "4d4df455-bfc8-4235-b7b0-c3146c24647b",
        "occurrenceDate": "2025-01-23T17:26:00.699801",
}

O campo status pode assumir os seguintes valores:

Status possíveis	Descrição
CreditPendingSubmit	Pendente envio da solicitação de crédito
CreditPreAnalysized	Solicitação aprovada na pré-análise de crédito
CreditAnalysis	Solicitação sob análise de crédito
CreditPendingScr	Pendente confirmação do Optin SCR enviado por e-mail para o cliente
CreditPendingECnpj	Pendente envio do certificado A1 (e-CNPJ) solicitado por e-mail para o cliente
CreditExpired	Solicitação expirou na etapa de análise de crédito
CreditDisapproved	Solicitação foi reprovada na etapa de análise de crédito
CreditDataAdjustment	Solicitação possui pendências a serem resolvidas na etapa de crédito
CreditApproved	Solicitação foi aprovada na análise de crédito
AccountCreationWaitingForOnboarding	Aguardando início do processo onboarding do cliente na plataforma
AccountCreationPendingSubmit	Pendente envio das informações do cliente para abertura de conta na plataforma
AccountCreationAnalysis	Informações do cliente para abertura de conta sob análise
AccountCreationWaitingSignatures	Aguardando assinaturas do cliente para realização da abertura de conta
AccountCreationDisapproved	Abertura de conta reprovada
AccountCreationDataAdjustment	Pendente ajustes nas informações de abertura de conta do cliente
ContractingWaitingOperation	Aguardando contratação de crédito pelo cliente
ContractingGuarantorsOnboarding	Aguardando onboarding dos avalistas da contratação do crédito
ContractingWaitingSignatures	Pendente assinaturas do cliente para contratação do crédito
ContractingWaitingDisbursement	Aguardando desembolso do crédito na conta do cliente
ContractingOperationDisbursed	Desembolso do crédito realizado
ContractingContracted	Crédito contratado pela plataforma