1. Visão geral # #
A cass-margin-consultation-dataprev-api é uma API destinada a consultar a margem consignável (IN100), retornando informações cadastrais e financeiras associadas ao benefício do titular.
2. Endpoints # #
- consult-benefit: operação detalhada (retorna dados cadastrais e margens completas do benefício).
2.1. POST /api/v1/public/dataprev/consult-benefit # #
URL (ambiente teste): https://hmlapi2.bancosemear.com.br/cass-margin-consultation-dataprev-api/api/v1/public/dataprev/consult-benefit
Consulta detalhes e margens de um benefício específico (IN100).
2.2.1. Request body (JSON) # #
| Campo | Tipo | Obrigatório | Descrição |
| cpf | string | Sim | Documento do titular (CPF). |
| benefit_number | string | Sim | Número do benefício (NB). |
| name | string | Sim | Nome do beneficiário |
2.2.2 Request body (JSON) # #
{
"cpf": "12345678901",
"benefit_number": "1234567890",
"name": "Emilio"
}2.2.3 Exemplo de resposta (Success 201) # #
{
"client_id": 1,
"agreement_id": 1,
"allow_update": "False",
"admission_date": null,
"document": "88202074355",
"beneficiary_name": "NOME DO BENEFICIARIO HOMOL - 8810217436",
"benefit_number": "8810217436",
"situation_code": "0",
"situation_description": "ATIVO",
"benefit_type_code": "49",
"benefit_type_description": "APOSENTADORIA ORDINARIA",
"juridical_authorization": false,
"state_payment": "MS",
"credit_type_code": "2",
"credit_type_description": "Conta Corrente",
"cbc_if_payment": "453",
"payment_agency": "33",
"account": "0010150048",
"has_legal_representative": false,
"has_attorney": false,
"has_representation_entity": false,
"has_alimony_code": "0",
"has_alimony_description": "Sem PA",
"blocked_for_loan": false,
"margin_value": 18754,
"margin_value_card": 6251,
"limit_value_card": 16000,
"active_suspended_loan": 1,
"active_loan": 1,
"suspended_loan": 0,
"loan_refin": 0,
"loan_porta": 0,
"date_consult": "2026-01-28T00:00:00",
"eligible_loan": true,
"margin_value_rcc": 0,
"limit_value_rcc": 16000,
"net_value_rcc": null,
"net_value": 93760,
"committed_value": 31251,
"max_commitment_value": 56256,
"pep_code": "0",
"pep_description": "Pessoa Não Exposta Politicamente",
"available_value_loan_endorsement": 18754,
"block_type_code": "0",
"block_type_description": "Sem Bloqueio",
"dispatch_date": "2019-03-01T00:00:00",
"block_date": null,
"checked_margin_zetra": false,
"zetra_benefit": null,
"serpro_benefit": null,
"cip_benefit": null,
"sponsor_benefit_number": null,
"serpro_agency_id": null,
"cip_agency_id": null
}3. Headers # #
Mesmo que a API ainda não esteja configurada para validar os parâmetros client_id e access_token, é obrigatório que o consumidor envie os headers abaixo, conforme padrão de integração.
| Key | Valor (exemplo) | Descrição |
| client_id | 9d4547b-a289-3243-8fff-924f1eea9522 | Identificador do cliente/aplicação consumidora. |
| access_token | 4g4652b-a339-7328-8fff-367f1eja8963 | Token de acesso para consumo da API. |
| Content-Type | application/json | Formato do corpo da requisição. |
| Accept | application/json | Formato esperado da resposta. |
4. Responses # #
4.1. 201 Success # #
Retorno de sucesso dos endpoints nesta versão básica.
4.2. 400 Bad Request # #
Erros de validação/contrato.
[
{ “code”: 0, “title”: “string”, “detail”: “string” }
]
4.3. 500 Internal Server Error # #
Erro inesperado.
{ “code”: 0, “title”: “string”, “detail”: “string” }
5. Exemplo de chamada (cURL) # #
5.1.consult-benefit # #
curl --location 'https://hmlapi2.bancosemear.com.br/cass-margin-consultationdataprev-api/api/v1/public/dataprev/consult-benefit' \
--header 'client_id: seu_id' \
--header 'access_token: seu_id \
--header 'Content-Type: application/json' \
--data '{
"cpf": "12345678901",
"benefit_number": "1234567890",
"name": "Joao da Silva"
}'6. Evidências de testes # #
Figura 1 – Parâmetros via header
Figura 2 – Body
Figura 3 – Retorno requisição
