Example extractions

AI Tools

This page contains example extraction JSON outputs for ID and supplementary documents, including structured postal address variations. As well as the raw JSON from the AML check

ID documents

ID document extractions can contain different fields depending on the document captured:

{ "full_name": "ANGELA ZOE UK SPECIMEN", "date_of_birth": "1988-12-04", "nationality": "GBR", "given_names": "ANGELA ZOE", "family_name": "UK SPECIMEN", "place_of_birth": "CROYDON", "gender": "FEMALE", "document_type": "PASSPORT", "issuing_country": "GBR", "document_number": "533028754", "expiration_date": "2025-09-28", "date_of_issue": "2015-09-28", "issuing_authority": "HMPO", "mrz": { "type": 2, "line1": "P<GBRUK<SPECIMEN<<ANGELA<ZOE<<<<<<<<<<<<<<<<", "line2": "5330287549GBR8812049F2509286<<<<<<<<<<<<<<02" }, "document_template": { "front_page_name": "United Kingdom - ePassport (2015)" } }

{ "full_name": "STEVONNE ANNA MITCHELITE", "date_of_birth": "1992-02-22", "given_names": "STEVONNE ANNA", "family_name": "MITCHELITE", "place_of_birth": "UNITED KINGDOM", "gender": "FEMALE", "structured_postal_address": { "address_format": 1, "building_number": "244", "address_line1": "244 MANNER ROAD", "address_line2": "SONYMANE", "address_line3": "SWANSEA", "town_city": "SWANSEA", "postal_code": "SA8 8JA", "country_iso": "GBR", "country": "United Kingdom", "formatted_address": "244 MANNER ROAD, SONYMANE, SWANSEA,\nSA8 8JA" }, "document_type": "DRIVING_LICENCE", "issuing_country": "GBR", "document_number": "MITCH952222SA8KK22", "expiration_date": "2028-11-01", "date_of_issue": "2021-11-02", "issuing_authority": "DVLA", "driving_licence_class": "AM/A/B1/B//p/q", "driving_licence_restriction_code": "115", "document_template": { "front_page_name": "United Kingdom - Driving License (2021) #2", "back_page_name": "United Kingdom - Driving License (2014-2021) Side B" } }

{ "full_name": "TECH REFRESH ICTHREEMALE", "date_of_birth": "1990-08-01", "nationality": "KEN", "given_names": "TECH REFRESH", "family_name": "ICTHREEMALE", "place_of_birth": "NAIROBI", "gender": "MALE", "document_type": "RESIDENCE_PERMIT", "issuing_country": "GBR", "document_number": "RF9082242", "expiration_date": "2015-11-11", "date_of_issue": "2015-05-19", "mrz": { "type": 1, "line1": "IRGBRRF90822427<<<<<<<<<<<<<<<", "line2": "9008010M1511114KEN<<<<<<<<<<<8", "line3": "ICTHREEMALE<<TECH<REFRESH<<<<<" }, "place_of_issue": "UK" }

{ "full_name": "Erika Mustermann", "date_of_birth": "1964-08-12", "given_names": "Erika", "family_name": "Mustermann", "place_of_birth": "Berlin", "document_type": "DRIVING_LICENCE", "issuing_country": "DEU", "document_number": "Z021AB37X13", "expiration_date": "2036-03-19", "date_of_issue": "2021-03-20", "place_of_issue": "Landratsamt\nMu sterhausen amSee" }

{ "full_name": "CARMEN ESPANOLA ESPANOLA", "date_of_birth": "1980-01-01", "nationality": "ESP", "given_names": "CARMEN", "family_name": "ESPANOLA ESPANOLA", "place_of_birth": "MADRID (MADRID)", "gender": "FEMALE", "document_type": "PASSPORT", "issuing_country": "ESP", "document_number": "ZAB000254", "expiration_date": "2025-01-01", "date_of_issue": "2015-01-01", "issuing_authority": "DGP -28391A6PK", "mrz": { "type": 2, "line1": "P<ESPESPANOLA<ESPANOLA<<CARMEN<<<<<<<<<<<<<<", "line2": "ZAB0002549ESP8001014F2501017A9999999900<<<44" }, "personal_identification_number": "A9999999900" }

{ "full_name": "John Dee Doe", "date_of_birth": "2003-10-27", "given_names": "John Dee", "first_name": "John", "middle_name": "Dee", "family_name": "Doe", "gender": "MALE", "weight": "140 lbs", "height": "76 in", "eye_color": "BLU", "structured_postal_address": { "address_format": 3, "address_line1": "123 MAIN STREET APT. 1", "town_city": "CARSON CITY", "state": "NV", "postal_code": "89701-0000", "country_iso": "USA", "country": "USA", "formatted_address": "123 MAIN STREET APT. 1, CARSON CITY, NV, 897010000" }, "document_type": "STATE_ID", "issuing_country": "USA", "document_number": "123456789012", "expiration_date": "2028-10-27", "date_of_issue": "2020-10-25", "issuing_authority": "Nevada", "driving_licence_class": "A", "driving_licence_restriction_code": "NONE", "driving_licence_endorsed": "NONE", "document_template": { "front_page_name": "United States - Nevada Id Card (2021) Real", "back_page_name": "United States - Nevada Id Card (2021) Side B" } }

Supplementary Documents

All extractions for supplementary documents will carry the same JSON structure:

{ "full_name": "ANNA GREEN", "structured_postal_address": { "address_format": 1, "building_number": "50", "street": "Mast House Terrace", "address_line1": "50 Mast House Terrace", "town_city": "London", "state": "Greater London", "postal_code": "E14 3RN", "country_iso": "GBR", "country": "United Kingdom", "formatted_address": "50 Mast House Terrace\nE143RN London\nE14 3RN" }, "date_of_issue": "2020-05-26", "organisation": "Plusnet" }

{ "full_name": "ROGER ROGERS", "structured_postal_address": { "address_format": 1, "building_number": "60", "street": "Mast House Terrace", "address_line1": "60 Mast House Terrace", "town_city": "London", "state": "Greater London", "postal_code": "E14 3RN", "country_iso": "GBR", "country": "United Kingdom", "formatted_address": "60 Mast House Terrace\nE143RN London\nE14 3RN" }, "date_of_issue": "2020-02-06", "organisation": "Thames Water" }

{ "full_name": "JOHN JONES", "structured_postal_address": { "address_format": 1, "building_number": "50", "street": "Mast House Terrace", "address_line1": "50 Mast House Terrace", "town_city": "London", "state": "Greater London", "postal_code": "E14 3RN", "country_iso": "GBR", "country": "United Kingdom", "formatted_address": "50 Mast House Terrace\nE143RN London\nE14 3RN" }, "date_of_issue": "2003-11-08", "organisation": "First Bank of Wiki" }

Address formats

Addresses will be returned in 1 of 4 different formats.

{ "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, "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, "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" }

{ "address_format": 4, "address_line1": "910 GOVERNMENT ST VICTORIA BC V8W 3Y8", "country_iso": "CAN", "country": "Canada", "formatted_address": "910 GOVERNMENT ST VICTORIA BC V8W 3Y8" }

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

AML JSON

An example of the raw AML response can be found below:

{ "code": 200, "status": "success", "content": { "data": { "id": 616943686, "ref": "1629902969-04sjnJ47", "searcher_id": 13017, "assignee_id": 13017, "filters": { "types": [ "sanction", "warning", "fitness-probity", "pep", "adverse-media", "pep-class-1", "pep-class-2", "pep-class-3", "pep-class-4", "adverse-media-financial-crime", "adverse-media-violent-crime", "adverse-media-sexual-crime", "adverse-media-terrorism", "adverse-media-fraud", "adverse-media-narcotics", "adverse-media-general" ], "country_codes": [ "GB" ], "birth_year": 1988, "entity_type": "person", "remove_deceased": 0, "exact_match": false, "fuzziness": 0.5 }, "match_status": "no_match", "risk_level": "unknown", "search_term": "ANGELA ZOE UK SPECIMEN", "submitted_term": "ANGELA ZOE UK SPECIMEN", "client_ref": null, "total_hits": 0, "updated_at": "2021-08-25 14:49:29", "created_at": "2021-08-25 14:49:29", "tags": { "ADVANCED_check": "b61148f4-dde7-485a-9c4a-b08cf05bf570" }, "labels": [ { "type": "tag", "name": "ADVANCED_check", "value": "b61148f4-dde7-485a-9c4a-b08cf05bf570" } ], "total_matches": 0, "limit": 100, "offset": 0, "searcher": { "id": 13017, "email": "Test@yoti.com", "name": "Test API User", "phone": "", "created_at": "2021-03-02 09:28:03", "user_is_active": true }, "assignee": { "id": 13017, "email": "Test@yoti.com", "name": "Test API User", "phone": "", "created_at": "2021-03-02 09:28:03", "user_is_active": true }, "hits": [] } } }

Last updated on

Was this page helpful?