Check Request

Creating a Request

While the general schema for the request is the same, each visa program requires different set of properties that are required to successfully complete the request.

Property	Format	Description
country	ISO3 Country Code	Country code of the government that issued the visa.
referenceNumber	String	Reference or application number
travelDocument	Object	Document that was used to apply for the visa, usually a passport.
travelDocument.passportNumber	String	Document number
travelDocument.dateOfBirth	Date	Document holder's date of birth
travelDocument.issueDate	Date	Document issue date
travelDocument.expiryDate	Date	Document expiry date
travelDocument.nationality	ISO3 Country Code	Country code that appears on the document in ISO3. Please note that `D` of Germany should be converted to `DEU`
travelDocument.givenNames	String	Document holder's passport name in English
travelDocument.sex	Enum	Sex as appears on the document
entryDocument	Object	The issued entry document, for example eVisa or Entry Permit
entryDocument.type	Enum	Type of entry document
entryDocument.number	String	Entry document number

Required Properties

	USA ESTA	Australian eTA	Singapore eVisa	UAE eVisa / Permit	Malaysia eVisa	Turkey eVisa
country	Required	Required	Required		Required	Required
referenceNumber	Required	Required	Required			Required
travelDocument.passportNumber	Required	Required	Required		Required
travelDocument.dateOfBirth	Required	Required		Required
travelDocument.issueDate	Required
travelDocument.expiryDate	Required
travelDocument.nationality	Required	Required		Required
travelDocument.givenNames				Required
travelDocument.sex				`Female`, `Male`
entryDocument.type				`VISITOR_PERMIT`, `ENTRY_PERMIT`	`E_NTRI`, `E_VISA`
entryDocument.number				Required	Required

The table below shows which properties must be passed to check the validity of an EER .

curl --location --request POST 'https://validation-api-sandbox.joinsherpa.io/v1/check/?key=<<API_KEY>>' \
--header 'affiliateId: sherpa' \
--header 'Content-Type: application/json' \
--data-raw '{
    "country": "UAE",
    "entryDocument": {
        "type": "RESIDENCE_PERMIT",
        "number": "20112291102611"
    },
    "travelDocument": {
        "nationality": "IND",
        "dateOfBirth": "1988-12-21",
        "givenNames": "Aneesha",
        "sex": "Female"
    }
}'

{
    "checkComplete": "COMPLETED",
    "checkedAt": "2020-06-08",
    "details": {
        "validity": "VALID",
        "eerStatus": "APPROVED",
        "message": "'THE RESIDENCE IS VALID UNTIL 20-02-2022'"
    }
}

{
    "checkComplete": "COMPLETED",
    "checkedAt": "2020-06-08",
    "details": {
        "validity": "UNKNOWN",
        "eerStatus": "NOT_FOUND",
        "message": "'UNABLE TO PROCESS YOUR REQUEST WITH GIVEN DETAILS '"
    }
}