Skip to main content

Webhooks

Use webhooks to let your own systems know when important things happen inside Vouchsafe in real time.

Provide a webhook URL in a workflow’s Settings page, and Vouchsafe will make POST requests to that URL with a request body like:

{
	"event": Created | UserCompleted | Verified | Refused | Alert, // reason for the notification
	"id": "string",
	"email": "string",
	"redirect_url": "string",
	"status": "InProgress",
	"verification_method": "Document",
	"created_at": "string",
	"expires_at": "string",
	"workflow_id": "string",
	"external_id": "string",
}

The supported events are:

  • Created = verification has been requested, either in the dashboard or via an integration
  • UserCompleted = the user has completed their steps but extra action is still needed (eg. from a referee)
  • Verified = the user is verified successfully
  • Refused = the user couldn’t be verified, possibly due to misuse or fraud
  • Alert = for time-sensitive due diligence notifications e.g. a user appearing in a sanctions list