Getting Results
How your app or server gets the result of a registration, verification, or identification (polling, webhooks, or the Web Integration redirect), and which one to use.
Registration, verification, and identification are asynchronous: you submit a request, and the result arrives later. How you get it depends on how you integrated.
Which method to use
| You integrated with | Get the result by | Webhooks? |
|---|---|---|
| Mobile SDK + Server API (your server submits jobs) | Polling the job, or webhooks to your server | Yes |
| Web Integration: Server Integration (your server issues sessions) | The user's redirect with a result code, then your server reads it; or poll the session | No |
| Web Integration: Link Integration (Console link) | The user's redirect (petify_status), a display code, and the Console result list | No |
Web Integration sessions send no webhook events today. If your users capture through a Web Integration link or session, use the redirect and the result code, not webhooks.
Server API: polling
Each submit (addFingerprints, verify, identify) returns 202 with a jobId. Poll the job until status is SUCCESS or FAILED:
| Job | Endpoint |
|---|---|
| Registration | GET /v2/fingerprint-addition-jobs/{jobId} |
| Verification | GET /v2/verification-jobs/{jobId} |
| Identification | GET /v2/identification-jobs/{jobId} |
Poll every 2–3 seconds for up to 60 seconds, with backoff. Result fields (isVerified, score, pets[]) appear only on SUCCESS. See Job Status and Polling.
Server API: webhooks
Instead of polling, add an HTTPS endpoint in the Console and receive signed events: fingerprint_addition_job.succeeded / .failed, verification_job.succeeded / .failed, identification_job.succeeded / .failed.
- Set up an endpoint: Console → Integration → Webhooks tab → Add endpoint
- Event types and bodies
- Verify the signature
Web Integration: redirect and result code
When the user finishes, their browser returns to your Redirect URL with petify_status (completed, failed, …) and, for most sessions, petify_code.
- Server Integration: your server exchanges the code with
GET /v2/hosted-results/{code}, or pollsGET /v2/hosted-sessions/{id}. See Receiving the result. - Link Integration: Register links return only
petify_status; Verify and Identify links return a display code your page can show. See Reading results. - Parameter rules: Redirect URLs & Result Delivery.
When the result is a failure
See Why Did Registration Fail? for where each kind of failure appears and what to do.