Ongoing Selfie Spot Check Webhook Specification

The IDWise backend will send a JSON HTTP POST request to the webhook configured, with the following details:

{  
  "event": "**EVENT_NAME**",  
  "body": {
    "eventId":"4****-****-****-*********7",
    "journeyId": "62e6...........5d0c",  
    "referenceNo": "840...........23",  
    "systemDecision": "**SYSTEM_DECISION**",  
    "ongoingCheckId": "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, encapsulated within five primary attributes:

• event: This attribute captures the type of event that has been triggered. It can be one of the following four options:

  • Finished Ongoing Check: This event typically occurs during the ongoing verification process that utilizes selfie biometrics. It is activated once the user completes the ongoing check.

• eventId: A unique identifier to identify this event instance. Should the event be attempted again, the eventId will consistently remain unchanged throughout all retry attempts.

• journeyId: The onboarding journey id that used in the enrollment stage.

• referenceNo: The reference number associated with the journey.

• systemDecision: The automated decision by the IDWise system based on the inputs received. It can have one of three values:

  • Complete: The user has successfully completed all the steps in the journey. It is reflected as "passed" in the user interface.
  • Incomplete: The journey isn't complete yet, meaning the user hasn't finished all required steps.
  • Refer: At least one step has failed, necessitating a manual review.

• ongoingCheckId: the ongoing verification check id, that identifies the check id.