1. Configure um tenant
Antes que um tenant possa chamar o trilho, registre:- um certificado de cliente ICP-Brasil A1 e a chave privada
- credenciais de cliente OAuth2
- o código de solicitante Dataprev de três dígitos do tenant
- opcionalmente, a URL base do portal do trabalhador oferecida como contato de formalização nas propostas de lance
2. Leia dados e margem do trabalhador
O endpoint de margem autentica o tenant, obtém o contexto de autorização do trabalhador no Dataprev e retorna a resposta do trilho sem transformá-la em uma decisão de underwriting. A API também expõe novos vínculos empregatícios, relatórios de rescisão, registros de FGTS autorizados e leituras de saldo de FGTS.3. Descubra leilões e envie propostas
Um loop de descoberta agendado lista as solicitações de empréstimo abertas. O cliente pode então enviar um lance pela API HTTP autenticada. O gateway retém o payload durável do lance necessário para comprovar o que o cliente enviou e, depois, publica o testemunho da proposta aceita. Toda proposta deve chegar ao trabalhador por pelo menos um contato. O gateway adiciona o portal de formalização do tenant como contato quando o tenant registra um. Um lance pode fazer override desse portal para seu próprio envio. O gateway recusa uma proposta sem portal registrado e sem contato do cliente antes de chamar o Dataprev. Os leilões de portabilidade usam uma operação de resposta separada e uma janela de requisição limitada no Dataprev.4. Registre e financie o contrato
O fluxo de registro:- registra o contrato junto ao Dataprev
- anexa o documento CCB quando exigido
- expõe o status de registro e os documentos do trilho
- registra a confirmação de desembolso do cliente
- publica fatos imutáveis de registro contábil e de pagamento pelo outbox
5. Administre o contrato
A API cobre o ciclo de vida do trilho após o registro: suspensão, reativação, alterações de prazo, antecipação e reversão de parcela, e exclusão. Ela também cobre refinanciamento e reversão, renegociação, registro de portabilidade e operações de contrato legado. A portabilidade funciona nos dois sentidos. Como instituição proponente, registre a portabilidade de entrada. Como instituição de origem, exclua o contrato do qual o trabalhador migrou. O gateway aceita isso apenas para um contrato que ele mesmo registrou. Ele recusa qualquer outro caso antes de chamar o trilho. Reverter um refinanciamento funciona da mesma forma. Você apenas pode reverter um refinanciamento por este gateway se o gateway o registrou. A janela de 7 dias úteis é avaliada em relação ao próprio registro do gateway sobre quando esse refinanciamento foi efetivado. A exclusão é uma operação recuperável. O comando autenticado inicial registra a intenção, e um loop de recuperação agendado leva o trabalho admitido a um estado terminal no trilho. Repetir o mesmo comando idempotente não cria uma segunda exclusão. Refinanciamento, reversão, renegociação e exclusão por portabilidade do lado de origem têm seu próprio loop de recuperação pelo mesmo motivo. O loop converge um comando cujo desfecho ninguém estabeleceu junto ao registro do trilho, em vez de perdê-lo.6. Concilie a folha de pagamento e o repasse
O worker de conciliação lê duas fontes independentes do Dataprev:- registros de escrituração, indexados pela competência da folha de pagamento e pelo contexto do contrato
- registros de repasse da CEF, que representam a movimentação de liquidação
7. Opere portfólios e garantias
Famílias adicionais de API cobrem calendários operacionais, rescisões de vínculo empregatício, execução de garantia de FGTS, fundos, créditos cedidos, cessões, vazão por tenant, uso e subscriptions de entrega de eventos.A referência da API vem do contrato
develop do produto. Use a página da operação para conhecer os cabeçalhos obrigatórios exatos, as regras de idempotência, os intervalos de validação e os esquemas de resposta.
