UK Right to Work Sharecode Checker

FREEMIUM
By James O'Neill | Updated il y a un mois | Jobs
Popularity

0 / 10

Latency

4,612ms

Service Level

100%

Health Check

100%

README

Based on the provided text description, I’ll format the example requests and responses in English:

Endpoints:

  • /rtw - GET

Required Parameters:

  • code: Their Sharecode provided by the government
  • DOB: Their Date of Birth in the format dd-mm-yyyy
  • Forename: Their Forename
  • Surname: Their Surname

Optional Parameters:

  • allow_student (Boolean): Set to True by default; if set to false, student visas will be rejected
  • allow_sponsorship (Boolean): Set to True by default; if set to false, visas requiring sponsorship will be rejected

Example Request:

{
  "code": "example_code",
  "DOB": "dd-mm-yyyy",
  "Forename": "John",
  "Surname": "Doe",
  "allow_student": true,
  "allow_sponsorship": true
}

GET

/rtw?code=W3RRY34X7&dob=07-06-1997&forename=John&surname=Doe&allow_student=true&allow_sponsorship=true

Example Response:

  • Valid Request:
{
  "code": 200,
  "error": null,
  "status": {
    "conditions": "They can also work on a placement which is part of the course their student visa is based on.",
    "details": "They have permission to work in the UK until 30 March 2028, subject to the conditions and restrictions below.",
    "expiry_date": "30/03/2028",
    "name": "John Doe",
    "outcome": "ACCEPTED",
    "start_date": "10/04/2024",
    "title": "Right to work"
  }
}
  • Valid Request, Names Mismatch:
{
  "code": 200,
  "error": null,
  "status": {
    "conditions": "They can also work on a placement which is part of the course their student visa is based on.",
    "details": "They have permission to work in the UK until 30 March 2028, subject to the conditions and restrictions below.",
    "expiry_date": "30/03/2028",
    "name": "John Doe",
    "outcome": "REJECTED",
    "rejected_reason": "NAME_MISMATCH",
    "start_date": "10/04/2024",
    "title": "Right to work"
  }
}
  • Invalid Request (Code not found or DOB mismatch):
{
  "code": 404,
  "error": null,
  "status": "Details do not match our records"
}

Feel free to adjust the format or include additional information as needed for your API documentation.

Followers: 1
Resources:
Product Website
API Creator:
Rapid account: James O Neill
James O'Neill
jamesoneill997
Log In to Rate API
Rating: 5 - Votes: 1