Skip to main content
API docs by Redocly

API Motor de Crédito (1.0.0)

Download OpenAPI specification:Download

API para uso no painel de risco

auth

Faz login com as credenciais enviadas

Retorna um token com as informações do usuário

Authorizations:
noauthAuth
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "username": "{{apiUser}}",
  • "password": "{{apiSecret}}"
}

Response samples

Content type
application/json
{
  • "access_token": "<string>",
  • "nome": "<string>",
  • "acoes": [
    ],
  • "visualizandoDados": "<boolean>"
}

riscos

Calcula e salva risco automático

Retorna uma lista riscos calculados no momento e salvo no banco de dados para uma lista de pessoas

Authorizations:
bearerAuth
path Parameters
id_politica
required
string

(Required)

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "motivo": "string",
  • "CPFCNPJs": [
    ]
}

cadastros

Listar cadastros

Authorizations:
bearerAuth
query Parameters
nome
string
Example: nome=maicon
header Parameters
Accept
string
Example: application/json

Responses

Carregar detalhes de cadastro

Authorizations:
bearerAuth
path Parameters
id_membro
required
string
Example: <string>
header Parameters
Accept
string
Example: application/json

Responses

Cria e atualiza dados de cadastro - PJ

Authorizations:
bearerAuth
header Parameters
Content-Type
string
Example: application/json
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "canal": {
    },
  • "segmento": {
    },
  • "nome": "string",
  • "cpfCnpj": "string",
  • "fantasia": "string",
  • "celular": "string",
  • "email": "string",
  • "endereco": {
    },
  • "nascimento": "2024-06-12T12:35:23.426Z",
  • "banco": {
    },
  • "renda": "string",
  • "rendaFamiliar": "string",
  • "rendaPresumida": "string",
  • "classeSocial": 0,
  • "inscEstadual": "string",
  • "incoterms": {
    },
  • "cnae": "string",
  • "assessor": "string",
  • "data_cadastro": "string"
}

cadastros > documentos

Obter todos os documentos de um cadastro

Authorizations:
bearerAuth
path Parameters
id_membro
required
string
header Parameters
Accept
string
Example: application/json

Responses

Envio de documentos de cadastro

Authorizations:
bearerAuth
path Parameters
id_membro
required
string
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Atualizar documento do cadastro

Authorizations:
bearerAuth
path Parameters
id_membro
required
string
tipo
required
string
Example: FATURAMENTO

(Required)

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "tipoArquivo": "string",
  • "base64": "string",
  • "ocr": "string",
  • "data": "string"
}

Obter documento de um cadastro por tipo

Authorizations:
bearerAuth
path Parameters
id_membro
required
string
tipo
required
string
Example: FATURAMENTO

(Required)

header Parameters
Accept
string
Example: application/json

Responses

Deletar documento do cadastro

Authorizations:
bearerAuth
path Parameters
id_membro
required
string
tipo
required
string
Example: FATURAMENTO

(Required)

Responses

credito

Cria uma nova configuração de política de crédito Copy

Authorizations:
bearerAuth
header Parameters
x-party-id
string
Example: <string>
Content-Type
string
Example: application/json
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "cpfCnpj": "07099111000146",
  • "tipoProdutoId": 202,
  • "valor": 500,
  • "empresaId": 1,
  • "formaPagamento": null,
  • "planoPagamento": null,
  • "assessor": null
}

Detalhe da solicitação de análise de crédito

Authorizations:
bearerAuth
path Parameters
id_solicitacao
required
string
Example: <string>
header Parameters
x-party-id
string
Example: <string>

Responses

Empresas do Usuário

Retorna os detalhes do usuário selecionado

Authorizations:
bearerAuth
header Parameters
Accept
string
Example: application/json

Responses

Listar Tipos de produto

Lista Cadastro básico usado em Risco para determinado Tipo

Authorizations:
bearerAuth
path Parameters
tipo
required
string
Example: tipoProduto

(Required)

header Parameters
Accept
string
Example: application/json

Responses