Semear LCP API

Esta documentação descreve os endpoints da API Semear LCP (Loan Private Payroll), o recorte da plataforma Semear usado para originar operações de crédito consignado privado: desde a autorização do trabalhador para consulta de dados na Dataprev até a emissão, assinatura, desembolso e averbação do contrato.

O conteúdo acompanha a collection Postman Semear LCP - Loan Private Payroll - Docs, cujas requisições seguem o passo a passo. Quando o comportamento da API difere da descrição da collection, isso é indicado no texto.

Dados de exemplo

Todos os identificadores, documentos, nomes, tokens e valores mostrados nos exemplos são fictícios. Eles preservam o formato real dos campos, mas não correspondem a nenhuma pessoa, contrato ou ambiente.

A jornada do consignado privado

O consignado privado depende de dados que só o trabalhador pode autorizar a consultar. A API organiza esse processo em seis etapas encadeadas, cada uma devolvendo um identificador que alimenta a seguinte:

Etapa	O que acontece	Módulo / rota
1	O trabalhador assina um termo de autorização e a plataforma obtém um token da Dataprev	Termos de Autorização — POST /v5/loan-private-payrolls/terms
2	Com o termo ativo, a API lista os vínculos empregatícios e a elegibilidade de cada um	Consignado Privado › Vínculos
3	Para um vínculo, consulta renda, margem disponível, empregador, alertas e empréstimos legados	Consignado Privado › Dados do trabalhador
4	Para o mesmo vínculo, consulta o saldo de FGTS disponível como garantia	Consignado Privado › Saldo FGTS
5	O operador simula a operação a partir do valor da parcela ou do valor em conta	Simulações
6	O operador emite o contrato e o conduz por formalização (CCB e assinatura eletrônica do trabalhador), averbação e desembolso	Empréstimos

O trabalhador participa da jornada por páginas geradas pela plataforma — o aceite do termo e a assinatura da CCB —, descritas em Jornadas. Consultas complementares de bureau e de autorregulação, quando exigidas pelo convênio, são feitas em Consultas.

O passo a passo completo, com os campos que precisam ser encaminhados entre as etapas, está em Primeiros passos › Visão geral.

Como esta documentação está organizada

• Primeiros passos — visão geral do fluxo, autenticação, ambientes, headers, tratamento de erros e convenções que valem para todos os endpoints.
• Referência de APIs — os endpoints, organizados por módulo (Termos de Autorização, Consignado Privado, Simulações, Empréstimos, Jornadas, Consultas), com rotas, payloads, respostas e exemplos.
• Assinatura Eletrônica — modelo de dados do envelope de assinatura, agnóstico de provedor. O módulo ainda não expõe rotas REST; a seção descreve as entidades e as regras, e passa a incluir os endpoints quando eles forem publicados.
• Domínios — conjuntos de valores controlados (code/key/name) usados nos campos de tipo e status.
• Modelos compartilhados — estruturas reutilizadas por vários endpoints: envelope de erro, CodeKeyName, campo de status, referências organizacionais e log de auditoria.

Visão geral técnica

• API: REST sobre HTTPS. Todas as rotas documentadas usam o prefixo v5 (algumas rotas v4 existem só por compatibilidade — ver Ambientes). GET /healthz informa a disponibilidade da API.
• Formato: JSON (application/json), propriedades em camelCase. Campos terminados em Amount são decimais monetários, devolvidos sempre com 6 casas decimais (2141.570000); taxas são frações (0.018 = 1,8%). Ver Convenções.
• Autenticação: header X-Api-Key com a chave do usuário de integração da sua empresa, em todas as chamadas — veja Autenticação.
• Provedor externo: as consultas de vínculos, dados do trabalhador e FGTS são feitas contra a Dataprev (Consulta Trabalhador), com o token de autorização gravado no termo. Elas são processadas em segundo plano: a API registra a consulta como pendente, responde na hora e publica o resultado no próprio registro e em eventos de webhook. O mesmo vale para a formalização (geração da CCB e da assinatura), a averbação, o envio do contrato e a desaverbação automática do empréstimo.

Nomenclatura

Os nomes de campos, rotas e valores de domínio são mantidos em inglês, no formato original do contrato, mesmo com o texto explicativo em português — assim a documentação reflete exatamente o que a API recebe e devolve.