CheckRisk
POST/risk
This is Vouchsafe's headline Risk API.
It gives you an instant picture of the identity fraud risk a customer represents, powered by our real-time fraud intelligence network and premium partner data.
Pass the information you have about a customer, and Vouchsafe will scan our network for signs that an identity might be stolen, synthetic or otherwise risky, using verification data and shared reports made by other businesses using the platform.
You can also run premium enrichments:
OFFICIAL_RECORDSwill look for authoritative evidence of a claimed identity and address in official and semi-official databases from around the world, which you can use as an FCA-compliant eKYC onboarding process.ONLINE_FOOTPRINTwill analyse the identity's digital and online history, to determine if it is likely to be legitimate or recently made-up.AMLwill search over 280 global databases of high-risk entities connected to financial or economic crime, including sanctions, watchlists and politically exposed people. It also enrols the person in ongoing monitoring, reported asalerts_enabled_at.ADVERSE_MEDIAsearches news coverage for reported wrongdoing linked to fraud or financial crime.
The more checks you turn on, the more complete the data you send needs to be.
This endpoint always returns a risk_score between 0 and 100, and a recommendation based on that risk, along with extensive metadata so you can explore the discovered trust and risk signals.
This endpoint can form the basis of a transaction monitoring or data-driven KYC/AML system.
Recommendations
Our Risk API returns one of three recommendations: CLEAR, REVIEW, and REJECT.
Face scan
Optionally send a face_scan: a live selfie or liveness image (JPEG or PNG, up to 10 MB). We'll check it against our fraud intelligence network to see whether the same face has been used under different identities. Without it, face-based checks are skipped.
Address
When the official records enrichment is turned on, a structured address is required. This should be taken from the results returned by the GET /postcode endpoint. See the address field below for how to split a flat, building name and street number.
Sandbox
In sandbox mode, email picks the recommendation you get back.
email | Recommendation |
|---|---|
contains +reject | REJECT |
contains +review | REVIEW |
| anything else | CLEAR |
The response echoes your input and includes only the enrichments you requested.
Requested enrichments are shaped to match the outcome:
- CLEAR: all pass
- REVIEW: only the last requested enrichment fails
- REJECT: all fail
To return a record you can open in the sandbox dashboard, use dwebb@email.com (CLEAR), jdoe@email.com (REVIEW), or eroberts@email.com (REJECT).
Request
Responses
- 201
- 400
- 401
- 403
- 405
- 422
Risk assessment completed
Bad request — validation error
Unauthorised
Feature not entitled — Risk feature required
Method not allowed
Invalid request