BizCapital Parceiros Entre em contato

API de parceiros
1.0
OAS3

/parceiros/api/documentacao/swagger.json

Nossa API é responsável pela criação de novos pedidos de empréstimo para parceiros da Biz. A API da Biz recebe as informações no formato JSON e retorna na forma de Universally Unique Identifier (UUID) o ID do novo pedido de empréstimo criado, operando de maneira assíncrona. Após o processamento interno do pedido, retornamos a resposta para o webhook do parceiro.

O processo é rápido e sem complicações. Em menos de dois minutos o cliente completa os campos necessários para solicitar uma análise de crédito. Dados básicos do solicitante e da empresa são enviados via API para a Biz e rodamos a análise de crédito personalizada para cada cliente.

Com o retorno via webhook, enviamos a resposta de análise da solicitação do seu cliente dentro de minutos. O retorno inclui informações importantes sobre o status da solicitação e, em casos de aprovação, enviamos também os parâmetros da oferta de empréstimo.

Clientes com a nossa oferta receberão informações sobre valor do empréstimo, taxa de juros e prazo de pagamento. Dessa forma, conseguimos manter o seu cliente dentro do seu ambiente de experiência durante o processo de solicitação, sem precisar sair do seu site ou aplicativo para fazer a solicitação e, com isso, ter uma resposta de análise de crédito. Clientes com oferta que optem por seguir em frente com o pedido do empréstimo seguem com o link enviado por webhook para finalizar o pedido.

Retorno Webhook

Retorna a análise de solicitação de empréstimo

Descrição do objeto de retorno do webhook:

Payload
{
  id [String]: identificador do empréstimo
  cnpj [String]: CNPJ da empresa que solicitou o empréstimo
  status [Enum]: Refere-se ao estado do empréstimo, podendo ser:
      REJECTED: Rejeitado
      DENIED: Negado
      RECEIVED: Recebido (Pedido em análise)
      AWAITING: Aprovado e aguardando aceite da oferta
      IN_ANALYSIS: Em análise (Oferta já enviada e aceita)
      DOCUMENTS_PENDING: Aguardando o envio da documentação
      SIGNATURE_PENDING: Aguardando a assinatura do contrato
      APPROVED: Empréstimo aprovado 
  proposal [Object]: Dados da proposta (se houver):
  {
    amount [Decimal]: Valor da proposta de empréstimo
    interestRate [Decimal]: Taxa de juros
    term [Integer]: Quantidade de parcelas
    url [string]: Endereço para configuração da proposta
  {
}

Exemplo de retorno do webhook:

{
  "id": "3520fad8-f0eb-11e9-a713-2a2ae2dbcce4"
  "cnpj": "74134912000192"
  "status": "IN_ANALYSIS"
  "proposal":https://bizcapital.com.br/
  {
    "amount": 50000
    "interestRate": 3.7
    "term": 7
    "url": "https://bizcapital.com.br/pedido/identificador-do-pedido"
  }
}