Finished Spot Check Webhook
The IDWise backend will send a JSON HTTP POST request to the webhook configured, with the following details:
{
"event": "Finished Spot Check",
"body": {
"eventId":"4****-****-****-*********7",
"referenceNo": "840...........23",
"systemDecision": "<SYSTEM_DECISION>",
"spotCheckJourneyId": "65ee...........d700ca"
}
}
Note
Please note this object might be extended with extra elements. Ensure your code can accommodate any extra elements introduced to this payload object.
The JSON object provided contains information about certain events in the ID verification process. Here is the explanation of its elements:
event
: Identifies the type of event that triggered this webhook. For finished spot check webhook this will always beFinished Spot Check
.
Inside the body
element you find these elements:
-
eventId
: A unique identifier to identify this event instance. Should the event be attempted again, theeventId
will consistently remain unchanged throughout all retry attempts. -
referenceNo
: The reference number associated with the journey. -
systemDecision
: The automated decision by the IDWise system based on the inputs received. -
spotCheckJourneyId
: the ongoing verification check id, that identifies the check journey id.
Updated 8 days ago