Onboarding

A API onboarding permite que os parceiros possam realizar operações necessárias e consultar a analise de credito.

Pré-requisitos

Antes de começar a utilizar a API, é fundamental compreender os requisitos de autenticação e obter as credenciais necessárias.
Certifique-se de revisar a seção de autenticação para garantir uma integração segura e bem-sucedida.

Listar taxas existentes para o parceiro.

Permite listar as taxas para o parceiro, incluindo boletos, faturas, débito em conta e cartão de crédito.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/onboarding/v1/persons/{mainDocumentPolicytHolder}/credit-analysis
Method	Get
Query	mainDocumentPolicytHolder	CPF/ CNPJ do Tomador.
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.

Respostas (Response)

Status	Descrição	Tipo
200	Lista por produtos e suas taxas para os parceiro.	creditAnalysis
400	Os dados da requisição estão inválidos.	ErrorResult
401	Parceiro não autorizado a realizar a operação.	ErrorResult
403	Parceiro não autorizado a realizar a operação.	ErrorResult
500	Erro interno da API. Por favor tente novamente mais tarde ou contate o suporte técnico da Pottencial.	ErrorResult

Exemplo

[
  {
    "productKeys": [
      "judicial-deposito-recursal",
      "judicial-deposito-recursal-substituicao"
    ],
    "approvedLimit": "150000",
    "usedLimit": "10000",
    "rate": "0.65"
  },
  {
    "productKeys": [
      "garantia-bid",
      "garantia-performance"
    ],
    "approvedLimit": "250000",
    "usedLimit": "20000",
    "rate": "1.05"
  }
]

Consultar Limite de Credito

Permite consultar limite de credito aprovado para o Parceiro.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/onboarding/v1/persons/{productKey}/{documentNumber}/credit-limit
Method	Get
Path	productKey	Fiança Locatícia fianca-locaticia-mensalizado-pf
Path	documentNumber	CPF do cliente
Query	quoteId	ID da cotação para consulta.
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.

Respostas (Response)

Status	Descrição	Tipo
200	Objeto contendo as informações de credito.	limitCredit
400	Os dados da requisição estão inválidos.	ErrorResult
401	Parceiro não autorizado a realizar a operação.	ErrorResult
403	Parceiro não autorizado a realizar a operação.	ErrorResult
500	Erro interno da API. Por favor tente novamente mais tarde ou contate o suporte técnico da Pottencial.	ErrorResult

Exemplo

{
  "approvedLimit": "150.000.00"
}

Dicionario

Credit Analysis

Representa uma listar de taxas para o parceiro.

Campo	Tipo	Regras	Descrição
productKeys	Array string	Somente leitura	Lista com os nomes dos produtos.
approvedLimit	number	Somente leitura	Limite aprovado.
usedLimit	number	Somente leitura	Limite já utilizado.
rate	number	Somente leitura	Taxa.

limitCredit

Contém informações do limite de credito

Campo	Tipo	Regras	Descrição
approvedLimit	number	Obrigatorio	Limite aprovado de credito para o cliente.

Resolução de erros

Código	Erro	Descrição	Solução
400	Bad Request	Invalid secret in Authorization header	O client_secret informado no header é inválido. Verifique se o client_secret informado é o mesmo da APP e se o header Authorization está sendo passado conforme especificado.
401	Unauthorized	Could not find a required APP in the request, identified by HEADER client_id.	O client_id informado no header é inválido. Verifique se o client_id informado é o mesmo da APP e se o header Authorization está sendo passado conforme especificado.
404	Not Found	Not Found	Provavelmente a URL sendo chamado não está correta. Verifique se está conforme especificado.
415	Unsupported Media Type	Content type not supported	O header Content-Type não está sendo informado conforme esperado. O correto é application/json.
429	Too Many Requests	Too Many Requests	O consumidor estourou o limite de requisições por tempo. Aguarde um pouco para tentar novas requisições.
500	Internal Server Error	Internal Server Error	Erro não esperado, algo está quebrado na API. Por favor aguarde ou entre em contato com o time de suporte.

Estrutura da mensagem de erro

ErrorResult

Representa um resultado de erro na chamada da plataforma.

Campo	Tipo	Regras	Descrição
errors	array de ErrorMessage	Opcional	Lista de erros da solicitação.

ErrorMessage

Contém informações de um erro.

Campo	Tipo	Regras	Descrição
code	string	Opcional	Código de identificação do erro.
message	string	Opcional	Descrição do erro.