ID type: residence documentation 2008
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 | Validates the string against the constant value "United Kingdom" | |
| CountryShort | F | Validates the string against the constant value "GBR" | |
| DDRef | N/A | No validation rule | |
| DateOfBirth | F | YYYY-MM-DD | Validates the string against the format "dd mmm/mmm yy" |
| DocumentState | F | Validates the string against the constant value "United Kingdom" | |
| DocumentType | F | Validates the string against the constant value "Permanent Residence Card" | |
| ExpirationDate | F | YYYY-MM-DD | Validates the string against the format "dd mmm/mmm yy" |
| Eyes | N/A | No validation rule | |
| FamilyName | N/A | No validation rule | |
| FirstName | F | Parses the name into the fields: FirstName, MiddleName, and LastName | |
| FullName | N/A | No validation rule | |
| Gender | F | [M,F] | 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 | Delimiters removed | Validates the string against the format AAA1111111 |
| IssueDate | F | YYYY-MM-DD | Validates the string against the format "dd mmm/mmm yy" |
| IssuingAuthority | N/A | No validation rule | |
| LastName | F | Parses the name into the fields: FirstName, MiddleName, and LastName | |
| LastName1 | N/A | No validation rule | |
| LastName2 | N/A | No validation rule | |
| License | F | Delimiters removed | No validation rule |
| MiddleName | F | Parses the name into the fields: FirstName, MiddleName, and LastName | |
| NameSuffix | N/A | No validation rule | |
| Nationality | F | No validation rule | |
| ParentsGivenNames | N/A | No validation rule | |
| PersonalNumber | N/A | No validation rule | |
| PlaceOfBirth | N/A | No validation rule | |
| PlaceOfIssue | F | 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 |