Resultado da averbação
curl --request GET \
--url https://api.example.com/request/:requestId \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/request/:requestId"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/request/:requestId', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"requestId": "e7f8a9b0-c1d2-3456-e7f8-a9b0c1d23456",
"correlationId": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
"status": "completed"
}
Contratação Ativa
Resultado da averbação
Consulta o status do processamento assíncrono da averbação junto à DATAPREV
GET
/
request
/
:requestId
Resultado da averbação
curl --request GET \
--url https://api.example.com/request/:requestId \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/request/:requestId"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/request/:requestId', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"requestId": "e7f8a9b0-c1d2-3456-e7f8-a9b0c1d23456",
"correlationId": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
"status": "completed"
}
Etapa obrigatória — o resultado da averbação chega por webhook, com esta consulta como fallback.
Webhook de resultado
POST /webhooks/dataprev — enviado para a URL configurada pelo parceiro assim que a DATAPREV processa
a averbação.Consulta de status (fallback)
GET /request/:requestId — use quando o webhook não for recebido.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.A rota de consulta implementada é
GET /request/:requestId. O bloco HATEOAS _links.result da resposta
202 referencia /result/:requestId, mas o endpoint que responde de fato é /request/:requestId — use
este último.Exemplo
curl "https://hml.zipdin.com.br/dataprev-controller/request/e7f8a9b0-c1d2-3456-e7f8-a9b0c1d23456" \
-H "x-api-key: SUA_API_KEY" \
-H "Authorization: Bearer SEU_TOKEN"
{
"requestId": "e7f8a9b0-c1d2-3456-e7f8-a9b0c1d23456",
"correlationId": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
"status": "completed"
}
Tabela de Status
| Status | Descrição | Final? | Ação do Cliente |
|---|---|---|---|
queued | Requisição aceita, na fila | Não | Aguardar webhook |
processing | Em processamento | Não | Aguardar webhook |
completed | Sucesso | Sim | Processar resultado |
error | Falha definitiva | Sim | Analisar erro |
