Criar Proposta de E-Consignado
curl --request POST \
--url https://api.example.com/api/v1/propostas \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"nu_cpf": "<string>",
"nu_cnpj_conveniada": "<string>",
"vl_emprestimo": 123,
"qt_parcela": 123,
"dados_bancarios": {
"dados_bancarios.pix": "<string>",
"dados_bancarios.banco": "<string>",
"dados_bancarios.agencia": "<string>",
"dados_bancarios.conta": "<string>"
}
}
'import requests
url = "https://api.example.com/api/v1/propostas"
payload = {
"nu_cpf": "<string>",
"nu_cnpj_conveniada": "<string>",
"vl_emprestimo": 123,
"qt_parcela": 123,
"dados_bancarios": {
"dados_bancarios.pix": "<string>",
"dados_bancarios.banco": "<string>",
"dados_bancarios.agencia": "<string>",
"dados_bancarios.conta": "<string>"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
nu_cpf: '<string>',
nu_cnpj_conveniada: '<string>',
vl_emprestimo: 123,
qt_parcela: 123,
dados_bancarios: {
'dados_bancarios.pix': '<string>',
'dados_bancarios.banco': '<string>',
'dados_bancarios.agencia': '<string>',
'dados_bancarios.conta': '<string>'
}
})
};
fetch('https://api.example.com/api/v1/propostas', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"nu_proposta": 789456,
"status": "em_analise",
"dt_criacao": "2026-08-06T10:30:00-03:00",
"uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
{
"error": "BUSINESS_RULE_VIOLATION",
"message": "Funcionário não encontrado na empresa informada"
}
Propostas
Criar Proposta de E-Consignado
Crie uma nova proposta de crédito consignado privado para seu cliente
POST
/
api
/
v1
/
propostas
Criar Proposta de E-Consignado
curl --request POST \
--url https://api.example.com/api/v1/propostas \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"nu_cpf": "<string>",
"nu_cnpj_conveniada": "<string>",
"vl_emprestimo": 123,
"qt_parcela": 123,
"dados_bancarios": {
"dados_bancarios.pix": "<string>",
"dados_bancarios.banco": "<string>",
"dados_bancarios.agencia": "<string>",
"dados_bancarios.conta": "<string>"
}
}
'import requests
url = "https://api.example.com/api/v1/propostas"
payload = {
"nu_cpf": "<string>",
"nu_cnpj_conveniada": "<string>",
"vl_emprestimo": 123,
"qt_parcela": 123,
"dados_bancarios": {
"dados_bancarios.pix": "<string>",
"dados_bancarios.banco": "<string>",
"dados_bancarios.agencia": "<string>",
"dados_bancarios.conta": "<string>"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
nu_cpf: '<string>',
nu_cnpj_conveniada: '<string>',
vl_emprestimo: 123,
qt_parcela: 123,
dados_bancarios: {
'dados_bancarios.pix': '<string>',
'dados_bancarios.banco': '<string>',
'dados_bancarios.agencia': '<string>',
'dados_bancarios.conta': '<string>'
}
})
};
fetch('https://api.example.com/api/v1/propostas', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"nu_proposta": 789456,
"status": "em_analise",
"dt_criacao": "2026-08-06T10:30:00-03:00",
"uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
{
"error": "BUSINESS_RULE_VIOLATION",
"message": "Funcionário não encontrado na empresa informada"
}
Criar Proposta
Inicie o processo de consignado privado para um funcionário. A proposta será analisada automaticamente e você receberá o resultado via webhook.Todos os endpoints requerem autenticação via Bearer token no header
Authorization.
Consulte o guia de autenticação para obter suas credenciais e gerar um token.Parâmetros
string
required
CPF do funcionário (somente números)
string
required
CNPJ da empresa conveniada
number
required
Valor do empréstimo desejado (R$)
integer
required
Número de parcelas (6 a 96)
object
required
Exemplo
curl -X POST https://api.zipdin.com.br/api/v1/propostas \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"nu_cpf": "12345678901",
"nu_cnpj_conveniada": "12345678000190",
"vl_emprestimo": 5000.00,
"qt_parcela": 24,
"dados_bancarios": { "pix": "12345678901" }
}'
import requests
response = requests.post(
"https://api.zipdin.com.br/api/v1/propostas",
headers={"Authorization": f"Bearer {token}"},
json={
"nu_cpf": "12345678901",
"nu_cnpj_conveniada": "12345678000190",
"vl_emprestimo": 5000.00,
"qt_parcela": 24,
"dados_bancarios": {"pix": "12345678901"}
}
)
const response = await fetch("https://api.zipdin.com.br/api/v1/propostas", {
method: "POST",
headers: {
"Authorization": `Bearer ${token}`,
"Content-Type": "application/json"
},
body: JSON.stringify({
nu_cpf: "12345678901",
nu_cnpj_conveniada: "12345678000190",
vl_emprestimo: 5000.00,
qt_parcela: 24,
dados_bancarios: { pix: "12345678901" }
})
});
{
"nu_proposta": 789456,
"status": "em_analise",
"dt_criacao": "2026-08-06T10:30:00-03:00",
"uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
{
"error": "BUSINESS_RULE_VIOLATION",
"message": "Funcionário não encontrado na empresa informada"
}
Próximos Passos
Após criar a proposta, você receberá o resultado da análise via webhookproposta.pre_aprovada ou proposta.negada. Se aprovada, prossiga com a simulação.
Para acompanhar todo o ciclo de vida da proposta, veja os status possíveis em Consultar Status.