Pular para o conteúdo principal

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": "56201278000181",
"requester_status": "according",
"name": "TESTE SERVICOS LTDA",
"trading_name": "TESTE",
"city": "SAO PAULO",
"state": "SP",
"requester_history": [
{
"reference_date": "2025-05-19",
"requester_status": "according",
"demand_percentage": 28.13,
"legal_action_percentage": 9.81,
"do_not_disturb_percentage": 0
}
]
}

Response body details

CampoTipoDescrição
document_numberstringCNPJ do Corban.
namestringRazão social do Corban.
trading_namestringNome fantasia do Corban.
citystringMunicípio legal do Corban.
statestringUF do endereço legal do Corban.
requester_statusstringStatus do corban no MCB.
requester_historylistHistórico de atualizações do corban.
reference_datestringData de referência da atualização.
demand_percentagenumberIndice percentual de reclamações.
legal_action_percentagenumberIndice percentual de ações legais.
do_not_disturb_percentagenumberIndice percentual de reclamações relacionadas a não perturbe.

Enumeradores requester status

EnumeradorDescrição
accordingCorban está de acordo
partialy_accordingCorban está parcialmente de acordo
not_accordingCorban não está de acordo
not_ratedCorban 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

EnumeradorDescrição
reference_dateParâ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": "18126413549",
"credit_agent_status": "active",
"current_score": 4,
"total_score": 28,
"suspension_start_date": "2025-04-10",
"suspension_end_date": "2025-05-10",
"suspension_end_date": null,
"credit_agent_history": [
{
"credit_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",
"reference_date": "2025-05-19"
}
]
}

Response body details

CampoTipoDescrição
document_numberstringCPF do agente de crédito.
updated_atstringData e horário da última atualização do registro.
agent_statusstringStatus do agente no MCB.
current_scorenumberPontuação atual do agente.
total_scorenumberPontuação acumulada do agente.
score_expiration_datestringData de expiração da pontuação do agente.
suspension_start_datestringData de início da suspensão do agente.
suspension_end_datestringData de fim da suspensão do agente.
credit_agent_historylistHistórico de atualizações do agente.
reference_datestringData de referencia da atualização.

Enumeradores agent status

EnumeradorDescrição
activeAgente está ativo
suspendedAgente se encontra suspenso(permanece por 12 meses)
permanently_suspendedAgente suspenso definitivamente
suspension_warningAgente ativo, porém denunciado por golpe/fraude

3. Consultar certificação do agente de crédito no CRCP:

Request

ENDPOINT
/mcb/credit_agent/[CPF-DO-AGENTE]/certificate
MÉTODO
GET
STATUS
200
Response Body
{
"document_number": "12345678911",
"name": "NOME DO AGENTE DE CREDITO",
"certificate_list": [
{
"certifier_name": "FEBRABAN",
"certifier_code": "6345",
"title": "LGPD para Correspondentes no Pais Res 4 935",
"certificate_number": "1234567891234567",
"exam_date": "11/01/2022",
"expiration_date": "11/01/2024",
"certificate_status": "excluded"
},
{
"certifier_name": "FEBRABAN",
"certifier_code": "6339",
"title": "PLDFT em Conta Corrente Poupanca para Correspondente",
"certificate_number": "1234567891234567",
"exam_date": "28/12/2023",
"expiration_date": "28/12/2025",
"certificate_status": "active"
},
]
}
STATUS
404
Response Body
{
"title": "Not Found",
"description": "Credit agent not found.",
"translation": "Agente de crédito não encontrado.",
"code": "MCB000004"
}

Response body details

CampoTipoDescrição
document_numberstringCPF do agente de crédito.
namestringNome do agente certificado.
certificate_listlistLista de certificados vinculados ao agente de credito.
certifier_namestringNome da empresa certificadora.
certifier_codestringCódigo do tipo do certificado .
titlestringTitulo do certificado.
certificate_numberstringNúmero do certificado.
exam_datestringData do exame da certificação.
expiration_datestringData de expiração do certificado.
certificate_statusstringStatus do certificado na data da consulta.

Enumeradores certificate_status

EnumeradorDescrição
activeCertificado está ativo
excludedCertificado foi excluido pela certificadora