Extract
AssureID extracts (accesses, reads, and obtains) biographic and data contained in OCR-readable text, a 1D barcode, 2D barcode, magnetic stripe, or contactless chip fields. These fields are described in the following table.
Standard document fields
Section titled “Standard document fields”The standard document fields supported by AssureID are described below. GBG recommends using these standard fields because they contain the most reliable (best available) data on a document.
| Field | Description |
|---|---|
| Address | The person’s legal, residence, or mailing address |
| Address Line 1 | First address line of the person’s legal, residence, or mailing address |
| Address Line 2 | Second address line of the person’s legal, residence, or mailing address |
| Address City | City of the person’s legal, residence, or mailing address |
| Address State | State of the person’s legal, residence, or mailing address |
| Address Postal Code | Postal code of the person’s legal, residence, or mailing address |
| Application Date | Date that the person applied for the document |
| Application Number | Identifying number of the application document |
| Birth Date | The person’s date of birth |
| Birth Place | The person’s place of birth |
| Blood Type | The person’s blood type |
| Compressed Fingerprint | Compressed image of the person’s fingerprint |
| Control Number | Manufacturer’s reference number for the document |
| Country of Issue Code | Code for the country that issued the document |
| Country of Issue Name | Full name of the country that issued the document |
| Document Class Code | Class code extracted from the MRZ on the document that indicates the document type |
| DD Number | A 16-digit document discriminator (DD) code introduced by the AAMVA that uniquely identifies where and when an ID was issued |
| Document Number | A number that identifies a document |
| Expiration Date | Date that the document will expire |
| Employer Name | Name of the person’s employer |
| Employer Address | Full address of the person’s employer |
| Entries | Number of entries permitted |
| Eye Color | The person’s eye color |
| Father’s Name | Full name of the person’s father |
| Fingerprint | Image of the person’s fingerprint |
| Full Name | The person’s full name (given name plus surname) |
| Given Name | The person’s given name |
| Hair Color | The person’s hair color |
| Height | The person’s height |
| Issue Date | Date that the document was issued |
| Issuing Authority | Authorized organization that issued the document |
| Issuing District Code | Code that identifies the issuing district |
| Issuing State Code | Abbreviated ID code of the state or country that issued the document |
| Issuing State Name | Full name of the state or country that issued the document |
| License Class | Class of vehicle that the person is licensed to drive |
| License Endorsements | Indicates the type and weight of vehicle that the person is allowed to operate |
| License Restrictions | Restrictions for license use, for example, wearing corrective lenses |
| Marital Status | The legally defined marital state of a person, as defined by the country, state, or local jurisdiction. Also referred to as civil status. Note that this field is not translated. |
| Mother’s Name | The person’s mother’s name |
| MRZ | Text extracted from the machine-readable zone (MRZ) of the document |
| Name Prefix | A title or status that precedes a person’s name, indicating the person’s marital status, military rank, or religious title. For example, Mr., Ms., or Mrs., Maj., or Rev. |
| Name Suffix | The person’s name suffix |
| Nationality Code | Code that indicates the nationality of the person (typically in ISO 3166-1 alpha-3 format) |
| Nationality Name | The person’s nationality |
| Occupation | The person’s occupation |
| Organ Donor | Indicates whether the person is an organ donor |
| Passport Number | Identifying number of the passport that typically appears on a Visa or Residence document |
| Pay Grade | A military designation that specifies the rate of compensation that is. associated with the member’s rank |
| Permit Number | Identifying number of a permit |
| Personal Number | A number associated with a specific person |
| Photo | A person’s image |
| Photo Compressed | A person’s compressed image |
| Rank | A military designation that indicates a member’s hierarchical position in the chain of command and the corresponding pay grade |
| REAL ID Compliant | Indicates whether the document is a form of identification that meets the increased security standards for US state-issued driver’s licenses and identification cards under the REAL ID Act (U.S. only) Values: True | False |
| Social Security Number | The person’s social security number |
| Sex | A single character (translated into M/F from other languages) that identifies the person’s gender |
| Signature | An image of the person’s signature |
| Start Date | Date on which a document (for example a passport) is valid for use |
| Surname | The person’s surname or family name |
| Visa Number | Identifying number of the visa |
| Visa Class | Class of the visa |
| Weight | The person’s weight or weight class |
Data source field prefixes
Section titled “Data source field prefixes”AssureID uses the following 2- or 3-character data source identifiers (prefixes) to use with standard field names: VI, VIZ, 1D, 2D, MS, and SC.
Example
Section titled “Example”The following example shows the naming convention for data-source specific fields for Birth Date (the person’s date of birth). This is the document field as obtained from the most reliable and accurate data source on the document:
| Data source | Prefix | Description |
|---|---|---|
| SC Birth Date | SC | Person’s date of birth extracted from the contactless chip |
| MS Birth Date | MS | Person’s date of birth extracted from the magnetic stripe |
| 1D Birth Date | 1D | Person’s date of birth extracted from the 1D barcode |
| 2D Birth Date | 2D | Person’s date of birth extracted from the 2D barcode |
| VI Birth Date | VI | Person’s date of birth extracted from the machine-readable zone (MRZ) |
| VIZ Birth Date | VIZ | Person’s date of birth extracted from the visual inspection zone (VIZ) using optical character recognition (OCR) |
| VZ2 Birth Date | VZ2 | Person’s date of birth extracted from the visual inspection zone (VZ2) using an alternate method of optical character recognition (OCR) |
Raw data fields
Section titled “Raw data fields”Standard fields are also defined to represent the raw data extracted from the various data sources that may be present on a document. Each raw data field (except Data_2DBarcode) exists only if it is provided by the device. The following table provides some examples of raw data fields.
| Field | Description |
|---|---|
| Data_Magstripe | Raw magnetic stripe data |
| Data_2DBarcode | Raw 2D barcode data |
| Data_MRZ | Raw machine-readable zone data |
| Data_SmartCard_XX.XXX | Raw data from contactless chip data group X |
Name and address parsing
Section titled “Name and address parsing”AssureID always separates the names (such as first, middle, last name) and addresses into parts for U.S. and Canadian documents. AssureID uses the information contained in document fields, including magstripe or barcode data, when they can be distinguished (for example, using spaces or comma separators). The way AssureID performs this action may differ, based on the country of issuance or country-specific formatting (for example, names in documents from China).
Native fields
Section titled “Native fields”If there is a Latin and non-Latin version of the field, the Latin version is referred to as the normal field and the non-Latin version is the called the native field. If the only field present is non-Latin, it may be returned as either the normal or native field. The document type also needs to have been trained to extract the native fields. Not all documents with native language fields have been trained to extract the native fields. Some documents may contain other non-standard/custom native fields. AssureID supports the following standard native fields (if they appear on the document):
- Surname Native
- Given Name Native
- Full Name Native
- Father’s Name Native
- Mother’s Name Native
- Address Native
- Birth Place Native
- Issuing Authority Native
- Sex Native
- Nationality Name Native
Language support
Section titled “Language support”All API calls now support the Accept-Language header, which lets you display authentication details (responses) in a specified language. AssureID supports the following languages:
- Arabic (ar)
- French (fr)
- Portuguese (pt)
- Czech (cs)
- German (de)
- Russian (ru)
- Dutch (nl)
- Greek (el)
- Spanish (es)
- English (en)
- Italian (it)
- Turkish (tr)
The following example shows the Accept-Language header for the languages English (en) and German (de).
Character set support
Section titled “Character set support”AssureID supports optical character recognition (OCR) of the following character sets:
- Arabic
- Korean
- Baltic
- Cyrillic
- Latin
- Chinese
- Thai
- Greek
- Vietnamese
- Hebrew
- Turkish
- Japanese