API Integration

Go To Secure Portal
Add ID Checking to your internal systems

Online identity checking API

Online Identity Checking API

We often get customers asking if we have an API integration into our online ID checking service. They visit other suppliers who tell them they have to pay £5,000 or more to get the API integration and so they resign themselves to not having any further options.

An API, or Application Programming Interface, allows you to have programmatic control over the identity checking process. Rather than having to visit our website, log in and fill in the details, you can have the system integrated into your own software by your developers extremely easily. The benefit is that as long as the required information is being entered by you into your customer management or order processing system anyway, then your developers could simply add a button on screen to then capture that information and send it through to us for an ID check. No extra typing from you into our website and you keep all the data on your side of the system too.

We have that API, and we DON'T CHARGE any set up fee to use it. This is a feature that came out as part of our newly redesigned website in April 2026

REST based API. It is a simple REST based API which makes it possible to integrate into any solution - whether it be your own website, a Windows, Mac or Linux program or even a mobile app. Whether you use Java, PHP, C++, Python, Ruby etc, the REST based HTTP solution means you can integrate whichever platform you run on

What do I need to do ?

1. Create an account in our Secure Portal

2. Go To My Account, Company Profile and provide your address and your Data Protection Registration number and save

3. Go to My Account, My Profile and scroll down to API Keys. Create a new key and give it a name so you remember what its for, and most importantly, keep a safe copy of the key. You will only see it once

4. Whilst there is an API for you to talk to, to submit a request, when the check is complete, we need somewhere on your system that we can send the PDF to. This is referred to as a Webhook - because we hook in to your system so you go to Services, Web Hooks and create a Webhook.  This will be a page that you can accept POSTed data including a base64 encoded PDF document

5. The final step, and obviously you can do steps 2,3, 4 and 5 in any order, is to visit our API Docs

The first task you should do is make a call to the products endpoint to get the UUID for the type of check you want to carry out. These won't change and if for some reason in the future, they have to, we can identify which customers are using the API with that product and we'd get in touch with you

You should write a routine to get the current credit count from the system. You should run that periodically  so that you can go to the website and top up your account whenever you are running low

The main endpoint will be the POST to create and submit an ID Check.

KYC Standard 

You can choose to submit all the details for a check, in which case, your client won't need to fill anything in and its fully automated, or you can pass in the title, first, middle, last name, gender and optional email. If you want your client to fill in the majority of information, you can supply their email address and we will email them, advising that you are asking them to confirm their identity. If you'd prefer to send your own email, there is an option to send a "send_own_email" with a true value and this will simply return the link to you that you need to send to them, so you can send your own email wording.

KYC Selfie or ACSP Premium

These options require a link to go the client, so the same is true as for KYC Standard, except you don't have an option fill everything in. You simply send the basic details in and either we send the email to them or you do

The WebHook 

We will POST the response to you. It will contain the PDF and a result containing either NOALERT or ALERT. NOALERT means that we didn't find anything amiss with the identity check and so all is well. ALERT means there was an issue and you should review the PDF document to identify the reasons for the alert. The PDF is sent in the submission as a base64 encoded string so you can  extract the PDF and save it on your system, associating it with the client so that a member of your team can see the response in your system and click to view the PDF to check. You can then re enable to option to send a new request if the PDF indicated that it's something fixable by the client (they took a bad photo or had their thumb over the numbers and letters on the passport)


Remember: All you pay is the price of each check. No management fees, monthly service charges or setup fees and no charge to use the API