API Integration Guide

Follow these steps to integrate the UK Share Code API into your application. You'll need an API key — available from the pricing page.

1. Choose Your Endpoint

• Custom key: https://app.ukrtwchecker.co.uk/rtw
• RapidAPI: https://uk-right-to-work-sharecode-checker.p.rapidapi.com/rtw

2. Add Authentication Headers

Custom key:

X-UKRTWAPI-SECRET: YOUR_SECRET_KEY

RapidAPI:

X-RapidAPI-Key: YOUR_RAPIDAPI_KEY
X-RapidAPI-Host: uk-right-to-work-sharecode-checker.p.rapidapi.com

3. Required Parameters

Parameter	Required	Description
code	Yes	The applicant's share code
forename	Yes	Applicant's first name
surname	Yes	Applicant's last name
dob	Yes	Date of birth (DD-MM-YYYY)
company_name	Yes	Your company name
allow_student	No	Accept student visas (default: true)
allow_sponsorship	No	Accept sponsorship requirement (default: true)
include_image	No	Return base64 profile image (default: false)

4. Code Examples

Python

import requests

url = "https://app.ukrtwchecker.co.uk/rtw"

querystring = {
    "company_name": "UK RTW Checker Ltd.",
    "allow_student": "true",
    "allow_sponsorship": "false",
    "code": "W123X456Y",
    "forename": "John",
    "surname": "Doe",
    "dob": "07-09-1999"
}

headers = { "X-UKRTWAPI-SECRET": "YOUR_SECRET_KEY" }

response = requests.get(url, headers=headers, params=querystring)
print(response.json())

cURL

# Custom key
curl --request GET \
  --url 'https://app.ukrtwchecker.co.uk/rtw?company_name=UK%20RTW%20Checker&code=W123X456Y&forename=John&surname=Doe&dob=07-09-1999' \
  --header 'X-UKRTWAPI-SECRET: YOUR_SECRET_KEY'

# RapidAPI
curl --request GET \
  --url 'https://uk-right-to-work-sharecode-checker.p.rapidapi.com/rtw?code=W123X456Y&forename=John&surname=Doe&dob=07-09-1999' \
  --header 'X-RapidAPI-Key: YOUR_RAPIDAPI_KEY' \
  --header 'X-RapidAPI-Host: uk-right-to-work-sharecode-checker.p.rapidapi.com'

Node.js

const axios = require('axios');

const response = await axios.get('https://app.ukrtwchecker.co.uk/rtw', {
  params: {
    company_name: 'UK RTW Checker Ltd.',
    allow_student: 'true',
    allow_sponsorship: 'false',
    code: 'W123X456Y',
    forename: 'John',
    surname: 'Doe',
    dob: '07-09-1999',
  },
  headers: { 'X-UKRTWAPI-SECRET': 'YOUR_SECRET_KEY' },
});

console.log(response.data);

Ruby

require 'net/http'
require 'uri'

url = URI("https://app.ukrtwchecker.co.uk/rtw?company_name=UK%20RTW%20Checker&code=W123X456Y&forename=John&surname=Doe&dob=07-09-1999")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-UKRTWAPI-SECRET"] = "YOUR_SECRET_KEY"

response = http.request(request)
puts response.read_body

Java

import org.asynchttpclient.*;

String url = "https://app.ukrtwchecker.co.uk/rtw"
  + "?company_name=UK%20RTW%20Checker&code=W123X456Y&forename=John&surname=Doe&dob=07-09-1999";

AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", url)
    .setHeader("X-UKRTWAPI-SECRET", "YOUR_SECRET_KEY")
    .execute()
    .toCompletableFuture()
    .thenAccept(System.out::println)
    .join();

client.close();

5. Example Response

{
  "code": 200,
  "status": {
    "outcome": "ACCEPTED",
    "name": "John Doe",
    "expiry_date": "30/03/2028",
    "details": "They have permission to work in the UK until 30 March 2028."
  }
}

More examples are available on the RapidAPI listing.