Welcome

This help system describes the fields retrieved from supported IDs. These IDs are organized by region, country, and ID type. A list of IDs and variants are listed in Variant list. Unless stated otherwise, all out-of-circulation documents are not supported.

Certain fields are used for all variants, although they are not listed for all documents:

  • FullName: Contains the full name. It is supported for server-side and on-device extraction.

  • Localized fields with names ending with Local (such as FirstNameLocal): Contains strings in non-Latin alphabets (such as Arabic, Cyrillic, and Greek).

  • Photo and Signature: Contains images of an identification photo and signature, if they are provided on the ID.

In some cases, there are unique fields for certain IDs. Those fields are only returned for those IDs that contain them. For example, the Brazilian driver license has information about parent names, so FatherName and MotherName are returned. However, since the US driver license doesn't have this information, FatherName and MotherName fields are left empty.