ID type: residence permit
Fields returned for the United States residence permit are displayed above the blank row in the following table. Fields that will return no information are displayed below the blank row. 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 MM-dd-yyyy on the card will return the data in the format 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 | |
| Affiliation | N/A | No validation rule | |
| AuthorizedPatronage | N/A | No validation rule | |
| BenefitsNumber | N/A | No validation rule | |
| BloodType | B, F/B | Validates the string against the values [A+, A-, B+, B-, AB+, AB-, O+, O-, UNK] | |
| Branch | N/A | No validation rule | |
| City | N/A | No validation rule | |
| Class | N/A | No validation rule | |
| Country | F, B, F/B | Validates the string against the constant value "United States" | |
| CountryShort | F, B, F/B | Validates the string against the constant value "USA" | |
| DateOfBirth | F, B, F/B | YYYY-MM-DD | Validates the string against the format "dd MMM yyyy" |
| DDRef | N/A | No validation rule | |
| DocumentState | F, B, F/B | Validates the string against the constant value "United States" | |
| DocumentType | F, B, F/B | Validates the string against the constant value "Residence Permit" | |
| EffectiveDate | N/A | No validation rule | |
| ExpirationDate | F, B, F/B | YYYY-MM-DD | Validates the string against the format "mm/dd/yyyy" |
| Eyes | N/A | No validation rule | |
| FirstName | F, B, F/B | Parses the name into the fields: FirstName, MiddleName, LastName, and NameSuffix. | |
| FullName | F, B, F/B | Parses the name into the fields: FirstName, MiddleName, LastName, and NameSuffix. | |
| Gender | B, F/B | M, F | Validates the string against the values [M,F]. |
| GenevaConventionCategory | N/A | No validation rule | |
| Hair | N/A | No validation rule | |
| Height | N/A | No validation rule | |
| IDNumber | F, B, F/B | Validates the string against the format "111-111-1111" | |
| IssueDate | N/A | No validation rule | |
| LastName | F, B, F/B | Parses the name into the fields: FirstName, MiddleName, LastName, and NameSuffix. | |
| License | F, B, F/B | Copies the value of IDNumber | |
| MiddleName | F, B, F/B | Parses the name into the fields: FirstName, MiddleName, LastName, and NameSuffix. | |
| NameSuffix | F, B, F/B | Parses the name into the fields: FirstName, MiddleName, LastName, and NameSuffix. | |
| Nationality | N/A | No validation rule | |
| PayGrade | N/A | No validation rule | |
| Rank | N/A | No validation rule | |
| Sponsor | N/A | No validation rule | |
| SponsorBranch | N/A | No validation rule | |
| SponsorPayGrade | N/A | No validation rule | |
| SponsorRank | N/A | No validation rule | |
| SponsorRelationship | N/A | No validation rule | |
| SponsorStatus | N/A | No validation rule | |
| State | N/A | No validation rule | |
| Weight | N/A | No validation rule | |
| ZIP | N/A | No validation rule |