Request Failure Webhook

This webhook notifies your backend that one of your requests failed and could not be processed. This webhook applies to these APIs:

• Process Journey Step
• Process Government Database Check

The IDWise backend will send a JSON HTTP POST request to the URL you configured, with the following payload:

{  
  "event": "Request Failure",  
  "body": {
    "eventId":"4****-****-****-*********7", 
    "journeyId": "6720***********22e",
    "referenceNo": "840...........23",  
    "requestId":"",
    "operation":"<OPERATION_CODE>",
    "errorCode":"<ERROR_CODE>",
    "errorMessage":""
  }  
}

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 request failure webhook, this will always be Request Failure.

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.

• requestId: A unique identifier assigned to each request sent from your backend to the IDWise backend. In the event of a failure, this webhook is triggered and includes the corresponding requestId, allowing you to correlate the failure notification with the original request.

• operation: Represents the type of operation for the failed request. Possible values:

  • Process Journey Step

• errorCode: A standardized code indicating the reason for a failure. See error codes

• errorMessage: An explanation of the error that occurred.