Skip to main content

Overview

Here’s how to integrate Vouchsafe to verify the identities of your customers or users.

We provide a set of endpoints for you to request and manage verifications.

The API and sandbox endpoints are at:

http://app.vouchsafe.id/api/v1 # live
http://app.vouchsafe.id/api/v1/sandbox # sandbox

User journey​

Here’s how the Vouchsafe journey looks for end users:

image.png

The journey has 5 main steps:

  1. You inform the user of the need to verify their identity and send them to a unique verification URL provided by us.
  2. We set expectations with a start screen.
  3. All verifications start with a video selfie.
  4. The user completes a verification journey using one of your enabled methods.
  5. After successful verification, the user is redirected to the URL specified by you, where you conclude the process or provide next steps.

Authentication​

image.png

All requests require a client ID and client secret, which you can get from the API integration page of the Vouchsafe dashboard.

You can trade these for an access token, which you then provide as a bearer token with requests.

Available data​

A verification consists of a number of checks, the results of which can be inspected over the API. These can include:

  • A biometric video selfie
  • A photo ID inspection, with face comparison and automatic text extraction
  • A vouch from a referee
  • A verified bank account via PSD2 APIs
  • Lookups against international fraud, sanctions and watchlist databases
  • Email or phone number verification and fraud risk scoring

The actual checks conducted depend on what you’ve configured in the dashboard.

Rate limits​

There are no hard rate limits, but we may impose restrictions on very high-volume requests in future.

Requests that exceed rate limits will return a 429 status code.