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

Campo	Tipo	Descrição
document_number	string	CNPJ do Corban.
name	string	Razão social do Corban.
trading_name	string	Nome fantasia do Corban.
city	string	Município legal do Corban.
state	string	UF do endereço legal do Corban.
requester_status	string	Status do corban no MCB.
requester_history	list	Histórico de atualizações do corban.
reference_date	string	Data de referência da atualização.
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": "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

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.
credit_agent_history	list	Histórico de atualizações do agente.
reference_date	string	Data de referencia da atualização.

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

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

Campo	Tipo	Descrição
document_number	string	CPF do agente de crédito.
name	string	Nome do agente certificado.
certificate_list	list	Lista de certificados vinculados ao agente de credito.
certifier_name	string	Nome da empresa certificadora.
certifier_code	string	Código do tipo do certificado .
title	string	Titulo do certificado.
certificate_number	string	Número do certificado.
exam_date	string	Data do exame da certificação.
expiration_date	string	Data de expiração do certificado.
certificate_status	string	Status do certificado na data da consulta.

Enumeradores certificate_status

Enumerador	Descrição
active	Certificado está ativo
excluded	Certificado foi excluido pela certificadora