Based on the provided text description, I’ll format the example requests and responses in English:
code
: Their Sharecode provided by the governmentDOB
: Their Date of Birth in the format dd-mm-yyyyForename
: Their ForenameSurname
: Their Surnameallow_student
(Boolean): Set to True by default; if set to false, student visas will be rejectedallow_sponsorship
(Boolean): Set to True by default; if set to false, visas requiring sponsorship will be rejected{
"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
{
"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"
}
}
{
"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"
}
}
{
"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.