Results

This is what the verification API will POST to the configured webhook for each verification task. It expects a 2XX response code, or the request will be retried. The retry logic uses an exponential backoff.

Schema

{
    "id": String,
    "conclusive": Boolean,
    "result": String?,
    "error": String?
}

The id field is the unique identifier for the verification.
The conclusive field indicates if our verifiers were able to come to a conclusion in the allotted time.
The result field is only present if the verification task was conclusive and has possible values of yes or no.
The error field is only present if the verification task was not conclusive and has at minimum the following possible values:

timeout - This is the value if a verifier was successfully presented the verification task and failed to make a decision within the allotted time.
unverifiable - This is the value if a verifier manually indicates that the task was unverifiable, due to any number of reasons.
unknown - This is the value if there was some technical issue automatically detected and does not fall under one of the other conditions.

Conclusive Yes Example Body

{
	"id": "ec3d5e6b-c204-4cad-b794-1a7177050632",
	"conclusive": true,
	"result": "yes"
}

Conclusive No Example Body

{
	"id": "ec3d5e6b-c204-4cad-b794-1a7177050632",
	"conclusive": true,
	"result": "no"
}

Inconclusive Timeout Example Body

{
	"id": "ec3d5e6b-c204-4cad-b794-1a7177050632",
	"conclusive": false,
	"error": "timeout"
}

Inconclusive Unverifiable Example Body

{
	"id": "ec3d5e6b-c204-4cad-b794-1a7177050632",
	"conclusive": false,
	"error": "unverifiable"
}

Inconclusive Unknown Example Body

{
	"id": "ec3d5e6b-c204-4cad-b794-1a7177050632",
	"conclusive": false,
	"error": "unknown"
}

You can trigger these results using the endpoint below to test the webhooks. This endpoint is only available in sandbox.