Skip to main content

Webhooks

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

{
	"event": Created | UserCompleted | Verified | Refused, // reason for the notification
	"id": "string",
	"status": "InProgress",
	"verificationMethod": "Document",
	"createdAt": "string",
	"email": "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