Monitoramento do correspondente bancário

---

API em desenvolvimento

A API ainda está em fase de desenvolvimento, sendo assim, este manual esta sujeito a alterações.

1. Consultar pontuação do corban cadastrado:

Request

ENDPOINT

/mcb/requester

MÉTODO

GET

Response

ENDPOINT

/mcb/requester

MÉTODO

GET

HTTP STATUS

200

Response Body

{
    "document_number": "60620087000121",
    "updated_at": "2025-04-29 14:24:43",
    "requester_status": "according",
    "demand_percentage": 28.13,
    "legal_action_percentage": 9.81,
    "do_not_disturb_percentage": 0
}

Response body details

Campo	Tipo	Descrição
document_number	string	CNPJ do Corban.
updated_at	string	Data e horário da última atualização do registro.
requester_status	string	Status do corban no MCB.
demand_percentage	number	Indice percentual de reclamações.
legal_action_percentage	number	Indice percentual de ações legais.
do_not_disturb_percentage	number	Indice percentual de reclamações relacionadas a não perturbe.

Enumeradores requester status

Enumerador	Descrição
according	Corban está de acordo
partialy_according	Corban está parcialmente de acordo
not_according	Corban não está de acordo
not_rated	Corban não avaliado

2. Consultar pontuação do agente de crédito:

Request

ENDPOINT

/mcb/credit_agent/[CPF-DO-AGENTE]

MÉTODO

GET

QUERY PARAMETERS

Enumerador	Descrição
reference_date	Parâmetro utilizado para consultar um mês específico, quando não informado é retornado o ultimo mês atualizado

Response

ENDPOINT

/mcb/credit_agent/[CPF-DO-AGENTE]

MÉTODO

GET

HTTP STATUS

200

Response Body

{
    "document_number": "68716299043",
    "updated_at": "2025-04-29 14:24:43",
    "agent_status": "active",
    "current_score": 4,
    "total_score": 28,
    "score_expiration_date": "2025-05-05",
    "suspension_start_date": "2025-04-10",
    "suspension_end_date": "2025-05-10"
}

Response body details

Campo	Tipo	Descrição
document_number	string	CPF do agente de crédito.
updated_at	string	Data e horário da última atualização do registro.
agent_status	string	Status do agente no MCB.
current_score	number	Pontuação atual do agente.
total_score	number	Pontuação acumulada do agente.
score_expiration_date	string	Data de expiração da pontuação do agente.
suspension_start_date	string	Data de início da suspensão do agente.
suspension_end_date	string	Data de fim da suspensão do agente.

Enumeradores agent status

Enumerador	Descrição
active	Agente está ativo
suspended	Agente se encontra suspenso(permanece por 12 meses)
permanently_suspended	Agente suspenso definitivamente
suspension_warning	Agente ativo, porém denunciado por golpe/fraude