Verify

Send request for e-visa verification status.

{{baseUrl}}/verify

Headers:

Content-Type: application/json
client-id: {{client-id}}
x-api-key: {{x-api-key}}

Sample Request Body:

{
    "shareCode": "S** ** **C",
    "dob": "01/01/2000",
    "jobTitle": "Verifier's JOb Title",
    "orgName": "Verifier's Organisation Name",
    "purpose": "Verifier's Purpose"
}

Attributes in Request Body

Attribute	Required	Description
shareCode	yes	The unique share code for immigration verification.
dob	yes	The date of birth in DD/MM/YYYY format.
jobTitle	yes	The job title of the individual verifying.
orgName	yes	The organization name associated with the verification.
purpose	yes	The purpose of the verification (must match one of the allowed purposes).

Send Request

Click Send and wait for the response.

Sample Response Body:

{
    "name": "John Doe",
    "dateOfBirth": "01 January 2000",
    "nationality": "IND",
    "status": "Dependant",
    "immigrationLimit": "There is no limit on how long they can stay in the UK.",
    "companyName": "Your Company Name",
    "jobTitle": "Your Job Ttile",
    "dateOfCheck": "18 January 2025",
    "referenceNumber": "SC-***8***-FX",
    "purposeOfCheck": "Your Purpose",
    "profileImage": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEBLAEsAAD/2wBDA..."
}

Output Parameters

Attribute	Description
name	The full name of the individual.
dateOfBirth	The date of birth of the individual.
nationality	The nationality of the individual.
status	The immigration status of the individual.
immigrationLimit	Details on any immigration limitations.
companyName	The company name associated with the verification.
jobTitle	The job title provided in the verification process.
dateOfCheck	The date when the immigration check was performed.
referenceNumber	The reference number for the immigration verification.
purposeOfCheck	The purpose for which the immigration check was conducted.
profileImage	The base64-encoded profile image retrieved from the verification.