ID type: residence permit 2008-2011

Fields returned for the United Kingdom residence permit are displayed above the blank line in the following table. Fields that will return no information are displayed below the blank line. An F denotes that the field will be returned if the front of the card is sent, a B denotes that the field will be returned if the back of the card is sent, and F/B denotes that the field will be returned if the front and back of the card are sent.

The Returned as column shows the normalized format the data will be returned as. A DateOfBirth that is formatted as dd mmm/mmm yy on the card will return the data in the YYYY-MM-DD for the DateOfBirth field according to the rules in the following table, for example.

Some fields are validated against certain rules. Not all fields have validation rules. For fields that have a validation rule, a description of the rule will be included in the Validation Rules column. In the Returned as and Validation Rules columns, a capital A denotes any letter, a 1 denotes any number, a ? can either be a letter or a number, and any other symbol, such as a hyphen, used is literal.

Field Side Returned as Validation Rule
Address N/A No validation rule
Address2 N/A No validation rule
Address3 N/A No validation rule
Address4 N/A No validation rule
Address5 N/A No validation rule
Address6 N/A No validation rule
City N/A No validation rule
CivilStatus N/A No validation rule
Class N/A No validation rule
Country F, B*, F/B* Validates the string against the constant value "United Kingdom"
CountryShort F, B*, F/B* Validates the string against the constant value "GBR"
DDRef N/A No validation rule
DateOfBirth B*, F/B* YYYY-MM-DD Validates the string against the format "dd-mm-yyyy"
DocumentState F, B*, F/B* Validates the string against the constant value "United Kingdom"
DocumentType F, B*, F/B* Validates the string against the constant value "Residence Permit"
ExpirationDate F, B*, F/B* YYYY-MM-DD Validates the string against the format "dd-mm-yyyy"
Eyes N/A No validation rule
FamilyName N/A No validation rule
FirstName F, B*, F/B* Parses the name into the fields: FirstName, MiddleName, and LastName
FullName N/A No validation rule
Gender B*, F/B* Validates the string against the values [M,F].
Hair N/A No validation rule
HealthSystemNum N/A No validation rule
Height N/A No validation rule
IDNumber F, B*, F/B* Validates the string against the format [AA1111111, AAA111111]
IssueDate F, F/B* YYYY-MM-DD Validates the string against the format "dd-mm-yyyy"
IssuingAuthority N/A No validation rule
LastName F, B*, F/B* Parses the name into the fields: FirstName, MiddleName, and LastName
LastName1 N/A No validation rule
LastName2 N/A No validation rule
License F, B*, F/B* Copies the value of IDNumber
MiddleName F, B*, F/B* Parses the name into the fields: FirstName, MiddleName, and LastName
NameSuffix N/A No validation rule
Nationality B*, F/B* No validation rule
ParentsGivenNames N/A No validation rule
PersonalNumber N/A No validation rule
PlaceOfBirth B*, F/B* No validation rule
PlaceOfIssue F, F/B* No validation rule
SocialSecurityNum N/A No validation rule
State N/A No validation rule
TaxID N/A No validation rule
Weight N/A No validation rule
ZIP N/A No validation rule