Developer docs
Build identity, UK business and screening checks into your marketplace with the TrustVerify REST API.
The TrustVerify API lets a marketplace check sellers and businesses before they go live: ID document and selfie checks, UK company checks, sanctions and PEP screening, and a recorded approve, review or decline decision for every check. It is a JSON REST API at https://api.trustverify.co.uk/api/v1.
QuickstartCreate a test key and run a sandbox check.API referenceEvery public endpoint, with samples in eight languages.WebhooksSigned events and signature checks in every language.Sandbox and test dataTest keys return demo data only.
How an integration fits together#
- Sign up and create a test key in the developer portal. Test keys only ever return demo data.
- Call a check from your server:
POST /kyc/verify,POST /kyb/verifyorPOST /aml/screen. - Read the
statusin the response (passed,revieworfailed) and act on it. - Register a webhook to hear about later events, such as a new match for a monitored person.
- When you are ready, choose a paid plan and swap in a live key. Nothing else changes.
Everything in these docs#
Get started
- Quickstart: Create a test key and run your first sandbox check with cURL, Node.js, Python, PHP, Java, C#, Go or Ruby.
- Authentication: API keys, test and live environments, the two accepted headers, short-lived tokens and key safety.
- Sandbox and test data: Test keys return demo data only. Synthetic inputs that trigger every outcome: passed, review, failed, matches.
Guides
- KYC seller onboarding: Verify an individual seller with an ID document and a selfie before their first listing or payout.
- UK business verification (KYB): Check a UK registered company on the public register and screen it, with owner screening where enabled.
- Sanctions and PEP screening: Screen people and businesses against sanctions and PEP lists, once or with ongoing monitoring.
- Selfie checks: How the selfie step works, what the response tells you today, and how to handle each result.
- Hosted and mobile capture: Capturing ID and selfie images in your own app today, and the hosted capture flow that is coming soon.
- Reports and evidence bundles: Download a PDF report for a check, or a ZIP evidence bundle for a regulator or auditor.
Integrations
- Stripe Connect marketplaces: Gate payouts to connected accounts on a TrustVerify decision. A pattern you build with our API.
- Sharetribe marketplaces: Verify providers on a Sharetribe marketplace before they can publish listings. A pattern you build with our API.
- Shopify (coming soon): A Shopify app for TrustVerify is coming soon.
- WooCommerce (coming soon): A WooCommerce plugin for TrustVerify is coming soon.
Webhooks
- Webhooks: Receive events, verify the signature in eight languages, and handle retries and failures.
Reference
- API reference: Every public endpoint, generated from the published OpenAPI description, with samples in eight languages.
- Errors: HTTP status codes, error bodies and what to do about each one.
- Rate limits and quotas: Per-minute rate limits, monthly quotas, the headers that report them, and how to back off.
- Versioning: How the API is versioned, what counts as a breaking change, and how we tell you.
- Changelog: Dated changes to the public API and these docs.
- OpenAPI and Postman: Download the OpenAPI description and a ready-made Postman collection.
- SDKs (coming soon): Official client libraries are coming soon. Use the REST API and the samples in these docs today.
Trust
- Security, GDPR and UK data: How we protect API traffic and personal data, where data is held, and your GDPR responsibilities.
Machine-readable docs
The OpenAPI description is at /openapi.json, a Postman collection is on the downloads page, and a summary for AI assistants is at /llms.txt.