If you already run your own case management, CRM or practice software, that you have control over the code, there's no reason to send your team elsewhere to carry out an identity check. Our API lets you submit checks and receive results directly within the systems you already use.
Why Use Our API
Most identity check providers charge an up-front fee simply to connect to their service, followed by licences, minimum spends and contracts. We don't. The API is included with every Secure Portal account and each check costs exactly the same as it would through the portal.
Send us your client's details and we'll either return the completed result with its PDF report, or โ where your client needs to take part, such as a selfie check โ a secure link. You can email that link yourself, or we'll send it on your behalf.
What You Get
Free to integrate
No connection or set-up charge. You pay the standard per-check price and nothing more.
Results by webhook
When a check completes, we push the result and PDF to your endpoint. No polling required.
Works with any language
Standard JSON over HTTPS with bearer token authentication. If it can make a web request, it can run a check.
Every check type, one API
Change the product ID to run a KYC, ACSP, HR, International AML or PEP & Sanctions check. Company reports have their own two-step search-and-order flow.
Test mode
Flag any request as a test and receive a dummy result by webhook โ no credit is consumed.
The same PDF report
Each result includes the same referenced PDF you'd download from the portal, ready to store or display.
Core Endpoints
The API is deliberately small. Just over half a dozen endpoints cover the core of most integrations. The below 4 are the ones you will use most. Every request is authenticated with your bearer token.
The Cost of Integrating
We often hear from businesses paying hundreds of pounds a year before they've run a single check. With us, access to the API is free and you only pay when you complete a report.
- โSet-up and onboarding charges
- โAnnual minimum spend
- โPer-seat or monthly licence
- โTied into a contract
- โNo integration or set-up fee
- โNo minimum usage
- โFrom ยฃ3.99+VAT per check
- โNo contract โ leave any time
Test Mode
Add "test": true to any submission and nothing is sent to our data providers โ a dummy webhook is delivered shortly afterwards instead. Set "test_pass": false to simulate an alert, so you can test both outcomes. Test mode needs one credit on your account for that check type, but never uses it โ and when you buy your first credits to go live, we'll add that one back.
Getting Started
Get your keys. Register for a free Secure Portal account with your ICO registration number, then create an API key under My Account โ My Profile. Make a note of it โ it's only shown once.
Submit a test check. POST your client's details to /api/idcheck with the test flag, having set up a webhook under Services โ Web Hooks to receive the result.
Go live. Remove the test flag and the same request runs a real identity check. Buy credits by card, bank transfer, Google Pay or Klarna โ the more you buy, the cheaper each check becomes.
As with the portal, the API is only available to businesses registered as fee payers with the Information Commissioner's Office.
Ready to start building?
Free to integrate ยท Test mode uses no credits ยท From ยฃ3.99+VAT per live check
๐ Secure Account Area