{"id":2173,"date":"2026-07-10T21:54:28","date_gmt":"2026-07-11T00:54:28","guid":{"rendered":"https:\/\/www.bancosemear.com.br\/docs\/?post_type=docs&p=2173"},"modified":"2026-07-23T11:45:22","modified_gmt":"2026-07-23T14:45:22","slug":"api-de-consulta-de-status","status":"publish","type":"docs","link":"https:\/\/www.bancosemear.com.br\/docs\/?docs=api-de-consulta-de-status","title":{"rendered":"API de Consulta de Status"},"content":{"rendered":"\n

1. Endpoint<\/h2>\n\n\n\n
POST https:\/\/hmlapi2.bancosemear.com.br\/caas-api-status\/v1\/public\/status<\/code><\/pre>\n\n\n\n
2. Descri\u00e7\u00e3o<\/h2>\n\n\n\n
Este endpoint permite consultar o status atual de propostas (CCB) cadastradas, a partir de um ou mais identificadores: CPF, n\u00famero de contrato, n\u00famero de CCB ou ID de contrato. \u00c9 poss\u00edvel informar m\u00faltiplos valores por campo, combinando filtros na mesma requisi\u00e7\u00e3o.<\/p>\n\n\n\n
3. Headers<\/h2>\n\n\n\n
Key<\/strong><\/td>Valor (apenas exemplo)<\/strong><\/td>Descri\u00e7\u00e3o<\/strong><\/td><\/tr>
client_id<\/td>00000000-0000-0000-0000-000000000000<\/code><\/td>Identificador \u00fanico do cliente\/aplica\u00e7\u00e3o consumidora da API<\/td><\/tr>
access_token<\/td>00000000-0000-0000-0000-000000000000<\/code><\/td>Token de acesso Bearer\/JWT com escopo de
autoriza\u00e7\u00e3o<\/td><\/tr>
Content-Type<\/td>application\/json<\/td>Formato do corpo da requisi\u00e7\u00e3o<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
4. Request Body<\/h2>\n\n\n\n
{\n  \"cpf\": [\"00000000000\", \"00000000000\"],\n  \"contractNumber\": [\"0000000000000\", \"0000000000000\"],\n  \"ccbNumber\": [\"0000000000000\", \"0000000000000\"],\n  \"contractId\": [\"00000000-0000-0000-0000-000000000000\", \"00000000-0000-0000-0000-000000000000\"]\n}\n<\/code><\/pre>\n\n\n\n
\n
\u00c9 obrigat\u00f3rio informar pelo menos um<\/strong> dos quatro campos, com pelo menos um valor v\u00e1lido. Os campos s\u00e3o independentes entre si e podem ser combinados.<\/p>\n<\/blockquote>\n\n\n\n
\u00c9 obrigat\u00f3rio informar pelo menos um<\/strong> dos quatro campos, com pelo menos um valor v\u00e1lido. Os campos s\u00e3o independentes entre si e podem ser combinados.<\/p>\n\n\n\n
4.1. Tabela de campos<\/strong><\/p>\n\n\n\n
Campo<\/th>Tipo<\/th>Obrigat\u00f3rio*<\/th>Regras<\/th>Descri\u00e7\u00e3o<\/th><\/tr><\/thead>
cpf<\/code><\/td>array de string<\/td>N\u00e3o*<\/td>Somente n\u00fameros<\/td>Lista de CPFs a consultar<\/td><\/tr>
contractNumber<\/code><\/td>array de string<\/td>N\u00e3o*<\/td>\u2014<\/td>Lista de n\u00fameros de contrato<\/td><\/tr>
ccbNumber<\/code><\/td>array de string<\/td>N\u00e3o*<\/td>\u2014<\/td>Lista de n\u00fameros de CCB<\/td><\/tr>
contractId<\/code><\/td>array de string<\/td>N\u00e3o*<\/td>\u2014<\/td>Lista de IDs internos de contrato (UUID)<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
*Pelo menos um dos quatro campos deve ser enviado com ao menos um valor n\u00e3o vazio.<\/p>\n\n\n\n
5. Respostas esperadas<\/h2>\n\n\n\n
5.1. 201 \u2014 Sucesso<\/strong><\/p>\n\n\n\n
Retornado mesmo quando nenhuma proposta \u00e9 encontrada. A resposta traz as propostas localizadas e, separadamente, os identificadores que n\u00e3o geraram resultado.<\/p>\n\n\n\n
{\n  \"proposals\": [\n    {\n      \"currentStatus\": \"IN_PROGRESS\",\n      \"currentStageName\": \"DataPrev (Averba\u00e7\u00e3o)\",\n      \"stageComment\": \"Proposta reprovada ao realizar averba\u00e7\u00e3o na Dataprev.\",\n      \"contractNumber\": \"0000000000000\",\n      \"contractId\": \"00000000-0000-0000-0000-000000000000\",\n      \"ccbNumber\": \"0000000000000\",\n      \"cpf\": \"00000000000\"\n    }\n  ],\n  \"notFoundCpfs\": [],\n  \"notFoundContractNumbers\": [],\n  \"notFoundContractIds\": [],\n  \"notFoundCcbNumbers\": []\n}<\/code><\/pre>\n\n\n\n
Tabela de campos da resposta<\/p>\n\n\n\n
Campo<\/th>Tipo<\/th>Descri\u00e7\u00e3o<\/th><\/tr><\/thead>
proposals<\/code><\/td>array de objeto<\/td>Lista de propostas encontradas<\/td><\/tr>
proposals[].currentStatus<\/code><\/td>string<\/td>Status atual da proposta (ex.: IN_PROGRESS<\/code>, REPROVED<\/code>, FINISHED<\/code>, CANCELED<\/code>, FAIL<\/code>)<\/td><\/tr>
proposals[].currentStageName<\/code><\/td>string<\/td>Nome da etapa atual do fluxo: 
AVERBACAO
INTEGRACAO_DOCUMENTA
DESEMBOLSO
ENCARTEIRAMENTO
CRIVO
ANUENCIA
PORTABILIDADE
PARADA_ACAO_CORBAN <\/td><\/tr>
proposals[].stageComment<\/code><\/td>string<\/td>Coment\u00e1rio\/observa\u00e7\u00e3o da etapa atual<\/td><\/tr>
proposals[].contractNumber<\/code><\/td>string<\/td>N\u00famero do contrato<\/td><\/tr>
proposals[].contractId<\/code><\/td>string<\/td>ID interno do contrato<\/td><\/tr>
proposals[].ccbNumber<\/code><\/td>string<\/td>N\u00famero da CCB<\/td><\/tr>
proposals[].cpf<\/code><\/td>string<\/td>CPF do titular<\/td><\/tr>
notFoundCpfs<\/code><\/td>array de string<\/td>CPFs enviados na requisi\u00e7\u00e3o que n\u00e3o retornaram nenhuma proposta<\/td><\/tr>
notFoundContractNumbers<\/code><\/td>array de string<\/td>N\u00fameros de contrato n\u00e3o localizados<\/td><\/tr>
notFoundContractIds<\/code><\/td>array de string<\/td>IDs de contrato n\u00e3o localizados<\/td><\/tr>
notFoundCcbNumbers<\/code><\/td>array de string<\/td>N\u00fameros de CCB n\u00e3o localizados<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
5.2. Exemplo \u2014 busca por CPF com m\u00faltiplas propostas<\/strong><\/p>\n\n\n\n
Request:<\/strong><\/p>\n\n\n\n
{\n  \"cpf\": [\"00000000000\"]\n}<\/code><\/pre>\n\n\n\n
Response (201):<\/strong><\/p>\n\n\n\n
{\n  \"proposals\": [\n    {\n      \"currentStatus\": \"IN_PROGRESS\",\n      \"currentStageName\": \"An\u00e1lise Interna (Semear)\",\n      \"stageComment\": \"MCB: ELEGIVEL\",\n      \"contractNumber\": \"0000000000000\",\n      \"contractId\": \"00000000-0000-0000-0000-000000000000\",\n      \"ccbNumber\": \"0000000000000\",\n      \"cpf\": \"00000000000\"\n    },\n    {\n      \"currentStatus\": \"FINISHED\",\n      \"currentStageName\": \"Encarteiramento\",\n      \"stageComment\": \"Encarteiramento realizado com sucesso.\",\n      \"contractNumber\": \"0000000000000\",\n      \"contractId\": \"00000000-0000-0000-0000-000000000000\",\n      \"ccbNumber\": \"0000000000000\",\n      \"cpf\": \"00000000000\"\n    }\n  ],\n  \"notFoundCpfs\": [],\n  \"notFoundContractNumbers\": [],\n  \"notFoundContractIds\": [],\n  \"notFoundCcbNumbers\": []\n}<\/code><\/pre>\n\n\n\n
5.3. Exemplo \u2014 identificador n\u00e3o encontrado<\/strong><\/p>\n\n\n\n
Request:<\/strong><\/p>\n\n\n\n
{\n  \"contractId\": [\"00000000-0000-0000-0000-000000000000\"]\n}<\/code><\/pre>\n\n\n\n
Response (201):<\/strong><\/p>\n\n\n\n
{\n  \"proposals\": [],\n  \"notFoundCpfs\": [],\n  \"notFoundContractNumbers\": [],\n  \"notFoundContractIds\": [\"00000000-0000-0000-0000-000000000000\"],\n  \"notFoundCcbNumbers\": []\n}<\/code><\/pre>\n\n\n\n
5.4. (400) \u2014 Requisi\u00e7\u00e3o inv\u00e1lida<\/strong><\/p>\n\n\n\n
Retornado quando nenhum dos quatro campos de filtro \u00e9 enviado, ou quando o header client_id<\/code> est\u00e1 ausente.<\/p>\n\n\n\n
[\n  {\n    \"code\": \"40000\",\n    \"title\": \"statusCommand\",\n    \"detail\": \"Informe pelo menos um dos campos: cpf, contractNumber, ccbNumber ou contractId.\"\n  }\n]<\/code><\/pre>\n\n\n\n
5.5. 500 \u2014 Erro inesperado<\/strong><\/p>\n\n\n\n
{\n  \"code\": \"50000\",\n  \"title\": \"Erro interno\",\n  \"detail\": \"Ocorreu um erro inesperado ao processar a requisi\u00e7\u00e3o.\"\n}<\/code><\/pre>\n\n\n\n
6. Observa\u00e7\u00f5es<\/h2>\n\n\n\n