Attributes explained
Yoti supports multiple documents and documents types from all over the world! These are stored as attributes on the Digital ID app.
This section describes all the attributes Yoti supports in more detail. If you wish to select attributes for your integration you will need to ensure you have a Hub account and create a Digital ID application.
There is a small explanation of each attribute and what the content type is:
| Name | Content Type | Explanation | Example |
|---|---|---|---|
| remember_me_id | STRING | When you retrieve the user profile, you receive a user ID generated by Yoti exclusively for your application. This means that if the same individual logs into another app, Yoti will assign her/him a different ID. See below for more information. | <UUID> |
| parent_remember_me_id | STRING | If you have more than one application. When you retrieve the user profile, you receive a user ID generated by Yoti exclusively for each application. | <UUID> |
| Photo | JPEG | Photograph of user, encoded as a JPEG image. | N/A |
| full_name | STRING | The user's full name. If family_name/given_names are present, this will be equal to the string ${given_names} + " " + ${family)_name}. | "Jon Jim Fred Foo" |
| given_names | STRING | Corresponds to secondary names on a passport, and first/middle names in English. | "Jon Jim Fred" |
| family_names | STRING | FamilyName is the family name. Not all documents provide split given names and family name | "Foo" |
| phone_number | STRING | The user's phone number, as verified during registration. This will be a number in E.164 format | "+447777123456" |
| email_address | STRING | The user's verified email address. | "test@test.com" |
| date_of_birth | DATE | Date of birth of the user in the form yyyy-mm-dd, or yyyy-mm or yyyy. | "2000-12-01" |
| age_over:[1-999] | STRING | Whether the user is over the specified age, as calculated from their date of birth. Either "true" or "false". | "TRUE", "FALSE" |
| address | STRING | Full address | "6th Floor, 107 Leadenhall St, London, EC3A 4AF" |
| structured_postal_address | JSON | StructuredPostalAddress is the postal address with the breakdown in address lines, post code and so on as well as the formatted address all in one line. See details for structured_postal_address JSON properties below. | N/A |
| gender | STRING | Corresponds to the gender in the registered document. | "MALE", "FEMALE", "TRANSGENDER" or "OTHER" |
| nationality | STRING | Corresponds to the nationality on the passport. ISO-3166-1 alpha-3 code with ICAO9303 (passport) extensions. See Wikipedia page for ISO-3166-1 alpha-3 codes, and see ICAO 9303 part 3 (section 5 part A) for the extended list of codes. | "GBR" |
| selfie_authentication | BOOLEAN | This is to prompt the user to take a selfie of themselves live via the Digital ID app as extra level of security. | |
| document_details* | STRING |
| |
| document_images* | MULTI_VALUE | Contains a jpeg image of the document. |
*These attributes are not available via the Hub UI. You will need to use the advanced policy view - See below.
Parent and Remember me id explained
When a user completes a share with you, Yoti generates two unique Remember Me IDs.
One is for the specific application being used, and one is at an organisation level (parent). This means the user does not have to share their personal details every time, as you can just ask for your Remember Me ID instead.
For example, if you have two applications:
- Application 1 offered by Company ABC
- Application 2 offered by the same Company ABC That share will contain the same Company ABC ID and a different ID for application 2. Yoti has no access to these IDs. This approach is in line with Yoti’s data minimisation principle, meaning users should only share the details relevant to what you are doing.
Address attributes
Yoti has two options to show clients addresses:
1) Full address:- the address as a string.
2) Structured address:- a broken down version of an address.
There is a small explanation of each attribute and what the content type is.
| Name | Expected content type | Explanation |
|---|---|---|
| building_number | STRING | The number of the building. |
| building_name | STRING | The name of the building. |
| sub_building_name | STRING | The subtitle of the building. |
| address_line_1 | STRING | The first line of the address. |
| address_line_2 | STRING | The second line of the address. |
| address_line_3 | STRING | The third line of the address. |
| town | STRING | The town of the address. |
| country | STRING | The country of the address. |
| postal_code | STRING | The postcode for the address. |
| postal_address | STRING | The full address. |
| structured_postal_address | JSON | The full address in both machine readable form and human readable form |
The below defines the fields of a JSON structure that can be used to define any address. A subset of fields will be present in each case and address_format can be used to ascertain which ones for any given address. The country iso should not be used for this purpose.
We have four formats shown below:
| Field | Format 1 (UK) | Format 2 (INDIA) | Format 3 (USA) | Format 4 (ROW) |
|---|---|---|---|---|
| udprn | Optional | |||
| care_of | Optional | |||
| sub_building | Optional | |||
| building_number | Optional | |||
| building | Optional | Optional | ||
| street | Optional | |||
| landmart | Optional | |||
| address_line_1 | Present | Present | Present | |
| address_line_2 | Optional | Optional | Optional | |
| address_line_3 | Optional | Optional | ||
| address_line_4 | Optional | |||
| address_line_n* | Optional | |||
| locality | Present | Optional | Present | |
| town_city | Present | Optional | Present | |
| subdistrict | Optional | |||
| district | Optional | |||
| state | Optional | Optional | Present | Optional |
| postal_code | Present | Present | Present | |
| post_office | Optional | |||
| country_iso | Present | Present | Present | Present |
| country | Present | Present | Present | Present |
| formatted_address | Present | Present | Present | Present |
*The letter "n" represents a numerical figure. Yoti supports up to 6 lines of addresses.
Address Format 1
The UK address format is as shown below with an example:
{ "address_format": 1, "building_number": "15a", "address_line1": "15a North Street", "town_city": "CARSHALTON", "postal_code": "SM5 2HW", "country_iso": "GBR" "country": "UK", "formatted_address": "15a North Street\nCARSHALTON\nSM5 2HW\nUK"}Address Format 2
The India address format is as shown below with an example:
{ "address_format": 2, "care_of": "S/O: Vipen Kumar Aggarwal", "building": "House No.86-A", "street": "Rajguru Nagar", "town_city": "Rajguru Nagar", "subdistrict": "Ludhiana", "district": "Ludhiana", "state": "Punjab", "postal_code": "141012", "post_office": "Rajguru Nagar", "country_iso": "IND", "country": "India", "formatted_address": "S/O: Vipen Kumar Aggarwal\nHouse No.86-A\nRajguru Nagar\nLudhiana\nPunjab\n141012\nIndia"}Address Format 3
The US address format is as shown below with an example:
{ "address_format": 3, "address_line1": "1512 Ferry Street", "town_city": "Anniston", "state": "AL", "postal_code": "36201", "country_iso": "USA", "country": "USA", "formatted_address": "1512 Ferry Street\nAnniston AL 36201\nUSA"}