Applicant Profile Match
A profile for an applicant may be provided during a session's creation. Should it be included, the applicant's profile data will be cross-referenced with all identity documents and address information collected within that session. The result will yield either a "match", "no match" or "partial" status for each piece of data compared. The supplied applicant profile may include any combination of the following fields:
- Name
- Date of birth
- Address
The profile match does not affect the outcome of an identity profile.
Configure the profile
import com.yoti.api.client.docs.session.create.resources.ResourceCreationContainer;import java.util.Map;import java.util.HashMap;public class Main { public static Map<String, Object> address = new HashMap<>(); static { address.put("address_format", 1); address.put("building_number", "74"); address.put("address_line1", "74 AddressLine1"); address.put("town_city", "London"); address.put("postal_code", "E14 3RN"); address.put("country_iso", "GBR"); address.put("country", "United Kingdom"); } public static Map<String, Object> applicantProfileInput = new HashMap<>(); static { applicantProfileInput.put("first_name", "John"); applicantProfileInput.put("middle_name", "James"); applicantProfileInput.put("family_name", "Doe"); applicantProfileInput.put("date_of_birth", "1988-11-02"); applicantProfileInput.put("structured_postal_address", address); } public static void main(String[] args) { SessionSpec sessionSpec = SessionSpec.builder() .withClientSessionTokenTtl(600) .withResourcesTtl(90000) .withUserTrackingId("some-user-tracking-id") .withSdkConfig(sdkConfig) // sdkConfig needs to be defined .withIdentityProfile(identityProfile) // identityProfile needs to be defined .withResources(ResourceCreationContainer.builder() .withApplicantProfile(applicantProfileInput) .build() ) .build(); }}Name
There are three combinations of fields that can be used to configure the candidate name in the applicant profile:
It is crucial to provide the most accurate combination of names whenever possible. Please provide the name split only if you are confident that it is correct.
Favour combination 2 or 3 instead of attempting to split names if unsure.
Combination 1 (preferred)
| Field | Description |
|---|---|
| first_name | The first name of the applicant |
| middle_name | The middle name of the applicant |
| family_name | The surname of the applicant |
Combination 2
| Field | Description |
|---|---|
| given_names | All forenames of the applicant (first and all middle names) |
| family_name | The applicant surname |
Combination 3 (least preferred)
| Field | Description |
|---|---|
| full_name | The full name of the applicant, including all forenames and surname |
Date of birth & Address
| Field | Description |
|---|---|
| date_of_birth | DateOfBirth is the date of birth in the form yyyy-mm-dd. yyyy-mm and yyyy is also accepted, however will result in a partial match against a full identity document date of birth. |
| structured_postal_address | The postal address with a breakdown in address lines. See details for the |
Structured postal address
| Field name | Type | Description |
|---|---|---|
| address_format | number | AddressFormat is used to identify which fields may be present in the JSON object. See table below that defines what format is used for each country. |
| udprn | string | Udprn is the Unique Delivery Point Reference Number that identifies a property throughout its lifecycle. |
| care_of | string | CareOf identifies the owner of the premises. |
| sub_building | string | SubBuilding is used when the building is divided into smaller units (e.g. a block of flats) to identify the sub unit. |
| building_number | string | BuildingNumber is the number of the building. |
| building | string | Building is the name/number of the building. |
| street | string | Street is the name/number of the street the building is on. |
| landmark | string | Landmark is a description used to describe the location of the building. |
| address_line1 | string | AddressLine1 is the first line of the address. |
| address_line2 | string | AddressLine2 is the second line of the address. |
| address_line3 | string | AddressLine3 is the third line of the address. |
| address_line4 | string | AddressLine4 is the fourth line of the address. |
| address_line5 | string | AddressLine5 is the fifth line of the address. |
| address_line6 | string | AddressLine6 is the sixth line of the address. |
| locality | string | Locality is the area the building is in. |
| town_city | string | TownCity is the town/city/village/hamlet/community/etc. that the building is in. |
| subdistrict | string | Subdistrict is the sub-district the building is in. |
| district | string | District is the district the building is in. |
| state | string | State is the state/county the building is in. |
| postal_code | string | PostalCode is a code used by the country's postal service to aid in sorting and delivering mail (e.g. postcode, zipcode, pincode). |
| post_office | string | PostOffice is the post office that serves the area the building is in. |
| country_iso | string | CountryIso is the country the building is in. In ISO-3166-1 alpha-3 format. |
| country | string | Country is the country the building is in. Localised. |
| formatted_address | string | FormattedAddress is the full address in a single human readable string in a format that is suitable for printing onto an envelope. This field is not required when providing address information. |
The below defines the fields of the JSON structure used for all addresses. 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.
Four address formats are available and detailed below:
| Countries that use this format | GBR, JEY, IMN | IND | USA, AUS | All other countries |
| address_format | 1 | 2 | 3 | 4 |
| udprn | Optional | |||
| care_of | Optional | |||
| sub_building | Optional* | |||
| building_number | Optional* | |||
| building | Optional* | Optional | ||
| street | Optional | |||
| landmark | Optional | |||
| address_line1 | Mandatory | Mandatory | Mandatory | |
| address_line2 | Optional | Optional | Optional | |
| address_line3 | Optional | Optional | ||
| address_line4 | Optional | |||
| address_line5 | Optional | |||
| address_line6 | Optional | |||
| locality | Optional | |||
| town_city | Mandatory | Optional | Mandatory | |
| subdistrict | Optional | |||
| district | Optional | |||
| state | Optional | Optional | Mandatory | |
| postal_code | Mandatory | Mandatory | Mandatory | Optional |
| post_office | Optional | |||
| country_iso | Mandatory | Mandatory | Mandatory | Mandatory |
| country | Mandatory | Mandatory | Mandatory | Mandatory |
| formatted_address** | Mandatory | Mandatory | Mandatory | Mandatory |
** At least one must be present
*** Will always be returned in the data extraction, but is not mandatory when configuring an applicant profile
Results
The results of the match will be displayed when retrieving the identity profile. Each data subset will have a result field. If the data subset is not extracted you will get a null response, otherwise the result field will either be "MATCH", "NO_MATCH" or "PARTIAL".
{ // ... "profile_match_report": { "provided_profile": { "current_name": { "given_names": "", "first_name": "John", "middle_name": "James", "family_name": "Doe", "full_name": "" }, "date_of_birth": "1988-05-23", "current_address": { "address": { "address_format": 1, "care_of": "", "sub_building": "", "building_number": "14", "building": "", "street": "", "landmark": "", "address_line1": "14 Grove Avenue", "address_line2": "", "address_line3": "", "address_line4": "", "address_line5": "", "address_line6": "", "locality": "", "town_city": "London", "subdistrict": "", "district": "", "state": "", "postal_code": "W7 3EP", "post_office": "", "country_iso": "GBR", "country": "United Kingdom", "formatted_address": "14 Grove Avenue\nLondon\nW7 3EP\nUnited Kingdom", "udprn": "" }, "move_in": "" } }, "name": { "result": "PARTIAL" }, "dob": { "result": "NO_MATCH" }, "address": { "result": "MATCH" } }}| Result | Description |
|---|---|
| MATCH | The applicant profile data has matched the data extracted from the Id document/s. |
| NO_MATCH | The applicant profile data has not matched the data extracted from the Id document/s. |
| PARTIAL | The applicant profile data has partially matched the data extracted from the Id document/s. |
| null | Data has not been extracted, thus nothing to compare against. |