Objetos

Formato dos objetos devolvidos pela API e pelos webhooks.

Applicant

Registro do candidato e resultado da verificação.

{
  "id": "uuid",
  "external_id": "user-42",
  "full_name": "Maria Silva",
  "cpf": "12345678909",
  "birth_date": "1990-05-12",
  "email": "maria@exemplo.com",
  "status": "approved",
  "reason": null,
  "is_test": false,
  "created_at": "2026-08-17T12:00:00Z"
}

Check

Cada verificação executada pelo pipeline.

{
  "check_type": "face_match",   // cpf_validation | cpf_registry | document_extraction | face_match | geolocation
  "passed": true,
  "score": 0.91,
  "details": { "summary": "..." },
  "created_at": "..."
}

Event

Entrada do histórico de auditoria.

{
  "event": "decision.approved",
  "level": "success",          // info | success | warning | error
  "message": "Aprovado automaticamente",
  "data": { "status": "approved" },
  "created_at": "..."
}

DeviceCheck

Resposta da reconferência de dispositivo e localização.

{
  "verdict": "match",           // match | suspect | mismatch
  "deviceScore": 1,
  "locationScore": 0.95,
  "distanceKm": 4,
  "reasons": []
}

WebhookPayload

Corpo enviado às suas URLs de webhook.

{
  "event": "applicant.approved",  // applicant.submitted | applicant.approved | applicant.rejected | applicant.pending
  "data": { "applicantId": "uuid", "status": "approved", "reason": null },
  "sentAt": "2026-08-17T12:03:00Z"
}