Consulta de saldo FGTS
curl --request POST \
--url https://api.example.com/worker-fgts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"cpf": "<string>",
"employerRegistrationNumber": "<string>",
"workerRegistrationNumber": "<string>",
"employerRegistrationType": "<string>"
}
'import requests
url = "https://api.example.com/worker-fgts"
payload = {
"cpf": "<string>",
"employerRegistrationNumber": "<string>",
"workerRegistrationNumber": "<string>",
"employerRegistrationType": "<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({
cpf: '<string>',
employerRegistrationNumber: '<string>',
workerRegistrationNumber: '<string>',
employerRegistrationType: '<string>'
})
};
fetch('https://api.example.com/worker-fgts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"requestId": "e7f8a9b0-c1d2-3456-e7f8-a9b0c1d23456",
"status": "queued"
}
Contratação Ativa
Consulta de saldo FGTS
Consulta o saldo/multa do FGTS do trabalhador para uso como garantia na operação
POST
/
worker-fgts
Consulta de saldo FGTS
curl --request POST \
--url https://api.example.com/worker-fgts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"cpf": "<string>",
"employerRegistrationNumber": "<string>",
"workerRegistrationNumber": "<string>",
"employerRegistrationType": "<string>"
}
'import requests
url = "https://api.example.com/worker-fgts"
payload = {
"cpf": "<string>",
"employerRegistrationNumber": "<string>",
"workerRegistrationNumber": "<string>",
"employerRegistrationType": "<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({
cpf: '<string>',
employerRegistrationNumber: '<string>',
workerRegistrationNumber: '<string>',
employerRegistrationType: '<string>'
})
};
fetch('https://api.example.com/worker-fgts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"requestId": "e7f8a9b0-c1d2-3456-e7f8-a9b0c1d23456",
"status": "queued"
}
Etapa opcional — necessária apenas quando o trabalhador vai usar o FGTS como garantia.
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.O endpoint real se chama
worker-fgts — confirmado no código-fonte do Dataprev Controller (o PDF de
negócio o chamava de fgts-balance-inquiries). Usa o mesmo schema da
Consulta de dados do trabalhador.Parâmetros
string
required
CPF do trabalhador — 8 a 11 dígitos numéricos
string
required
Número de inscrição do empregador (1 a 14 caracteres)
string
required
Matrícula do trabalhador (1 a 30 caracteres)
string
required
Tipo de inscrição do empregador (1 a 14 caracteres)
Exemplo
curl -X POST https://hml.zipdin.com.br/dataprev-controller/worker-fgts \
-H "x-api-key: SUA_API_KEY" \
-H "Authorization: Bearer SEU_TOKEN" \
-H "x-idempotency-key: 3f8a91b2-7c4d-4e5f-a6b7-8c9d0e1f2a3b" \
-H "Content-Type: application/json" \
-d '{
"cpf": "52998224725",
"employerRegistrationNumber": "42422253",
"workerRegistrationNumber": "ZIPGERAL",
"employerRegistrationType": "1"
}'
{
"requestId": "e7f8a9b0-c1d2-3456-e7f8-a9b0c1d23456",
"status": "queued"
}