There are various objects used throughout the API. Here is a centralized reference.

Contact

Field	Data Type	Description	Example
id	unsigned integer	The internal ID of the Contact	647dccb3a16b7
profile_icon	string	URL to the Contact’s profile icon. null if profile icon does not exist.	https://cdn.privacybee.com/...
display_name	string	Freeform user-defined name for the Contact	Beth M.
birthday	date	The Contact’s date of birth (YYYY-MM-DD), optionally set by the current user	1975-11-24
email	array[Email]	All the Email Addresses belonging to the Contact.	["bethm@privacybee.com", "beth.m@example.com"]
phone	array[Phone]	All the Phone numbers belonging to the Contact.	["+12385551629", "+12384152637" "+12374151432" ]
address	array[Address]	All the Addresses belonging to the Contact.	["123 ABC, Apartment 14, Alpharetta,GA,30005,US", "123 Peachtree St, Apartment 132, Atlanta, GA,30303,US" ]
risk_score	unsigned integer	The Contact’s Privacy Risk Score (1-99). The value can be null if the score is still being calculated.	92
labels	array[string]	Organizational labels assigned to this Contact.	["Client", "Newsletter Subscriber"]
user_id	unsigned integer	The default value is null which means that the contact is still a pending invitation. If the Contact has been connected and confirmed to an existing Privacy Bee user, this field will hold their User ID.	54198486
e2ee	boolean	Whether this Contact have a paid Privacy Bee license which supports communication over member-to-member End-to-End Encryption	true
created	date	The date the Contact was initially created by this user	2023-02-10
updated	date	The date this Contact was last updated (by either the current user or the owner). This is helpful for checking if local cache updates are needed.	2023-07-15

---

ContactEmail

Field	Data Type	Description	Example
id	unsigned integer	The internal ID of the ContactEmail	74980364
contact_id	unsigned integer	ContactEmail owner	5
email	string	Email address	pb@privacybee.com
created_at	date	The date the ContactEmail object was initially created	2023-01-15
updated_at	date	The date when the ContactEmail object was last updated	2023-03-17

---

ContactPhoneNumber

Field	Data Type	Description	Example
id	unsigned integer	The internal ID of the ContactPhoneNumber	74980364
contact_id	unsigned integer	ContactPhoneNumber owner ID	5
country_code	integer	Country Code without “+“	1
phone_number	integer	Phone number	5551286565
created_at	date	The date the ContactPhoneNumber object was initially created	2023-01-15
updated_at	date	The date the ContactPhoneNumber object was last updated	2023-02-15

---

ContactAddress

Field	Data Type	Description	Example
id	unsigned integer	The internal ID of the ContactAddress	74980364
contact_id	unsigned integer	ContactAddress owner	5
address_line_1	string	Line 1	123 ABC
address_line_2	string	Line 2	Apartment 14
address_city	string	City	Alpharetta
address_region	string	State	GA
address_postal_code	string	Postal Code	30005
address_country	string	Country Code	US
created_at	date	The date the ContactAddress object was originally created	2023-01-15
updated_at	date	The date the ContactAddress object was last updated	2023-01-15

---

Person

Field	Data Type	Description	Example
id	unsigned integer	The internal ID of the user account	74980364
first_name	string	The employee’s first name	Eduard
middle_name	string	The employees middle name	Gabriel
last_name	string	The employee’s last name	Bettley
display_name	string	Full name of the employee	Eduard Gabriel Bettley
dob	date	Date of birth (YYYY-MM-DD)	1975-11-24
addresses	array[Address]	Array of address object	["123 ABC, Apartment 14, Alpharetta,GA,30005,US", "123 Peachtree St, Apartment 132, Atlanta, GA,30303,US" ]
emails	array[Email]	Array of email objects	["eduard.bettley@privacybee.com", "egb@privacybeeharry.com"]
phone_numbers	array[Phone]	Array of phone number objects	["+12385551629", "+12384152637" "+12374151432" ]
last_scan_at	datetime	Time and date of the last global scan of sites for this employees data	2024-04-26T00:00:00Z
license	License	License object. If no license assigned to the employee, the value is null	{License}
roles	Array<string>	List of roles employee has	["HR Manager", "Consultant"]
risk_score	integer	Current risk score of employee	62
exposures	ExposureStats	Exposure statistics of employee	{ExposureStats}
last_login	datetime	Time and date of last login by employee	2024-04-27T08:28:15Z
created_at	datetime	Time and date of this employee was created	2024-04-26T00:00:00Z

---

ExposureStats

Field	Data Type	Description	Example
total	integer	The total number of tracked exposures for this employee	15
pending	integer	The number of Pending state exposures for this employee	4
in_progress	integer	The total number of In Progress state exposures for this employee	3
closed	integer	The number of Closed state exposures for this employee	5
not_found	integer	The number of Not Found state exposures for this employee	2

Aka

Field	Data Type	Description	Example
first_name	string	First name of the alternate name	John
middle_name	string	Middle name of the alternate name
last_name	string	Last name of the altername name

---

Phone

Field	Data Type	Description	Example
id	integer	Internal ID of phone number	54345
primary	boolean	Whether this is their primary or current phone number	true
country_code	unsigned integer	The numeric ID of the country code (without +)	1
phone_number	unsigned integer	The phone number without country code and without formatting (usually 10 digits)	2385551629
phone_full	string	Full representation of the phone number with country code	+12385551629

---

Create Phone

Field	Data Type	Description	Example
country_code	unsigned integer	The numeric ID of the country code (without +)	1
phone_number	unsigned integer	The phone number without country code and without formatting (usually 10 digits)	2385551629
primary	boolean	Whether this is their primary or current phone number	true

---

Address

Field	Data Type	Description	Example
id	integer	Internal ID of address	5326
line_1	string	The first line of the address	123 Elm St
line_2	string	The second line of the address	Suite 500
city	string	The city of the address	Atlanta
region	string	The region (or state) of the address	GA
postal_code	string	The postal code (or zip code) of the address	30354
country_code	string	The country name of the address (2 characters)	US
primary	boolean	Whether this address is their primary or current residence	true

---

Create Address

Field	Data Type	Description	Example
primary	boolean	Is this their primary address	true
line_1	string	The first line of the address	123 Elm St
line_2	string	The second line of the address	Suite 500
city	string	The city of the address	Atlanta
region	string	The region (or state) of the address	GA
postal_code	string	The postal code (or zip code) of the address	30354
country	string	The country name of the address	US

---

Email

Field	Data Type	Description	Example
id	integer	Internal ID of address	4325
primary	boolean	Whether this is their primary email address or not	true
email	string	The email	john@doe.com

---

Exposure

Field	Data Type	Description	Example
id	unsigned integer	The internal ID of the exposure	b1f16974-d924-4aa5-ba0e-21391d92db6a
employee	integer	ID of the employee of this exposure	32412
company	Company	The company where the exposure was discovered	Company object
status	enum	The status type of the exposure [pending, in_progress, closed]	in_progress
last_scan	date	The date the last automated scan ran looking for this user within this company. The value can be null if the company is unscannable	2024-05-16T18:05:21Z
last_seen	date	The date of the last time we confirmed the presence of this information exposure. The value can be null if information was not directly observed.	2024-05-16T18:05:21Z
last_delete	date	The date of the last action taken on this exposure, usually submitting a deletion request. The value can be null if no action has been taken yet.	2024-05-16T18:05:21Z
data_found	boolean	Whether the data of the person is currently found/exposed.	true
data	?json	If data was found, this will be a JSON object string of the different data points that were found from the employee as well as a url to view the data if one was available. Possible keys include first_name (string), middle_name (string), last_name (string), aka (string[]), date_of_birth (Y-m-d), age (number), addresses (addresses[]), emails (string[]), phones (string[]), relatives (relative[] which potentially has first, middle, last name and age), url (string) where you can view the exposure on the companies website if available

---

IndividualLicense

Field	Data Type	Description	Example
type	string	The type of license	complete
price	unsigned integer	The price of the license in cents For example, USD $19 is represented as 1900	19700
start_date	datetime	The date when the license was purchased	2024-04-26T00:00:00Z
end_date	datetime	The date when the license will expire, if renew is true it will be renewed on this date	2025-04-26T00:00:00Z
renew	boolean	Whether this license will be renewed at the end_date	true
prorate_on_renewal	date	The date when the ContactPhoneNumber object was originally created	2023-01-15

---

PurchaseLicense

Field	Data Type	Description	Example
id	string	The type of license	complete
quantity	unsigned integer	The number of license to purchase	5

---

CompanyLicense

Field	Data Type	Description	Example
name	string	The human-readable name of the license	Scan & Delete
id	string	The id for API control of this license	scan_delete
price	unsigned integer	The annual cost of this license, in cents. For example: USD $19 is represented as 1900	1900
currency	string	The abbreviated currency type	USD
num_active	unsigned integer	The number of licenses of this type have been purchased and are currently available for use	1580
num_assigned	unsigned integer	The number of licenses of this type are currently assigned and actively in use	1550
num_available	unsigned integer	The number of licenses of this type are purchased and active but haven’t been assigned yet	30
full_scan	boolean	Whether this license is scanning all sources possible to scan (vs a restricted subset)	false
full_delete	boolean	Whether this license is deleting from everywhere possible that’s scanned	false
sites	array	If full_scan/full_delete is false, this will include a list of the sites available to this license and whether they allow scan and/or delete.	[ ]

---

Company

Field	Data Type	Description	Example
id	unsigned integer	The ID of the company	121579
name	string	The human-readable name of the company	Acme Data
status	string	If the company is enabled in our system or not	enabled
url	string	The homepage URL of the company	https://www.acmedata.com
logo	string	URL to the logo of the company	https://example.com/logo.png
slug	string	URL to the slug identifier of the company
scanner	boolean	Whether our scanner is currently active for the site or not	true

---

Role

Field	Data Type	Description	Example
name	string	Name of the role which is used to assigned users	HR Manager
permissions	Array<string>	List of permissions assigned to this role	["write financial","read financial"]

---

Webhook

Field	Data Type	Description	Example
id	integer	Unique ID	12345
endpoint	string	URL endpoint this webhook will speak to	https://webhook.privacybee.com
event	string	options: scan:started, scan:completed,scan:not_found,scan:found,request:created,request:closed	scan:completed
active	boolean	Whether the webhook is active or not	true
secret	string	SHA256 signing secret that will be included in outgoing webhooks “Signature” header	vfqv0rmtuWWPBdXNPLQrQX3aDqN38WSU
created_at	datetime	The date the webhook was created	2024-05-16T18:05:21Z
updated_at	datetime	The date the webhook was last updated	2024-05-16T18:05:21Z

---

Webhook History

Field	Data Type	Description	Example
id	integer	Unique ID	1e65f9157-55db-4fa7-a8ed-328299fc49cc
event	string	options: scan:started, scan:completed,scan:not_found,scan:found,request:created,request:closed	scan:completed
payload	Object	The data that was sent to the webhook	{}
status	string	Status of the webhook	success,pending,dispatched,failed
result	string	When a failure occurs this explains what happened	error message
created_at	datetime	The date the webhook was sent	2024-05-16T18:05:21Z

---

ExposureHistory

Field	Data Type	Description	Example
event	string	Description of what action was taken	This request has been closed.
when	datetime	The date this event occurred	2024-05-16T18:05:21Z

---

ScanEvent

Field	Data Type	Description	Example
company_id	integer	ID of the company	53221
person_id	integer	ID of the person	20543
when	datetime	The date the event occurred	2024-05-16T18:05:21Z

---

ScanResult

Field	Data Type	Description	Example
name	string	Full name of person	Eduard Gabriel Bettley
first_name	string	First name	Eduard
middle_name	string	Middle name	Gabriel
last_name	string	Last name	Bettley
aka	array<string>	List of alternative names	["Duard", "Gab"]
age	number	Age as an integer	32
addresses	array<Address>	List of associated addresses	["123 ABC, Apartment 14, Alpharetta,GA,30005,US", "123 Peachtree St, Apartment 132, Atlanta, GA,30303,US" ]
relatives	array<Relative>	List of family members	["Bethy Bettley", "John Doe", "Ann Smith" ]
phones	array<number>	List of phone numbers	["+12385551629", "+12384152637" "+12374151432" ]
emails	array<string>	List of emails	["eduard.bettley@privacybee.com", "egb@privacybeeharry.com"]
date_of_birth	datetime	Date of birth (YYYY-MM-DD)	1975-11-24