Descrição #
Esta operação recebe uma proposta de crédito consignado CLT já averbada e a registra no sistema de crédito do Banco Semear. Cada chamada representa um trabalhador cuja simulação foi aceita e que passa a aguardar o desembolso.
Endpoints #
Homologação: https://hmlapi2.bancosemear.com.br/payroll-loan-clt-proposal-api/v1/propostas/inclusao
Requisição (POST) #
Segue exemplo de requisição:
curl --request POST "https://hmlapi2.bancosemear.com.br/payroll-loan-clt-proposal-api/v1/propostas/inclusao" \
--header "Content-Type: application/json" \
--header "client_id: <CLIENT_ID>" \
--header "access_token: <ACCESS_TOKEN>" \
--header "X-Parceiro-Id: <IDENTIFICADOR_DO_PARCEIRO>" \
--header "X-Correlacao-Id: <UUID_OPCIONAL>" \
--header "Idempotency-Key: <CHAVE_OPCIONAL_DO_PARCEIRO>" \
--data '{
"idSimulacao": "07ea42ce-a2b9-4df7-89f0-87d4fa8ac297",
"chavePix": "fulano@example.com",
"cliente": {
"nome": "Fulano de Tal",
"dataNascimento": "1990-08-24",
"nomeMae": "Beltrana de Tal",
"nacionalidade": "Brasileira",
"genero": 1,
"renda": 3500.00,
"categoriaProfissional": "CLT",
"estadoCivil": 1,
"documento": {
"cpf": "529.982.247-25",
"rg": "MG1234567",
"orgaoEmissor": "SSP",
"uf": "MG"
},
"endereco": {
"rua": "Rua das Flores",
"tipoLogradouro": 1,
"numero": "100",
"bairro": "Centro",
"complemento": "Apto 201",
"cidade": "Belo Horizonte",
"estado": "MG",
"cep": "30110-000"
},
"contatos": {
"fone": { "ddd": "31", "numero": "3333-4444" },
"celular": { "ddd": "31", "numero": "99999-8888" },
"email": "fulano@example.com"
}
}
}'
Parâmetros de Requisição #
Cabeçalho
| Cabeçalho | Descrição | Obrigatório |
| Content-Type | Indica o tipo do corpo da requisição. Sempre application/json | Sim |
| client_id | ID de cliente usado para controle de acesso do gateway de APIs | Sim |
| access_token | Token recebido após executar o método oAuth | Sim |
| X-Parceiro-Id | Identificador do parceiro. Usado para segregar os dados e registrar a trilha de auditoria | Sim |
| X-Correlacao-Id | Identificador de correlação para rastreio ponta a ponta. Deve ser um UUID. Se omitido ou inválido, a API gera um | Não |
| Idempotency-Key | Chave do parceiro, registrada para rastreio. Não decide duplicidade — quem decide é o idSimulacao | Não |
Corpo (JSON)
| Propriedade | Descrição | Tipo | Obrigatório |
| idSimulacao | Identificador da simulação aceita. É a chave de idempotência. Formato UUID | String | Sim |
| chavePix | Chave Pix de destino do desembolso. Até 200 caracteres | String | Sim |
| cliente | Dados do trabalhador | Object | Sim |
| cliente.nome | Nome do trabalhador. Até 255 caracteres | String | Sim |
| cliente.dataNascimento | Data de nascimento no formato yyyy-MM-dd. Também aceita instante ISO-8601 completo, do qual usa apenas a data | String | Sim |
| cliente.estadoCivil | Código do estado civil | int32 | Sim |
| cliente.nomeMae | Nome da mãe. Até 255 caracteres | String | Não |
| cliente.nacionalidade | Nacionalidade. Até 20 caracteres. Quando omitida, grava brasileira | String | Não |
| cliente.genero | Código do gênero | int32 | Não |
| cliente.renda | Renda mensal. Máximo de 2 casas decimais e não pode ser negativa | decimal | Não |
| cliente.categoriaProfissional | Categoria profissional. Até 100 caracteres | String | Não |
| cliente.documento | Documentos do trabalhador | Object | Sim |
| cliente.documento.cpf | CPF do trabalhador. Aceita com ou sem máscara; é gravado somente com dígitos. Dígito verificador é conferido | String | Sim |
| cliente.documento.rg | RG. Até 15 caracteres | String | Não |
| cliente.documento.orgaoEmissor | Órgão emissor do RG. Até 20 caracteres | String | Não |
| cliente.documento.uf | UF do RG. Sigla com 2 letras | String | Não |
| cliente.endereco | Endereço do trabalhador | Object | Sim |
| cliente.endereco.rua | Logradouro. Até 120 caracteres | String | Sim |
| cliente.endereco.numero | Número. Até 10 caracteres | String | Sim |
| cliente.endereco.bairro | Bairro. Até 50 caracteres | String | Sim |
| cliente.endereco.cidade | Cidade. Até 50 caracteres | String | Sim |
| cliente.endereco.estado | Sigla da UF, com exatamente 2 letras. Minas Gerais é recusado; MG é aceito | String | Sim |
| cliente.endereco.cep | CEP com 8 dígitos. Aceita com ou sem máscara | String | Sim |
| cliente.endereco.complemento | Complemento. Até 20 caracteres | String | Não |
| cliente.endereco.tipoLogradouro | Código do tipo de logradouro. Recebido e descartado — não há coluna de destino nesta versão | int32 | Não |
| cliente.contatos | Contatos do trabalhador | Object | Sim |
| cliente.contatos.email | E-mail. Até 100 caracteres, precisa conter @ | String | Sim |
| cliente.contatos.celular | Celular. Pelo menos um entre celular e fone é obrigatório | Object | Condicional |
| cliente.contatos.celular.ddd | DDD do celular | String | Condicional |
| cliente.contatos.celular.numero | Número do celular. ddd + numero somam no máximo 15 dígitos | String | Condicional |
| cliente.contatos.fone | Telefone fixo. Pelo menos um entre celular e fone é obrigatório | Object | Condicional |
| cliente.contatos.fone.ddd | DDD do telefone | String | Condicional |
| cliente.contatos.fone.numero | Número do telefone. ddd + numero somam no máximo 15 dígitos | String | Condicional |
Campos não previstos no contrato são ignorados, não recusados. Isso permite ao parceiro evoluir o payload sem quebrar a integração.
Resposta #
Segue exemplo de resposta (HTTP 201):
{
"idProposta": "8eb9a311-9d4d-40f9-b8b7-285a73adba67",
"status": 201,
"mensagem": "Proposta recebida e persistida com sucesso"
}
Códigos de Retorno #
| HTTP | Situação | Corpo |
| 201 | Proposta recebida — nova ou reenvio | Objeto de resposta |
| 400 | Payload inválido | Array de erros |
| 401 | X-Parceiro-Id ausente | Objeto de erro |
| 500 | Falha interna | Objeto de erro |