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/requesterMETHOD
GETResponse
ENDPOINT
/mcb/requesterMETHOD
GETHTTP STATUS
200Response 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
Field | Type | Description |
---|---|---|
document_number | string | Corban CNPJ. |
name | string | Corban company name. |
trading_name | string | Corban trade name. |
city | string | Corban city. |
state | string | Corban state (follows Brazilian UF). |
requester_status | string | Corban status on MCB. |
requester_history | list | Corban update history. |
reference_date | string | Update reference date. |
demand_percentage | number | Complaint index (percentage). |
legal_action_percentage | number | Legal actions index (percentage). |
do_not_disturb_percentage | number | Complaints linked to do not disturb index (percentage). |
Enumerator requester status
Enumerator | Description |
---|---|
according | Corban is in accordance |
partialy_according | Corban is partially in accordance |
not_according | Corban is not in accordance |
not_rated | Corban is not rated |
2. Consult credit agent:
Request
ENDPOINT
/mcb/credit_agent/[CPF-DO-AGENTE]METHOD
GETQUERY PARAMETERS
Enumerator | Description |
---|---|
include_history | Required parameter to return the agent's score history |
Response
ENDPOINT
/mcb/credit_agent/[CPF-DO-AGENTE]METHOD
GETHTTP STATUS
200Response 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
Field | Type | Description |
---|---|---|
document_number | string | Credit agent CPF. |
credit_agent_status | string | Credit agent status. |
credit_agent_external_status | string | Credit agent status on MCB. |
block_reason | string | Credit agent block reason. |
current_score | number | Credit agent current score. |
total_score | number | Credit agent total score. |
score_expiration_date | string | Credit agent score expiration date. |
suspension_start_date | string | Credit agent suspension start date. |
suspension_end_date | string | Credit agent suspension end date. |
credit_agent_history | list | Credit agent update history. |
reference_date | string | Update reference date. |
Enumerator credit_agent_external_status
Enumerator | Description |
---|---|
active | Agent is active |
suspended | Agent is suspended for 12 months |
permanently_suspended | Agent is indeterminately suspended |
suspension_warning | Agent is active, but has been accused of scam/fraud |
Enumerator credit_agent_status
Enumerator | Description |
---|---|
active | Agent is active |
blocked | Agent is blocked and can not emit credit operations |
Enumerator block_reason
Enumerator | Description |
---|---|
mcb_report_file | Blocked by mcb report file |
expired_certificate | Blocked by an expired certificate |
3. Consult credit agents' certificate in CRCP:
Request
ENDPOINT
/mcb/credit_agent/[CPF-DO-AGENTE]/certificateMETHOD
GETSTATUS
200Response 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
404Response Body
{
"title": "Not Found",
"description": "Credit agent not found.",
"translation": "Agente de crédito não encontrado.",
"code": "MCB000004"
}
Response body details
Field | Type | Description |
---|---|---|
document_number | string | Credit agents CPF. |
name | string | Credit agent name. |
certificate_list | list | Credit agents certificates. |
certifier_name | string | Certifier company name. |
certifier_code | string | Certificate type code . |
title | string | Certification title. |
certificate_number | string | Certificate number. |
exam_date | string | Certificate exam date. |
expiration_date | string | Certificate expiration date. |
certificate_status | string | Certificate status. |
Enumerator certificate_status
Enumerator | Description |
---|---|
active | Certificate is active |
excluded | Certificate has been excluded by certificator |