Pular para o conteúdo principal

Ler Corban

Este serviço permite consultar os dados de um Corban específico, incluindo informações legais, comerciais, configurações financeiras e associações opcionais.

Endpoint para Consultar Corban​

  • Método: GET
  • URL: https://bff-dev.granatech.com.br/api/corban/{corbanId}

Parâmetro de Consulta​

  • corbanId (string, obrigatório): O ID do Corban a ser consultado.

Exemplo de Requisição com curl para Ler Corban​

curl -X GET https://bff-dev.granatech.com.br/api/corban/{corbanId}

Estrutura da Resposta​

A resposta para a consulta do Corban contém um objeto Corban com os campos a seguir:

  • document (string): Documento CNPJ do Corban.
  • legalName (string): Nome legal do Corban.
  • businessName (string): Nome comercial do Corban.
  • automaticApproval (boolean): Define se a aprovação do Corban é automática.
  • financialSettingsId (string): ID das configurações financeiras associadas, se aplicável.
  • creditPromoterId (number): ID do promotor de crédito associado, se aplicável.
  • WhiteLabel: Dados do White Label associados ao Corban, se aplicável.
  • createdAt (Date): Data de criação do Corban.

Exemplo de Resposta para Ler Corban​

{
  "document": "12345678000100",
  "legalName": "Corban Legal",
  "businessName": "Corban Comercial",
  "automaticApproval": true,
  "financialSettingsId": "f1234567890",
  "creditPromoterId": 1,
  "WhiteLabel": {
    "primaryColor": "#004488",
    "secondaryColor": "#FFA500",
    "logo": "https://example.com/logo.png"
  },
  "createdAt": "2024-01-15T10:00:00.000Z"
}

Observações​

  1. Associações Opcionais: O financialSettingsId, creditPromoterId, e WhiteLabel podem estar presentes dependendo da configuração do Corban.
  2. Identificação do Corban: Certifique-se de substituir {corbanId} pelo ID do Corban que deseja consultar.

Esse endpoint é útil para recuperar detalhes completos de um Corban e suas associações configuradas, permitindo uma visão abrangente das suas informações e relacionamentos.