Unit21 API Data Schema Mapping - Oct 2021

	A	B	C	D	E	F	G	H
1	Sections	Fields	Customer System/Field	Type	Field Length	Field Definition	Field Values
2
3	general_data	entity_id		string	128	The unique identifier for an entity, as defined in your system	Ex. "1a2b3c4d5e"	required
4		entity_type		enum		The type of user in your system. Must be either user or business	"user" or "business'"
5		entity_subtype		string	128	Extra information about how your organization classifies the entity. You MAY enter any value	Ex. "Contractor"
6		status		string	128	Status of the object on your system. You MAY enter any string value.	Ex "Active"
7		registered_at		int		Date in seconds since 1 Jan 1970 00:00:00 UTC (i.e. in Unix time).	Ex. "1623365011"
8		parents[ ].parent_entity_id		string		The unique identifier for an entity, which is the parent of the this entity in your system, as defined by you	"userB-02cc742d-1e5c-4671-b2c2-728c47fea455\"
9		parents[ ].parent_entity_type		enum		The type of user the parent is within your system. Must be either user or business	"user" or "business'"
10		tags		array of strings	[257]	Additional information that can be used for grouping and filtering in "key:value" format	Ex. "sector:Europe", "source:UK_internal"
11
12	user_data (provided only for individuals, i.e. "entity_type='User")	first_name		string	128	First name of the user	Ex. "John"
13		middle_name		string	128	Middle name of the user	Ex. "Joseph"
14		last_name		string	128	Last name of the user	Ex. "Smith"
15		day_of_birth		int		Date of birth of the user	Ex. "23"
16		month_of_birth		int		Month of birth of the user	Ex. "12"
17		year_of_birth		int		Year of birth of the user	Ex. "1990"
18		gender		enum		Gender of the user	"Male", "Female", "Other"
19		ssn		string	64	Social security number of "User", in the format of "xxx-xx-xxxx"	Ex. "123-45-6789"
20
21	business_data (provided only for corporations, i.e. "entity_type="Business")	business_name		string	128	The registered name of the business	Ex. "Acme"
22		corporate_tax_id		string	128	The TIN/EIN of the business	Ex. "111-222-3333"
23		account_holder_name		string	128	The name of the main person associated with the business	Ex. "John Smith"
24		registered_state		string	128	State or region where the business is registered. For the U.S., use the two character state code. For non-U.S., use the ISO 3166-2 standard	Ex. "NY"
25		registered_country		string	128	Country where the business is registered - use the ISO 3166-1 standard	Ex. "US"
26		doing_business_as		string	512	Operating name of business	Ex. "Global Liquids"
27		website		string	128	website of business	Ex. "www.unit21.ai"
28
29	document_data (IDV)	document_id		string	128	The ID or number of the document	Ex. "G3352403F"
30		document_type		string	128	The type of document. Supported SARS types are: "drivers_license", "passport", "other", "alien_registration"	Ex. "drivers_license"
31		state		string	128	For the U.S., use the two character state code. For non-U.S., use the ISO 3166-2 standard	Ex. "NY"
32		country		string	128	Use the ISO 3166-1 standard	Ex. "US"
33		issued_at		int		Date when document was created, in seconds since 1 Jan 1970 00:00:00 UTC (i.e. in Unix time)	1572673226
34		expires_at		int		Date when document expires, in seconds since 1 Jan 1970 00:00:00 UTC (i.e. in Unix time)	1572673226
35
36	communication_data	email_addresses		array of strings	[128]	List of Email addresses associated with the entity	["jsmith47@company.com"]
37	communication_data	phone_numbers		array of strings	[128]	List of phone numbers associated with the entity, in E.164 format.	["+14159627132"]
38
39	location_data	type		string	24	A field indicating the type of location	Ex. "Shipping", "Billing"
40		building_number		string	24	Building number of the location	Ex. "66"
41		unit_number		string	24	Flat/apartment/suite number of the building	Ex. "22A"
42		street_name		string	128	Street name of the location	Ex. "California Avenue"
43		city		string	128	City of the location	Ex. "Redmond"
44		state		string	128	State or region for the location. For the U.S., use the two character state code. For non-U.S., use the ISO 3166-2 standard	Ex. "CA"
45		postal_code		string	128	Postal code of the location	Ex. "07710-0001"
46		country		string	2	Country of the location - use the ISO 3166-1 standard	Ex. "US"
47
48	digital_data.ip_address			array of objects
49		ip_address		string		List of IP addresses. MUST be in either IPv4 or IPv6 format. Used for geolocating.	52.15.247.208
50		first_seen		int		Date in seconds since 1 Jan 1970 00:00:00 UTC (i.e. in Unix time)	1572643225
51		last_seen		int		Date in seconds since 1 Jan 1970 00:00:00 UTC (i.e. in Unix time)	1572673225
52
53	digital_data.client_fingerprint	fingerprint		string	1024	Fingerprints associated with this entity	"4908hsdfknkd90432nj3k2kj2jk23kj2k3jk2j3"
54		first_seen		int		Date in seconds since 1 Jan 1970 00:00:00 UTC (i.e. in Unix time)	1572643226
55		last_seen		int		Date in seconds since 1 Jan 1970 00:00:00 UTC (i.e. in Unix time)	1572673229
56
57	instrument_ids	object		array of strings		Instrument id associated with this entity	"123456789"
58
59	custom_data (freeform JSON)	object		key:value pairs		Any additional information that should be associated with this entity
60				string:string, string, int, string:boolean			Ex. "Approved by": "John Doe", "Score": 3, "VIP":true
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100