Finished User Step Webhook

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

{  
  "event": "Finished User Steps",  
  "body": {
    "eventId":"4****-****-****-*********7", 
    "journeyId": "6720***********22e",
    "referenceNo": "840...........23",  
    "stepId": 10,
    "stepType: "<STEP_TYPE>"
  }  
}

📘

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 user steps webhook this will always be Finished User Steps.

Inside the body element you find these elements:

  • 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: A unique identifier for the journey, a specific instance of the verification process.
  • referenceNo: The reference number associated with the journey.
  • stepId: The finished step's id.
  • stepType: The finished step's type. The expected value can be one of these:
    • Selfie
    • Document