Identity Object

Identity Object attributes.

Attributes

Name	Type	Description
first_name	string	First name of identity.
last_name	string	Last name of identity.
phone_number	string	Phone number of identity.
id_number	string	The ID number of identity.
birth_date	DateTime	The birth date of identity.
company_name	string	Company name of identity.
company_reg_number	string	Company Registration number of identity.
vat_id	string	The VAT ID of identity.
description	string	The friendly description of identity.
personal_tax_id	string	The personal tax number of identity.
external_reference_id	string	Identifier in external customer’s system.
verified	boolean	Displays if Identity is verified.
contact_email	string	Contact email address of identity.
identity_type	string	One of the following: any, personal or business.

Relationships

Name	Type	Description
country	to-one	Country Object. Specifies the country for the identity.
birth_country	to-one	Country Object. Specifies the birth country for the identity. In version 2026-04-16, it is managed separately from country.
proofs	to-many	Proofs Object. Returns the proofs assigned to the identity.
addresses	to-many	Addresses Object. Returns the addresses assigned to the identity.
permanent_documents	to-many	Permanent Documents Object. Returns the permanent documents assigned to the identity.