Para utilizar as APIs do E-Consignado Trabalhador, o parceiro deve configurar uma URL de callback pública para comunicação com a BMP.
Essa URL deve receber requisições do tipo POST e estar preparada para processar diferentes payloads, conforme o tipo de evento.
A cada interação do parceiro com a API do E-Consignado Trabalhador, a BMP retornará um evento na URL de callback do parceiro.
Todas os eventos de notificação por callback do E-Consignado Trabalhador possuem os seguintes campos:
codigoRequisicao: identificador único da requisição que resultou neste callback. Será enviado como resposta síncrona na requisição do endpoint da API e na resposta assíncrona com o callback.endpoint: corresponde ao endpoint da DATAPREV que foi realizada a requisição.payload: o conteúdo do payload é idêntico ao retorno da requisição feita nas APIs da DATAPREV.
Evento de nova solicitação feita na CTPS
Notificação periódica, enviada conforme identificação de novas solicitações feitas no aplicativo da CTPS.
{
"codigoRequisicao": "d6b6fdc1-5e3b-4e07-88d9-3b2f0416f734",
"endpoint": "/propostas-ctps/solicitacoes-trabalhador",
"payload": {
"idSolicitacao": 30697303,
"cpf": 99971503336,
"matricula": "MATCEN715",
"inscricaoEmpregador": {
"codigo": 1,
"descricao": "CNPJ"
},
"numeroInscricaoEmpregador": 42422253000101,
"valorLiberado": 1500,
"nroParcelas": 10,
"dataHoraValidadeSolicitacao": "01042025153522",
"nomeTrabalhador": "nome do trabalhador",
"dataNascimento": "13031982",
"margemDisponivel": 3230,
"elegivelEmprestimo": true,
"dataAdmissao": "13032005"
}
}
Tabela de referência para o campo inscricaoEmpregador:
Evento de atualização de situação de proposta
Após a inclusão da proposta, essa notificação de atualização de situação de proposta é enviada para informar a posição do parceiro no leilão.
{
"codigoRequisicao": "d6b6fdc1-5e3b-4e07-88d9-3b2f0416f734",
"endpoint": "/propostas-ctps/inclusao",
"payload": {
"status": "Enviada",
"proposta": {
"numeroProposta": 0,
"valorCETAnual": 0,
"valorCETMensal": 0,
"valorEmprestimo": 0,
"valorIOF": 0,
"valorParcela": 0,
"valorTaxaAnual": 0,
"valorTaxaMensal": 0
}
}
}
Evento de geração de CCB
Após a requisição de gerar contrato, a BMP irá gerar a Cédula de Crédito Bancário (CCB) e enviar o callback com os dados do contrato. Neste evento, o número da CCB e o código da proposta são enviados, para impressão do documento.
{
"codigoRequisicao": "d6b6fdc1-5e3b-4e07-88d9-3b2f0416f734",
"endpoint": "/emprestimos/gerar-contrato-trabalhador",
"payload": {
"numeroCCB": 0,
"codigoProposta": "string", // GUID PARA IMPRESSÃO DA CCB
"valorCETAnual": 0,
"valorCETMensal": 0,
"valorEmprestimo": 0,
"valorIOF": 0,
"valorParcela": 0,
"valorTaxaAnual": 0,
"valorTaxaMensal": 0
}
}
Evento de averbação de empréstimo
Embora não exista um endpoint de averbação neste projeto, a BMP precisa fazer a averbação na DATAPREV antes do envio dos documentos.
{
"codigoRequisicao": "d6b6fdc1-5e3b-4e07-88d9-3b2f0416f734",
"endpoint": "/emprestimos/averbar-consignado-trabalhador",
"payload": {
"codigoSucesso": "BD",
"mensagem": "descrição",
"numeroContrato": "número do contrato (string)",
"competenciaInicioDesconto": 202505,
"hashOperacao": 59036581
}
}
Evento de envio de CCB
Após a averbação, o empréstimo tem o documento da CCB incluído.
{
"codigoRequisicao": "d6b6fdc1-5e3b-4e07-88d9-3b2f0416f734",
"endpoint": "/emprestimos/incluir-informacoes-contrato-trabalhador",
"payload": {
"codigo": "SA",
"cpfTrabalhador": 5554385599,
"matricula": "descrição da matrícula",
"codigoInscricaoEmpregador": {
"codigo": 1,
"descricao": "CNPJ (string)"
},
"numeroInscricaoEmpregador": 66812038000177,
"codigoSolicitante": 274,
"numeroContrato": "número do contrato (string)"
}
}
Tabela de referência para o campo codigoInscricaoEmpregador:
Evento de consulta de lista de vínculos empregatícios
Este evento é enviado após a requisição de consulta de lista de vínculos com os vínculos empregatícios que o trabalhador possui.
{
"codigoRequisicao": "d6b6fdc1-5e3b-4e07-88d9-3b2f0416f734",
"endpoint": "/trabalhadores/listar-autorizados-trabalhador",
"payload": {
"vinculos": [{
"cpf": 22222222222,
"matricula": "0002-SP",
"inscricaoEmpregador": {
"codigo": 1,
"descricao": "CNPJ"
},
"numeroInscricaoEmpregador": 66812038000177,
"elegivel": true
},
{
"cpf": 22222222222,
"matricula": "aa",
"inscricaoEmpregador": {
"codigo": 2,
"descricao": "CPF"
},
"numeroInscricaoEmpregador": 11111111111,
"elegivel": false
}
]
}
}
Tabela de referência para o campo inscricaoEmpregador:
Evento de consulta de dados de vínculo empregatício
Este evento é enviado após a requisição de consulta de dados de vínculo com os detalhes de determinado vínculo do trabalhador.
{
"codigoRequisicao": "d6b6fdc1-5e3b-4e07-88d9-3b2f0416f734",
"endpoint": "/trabalhadores/consultar-dados-trabalhador",
"payload": {
"cpf": 77777777777,
"matricula": "0002-SP",
"inscricaoEmpregador": {
"codigo": 1,
"descricao": "CNPJ"
},
"numeroInscricaoEmpregador": 49451375000167,
"nome": "Mateus Crocs Silva",
"sexo": {
"codigo": 1,
"descricao": "Masculino"
},
"dataNascimento": "29102001",
"codigoCategoriaTrabalhador": 101,
"elegivel": true,
"valorTotalVencimentos": 10000,
"valorBaseMargem": 5000,
"valorMargemDisponivel": 3500,
"dataAdmissao": "16122021",
"pessoaExpostaPoliticamente": {
"codigo": 0,
"descricao": "Pessoa Não Exposta Politicamente"
},
"nomeEmpregador": "Empregador Massa Extra 49451375000167",
"nomeMae": "Catarina Inclusao Massa Extra",
"paisNacionalidade": {
"codigo": 792,
"descricao": "TURQUIA"
},
"cbo": {
"codigo": 354815,
"descricao": "AGENTE DE VIAGEM"
},
"dataInicioAtividadeEmpregador": "02042020"
}
}
Para mais detalhes quanto ao retorno da consulta de dados de um vínculo, acesse o documento Autorização e Consulta de dados
do trabalhador da DATAPREV. Neste documento, você encontra as descrição de todos objetos que devem ser mapeados e podem estar neste retorno.
