WebHooks

Events

Header	Descriptions
review.approved	operator was approved Candidate

Payload format

Header

Header	Descriptions
X-Blockpass-Events	Name of the event that triggered the webhook call.
X-Blockpass-Delivery	Unique ID of the webhook api call. This header is used for debug purpose only
X-Blockpass-Signature	The HMAC hex digest of the request body. This header will be sent if the webhook is configured with a secret key. The HMAC hex digest is generated using the sha256 hash function and the secret as the HMAC key. This header is used for request integrity check.

Request Body

{
  "guid": <copy of X-Blockpass-Delivery>,
  "status": "approved",
  "clientId": <clientId>,
  "event": <event name>,
  "refId":  <refId>,
  "submitCount": 1,
  "blockPassID": <Blockpass supportID>,
  "isArchived": false,
  "inreviewDate": "2018-10-27T02:22:07.662Z",
  "waitingDate": "2018-10-27T02:13:39.620Z",
  "approvedDate": "2018-10-27T02:22:13.725Z",
  "isPing": false,
}

Setup

1. Login to Admin dashboard
2. Top right dropdown menu -> Service -> Service detail
3. Outgoing Webhook. Fill the form below to add Webhook endpoint

Tracking

1. Login to Admin dashboard
2. Top right dropdown menu -> Service -> Service detail
3. Outgoing Webhook. Fill the form below to add Webhook endpoint
4. Click on Logs

Appendix - Retrying delivery

• KYC Connect Dashboard considers a webhook delivery as successfull when the endpoint responds with HTTP Code 200 or 201
• In case of a failed delivery. it will retry to invoke (maximum of 3 times), retrying interval == 10 seconds