Sumário
1. Endpoint #
POST /api/v1/eligibility/check
URL de teste: https://hmlapi2.bancosemear.com.br/caas-eligible-api/v1/public/eligibility
2. Descrição #
Verifica se um beneficiário INSS está elegível para contratação do empréstimo consignado. A consulta é maleável e pode escolher consultar os orgãos SRCC, NMP e MCB simultaneamente.
3. Headers #
| Key | Valor (apenas exemplo) | Descrição |
| client_id | g5d9627b-a635-4043-8fdf-291f1eva3556 | Identificador único do cliente/aplicação consumidora da API |
| access_token | 9nf84610-5e6a-489a-8228-469a3d29fnf | Token de acesso Bearer/JWT com escopo de autorização |
| Content-Type | application/json | Formato do corpo da requisição |
*acess_token precisa ser solicitado na API da Semear de autenticação:
https://api.bancosemear.com.br/oauth/access-token
4. Request Body (application/json) #
{
"cpf": "52534996010",
"numeroBeneficioINSS": "1111111111",
"numeroTelefone": "11999999999",
"cpfAgenteCredito": "52534996010",
"srcc": true,
"nmp": true,
"mcb": false
}5. Campos do corpo da requisição #
| Campo | Tipo | Obrigatório | Forma/Regra | Descrição |
| cpf | string | Sim, quando srcc estiver como true | Exatamente 11 dígitos numéricos | CPF do beneficiário |
| numeroBeneficioINSS | string | Sim, quando srcc estiver como true | Exatamente 10 dígitos numéricos | Número do Benefício / NB INSS |
| numeroTelefone | string | Sim, quando nmp estiver como true | 10 ou 11 dígitos numéricos | Telefone fixo (10) ou celular (11) |
| cpfAgenteCredito | string | Sim, quando mcb estiver como true | Exatamente 11 dígitos numéricos | CPF do agente de crédito / correspondente |
| srcc | boleano | Sim | True ou false | Ativa a consulta no SRCC |
| nmp | boleano | Sim | True ou false | Ativa a consulta no NMP |
| mcb | boleano | Sim | True ou false | Ativa a consulta no MCB |
Respostas Esperadas
| Código | Descrição | Exemplo de corpo da resposta |
| 201 | Processado com sucesso | {“elegivel”: true } ou { “elegivel”: false, “mensagem”: “Benefício bloqueado para consignação” } |
| 400 | Erro de validação (formato / campos) | { “errors”: { “cpf”: [“O CPF deve conter 11 dígitos.”] } } |
| 500 | Erro interno do servidor | {“message”: “Erro interno. Tente novamente mais tarde.” } |
Exemplos de Resposta 201 OK
Elegível:
{
"elegivel": true
}Não elegível:
{
"elegivel": false,
"mensagem": ” SRCC: Situação não permitida pela SRCC: resultado: BLOQUEADO, prazo
expiração: 61, tipo evento: DESBLOQUEIO”
}6. Evidência de teste #
Figura 1 – Parâmetros via header
Figura 2 – Parâmetros do body (payload)
Figura 3 – Retorno do processamento
