Skip to main content

Banking correspondant monitoring


API under development

This API is still in its development phase. With this said, this manual is subject to alterations.

1. Registered Corban score consulting:

Request

ENDPOINT
/mcb/requester
METHOD
GET

Response

ENDPOINT
/mcb/requester
METHOD
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

FieldTypeDescription
document_numberstringCorban CNPJ.
namestringCorban company name.
trading_namestringCorban trade name.
citystringCorban city.
statestringCorban state (follows Brazilian UF).
requester_statusstringCorban status on MCB.
requester_historylistCorban update history.
reference_datestringUpdate reference date.
demand_percentagenumberComplaint index (percentage).
legal_action_percentagenumberLegal actions index (percentage).
do_not_disturb_percentagenumberComplaints linked to do not disturb index (percentage).

Enumerator requester status

EnumeratorDescription
accordingCorban is in accordance
partialy_accordingCorban is partially in accordance
not_accordingCorban is not in accordance
not_ratedCorban is not rated

2. Consult credit agent:

Request

ENDPOINT
/mcb/credit_agent/[CPF-DO-AGENTE]
METHOD
GET

QUERY PARAMETERS

EnumeratorDescription
include_historyRequired parameter to return the agent's score history

Response

ENDPOINT
/mcb/credit_agent/[CPF-DO-AGENTE]
METHOD
GET
HTTP STATUS
200
Response Body
{
"document_number": "02353050069",
"credit_agent_status": "active",
"credit_agent_external_status": "active",
"block_reason": null,
"credit_agent_history": [
{
"credit_agent_status": "active",
"credit_agent_external_status": "active",
"block_reason": null,
"current_score": 0,
"total_score": 0,
"score_expiration_date": null,
"suspension_start_date": null,
"suspension_end_date": null,
"reference_date": "2025-06-26"
}
]
}

Response body details

FieldTypeDescription
document_numberstringCredit agent CPF.
credit_agent_statusstringCredit agent status.
credit_agent_external_statusstringCredit agent status on MCB.
block_reasonstringCredit agent block reason.
current_scorenumberCredit agent current score.
total_scorenumberCredit agent total score.
score_expiration_datestringCredit agent score expiration date.
suspension_start_datestringCredit agent suspension start date.
suspension_end_datestringCredit agent suspension end date.
credit_agent_historylistCredit agent update history.
reference_datestringUpdate reference date.

Enumerator credit_agent_external_status

EnumeratorDescription
activeAgent is active
suspendedAgent is suspended for 12 months
permanently_suspendedAgent is indeterminately suspended
suspension_warningAgent is active, but has been accused of scam/fraud

Enumerator credit_agent_status

EnumeratorDescription
activeAgent is active
blockedAgent is blocked and can not emit credit operations

Enumerator block_reason

EnumeratorDescription
mcb_report_fileBlocked by mcb report file
expired_certificateBlocked by an expired certificate

3. Consult credit agents' certificate in CRCP:

Request

ENDPOINT
/mcb/credit_agent/[CPF-DO-AGENTE]/certificate
METHOD
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

FieldTypeDescription
document_numberstringCredit agents CPF.
namestringCredit agent name.
certificate_listlistCredit agents certificates.
certifier_namestringCertifier company name.
certifier_codestringCertificate type code .
titlestringCertification title.
certificate_numberstringCertificate number.
exam_datestringCertificate exam date.
expiration_datestringCertificate expiration date.
certificate_statusstringCertificate status.

Enumerator certificate_status

EnumeratorDescription
activeCertificate is active
excludedCertificate has been excluded by certificator