Create a person entity

Addresses need to adhere to character validation, as addresses are used across multiple payment rails. Characters are validated according to the Fedwire character validation. Required by default.

Country of citizenship of the individual. Country of citizenship does not need to match the issuing country of an identity document. ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...).

Date of birth in YYYY-MM-DD format. Required by default.

Driver's license details. At least one form of identification (ssn, passport, drivers_license, or national_id) is required. Driver's license country code must be non-U.S. When left blank, the Driver's License field returns null.

Email of the individual. Optional, but highly encouraged as it will increase likelihood of an automated verification. When left blank, the Email field returns an empty string ("").

Employment status of the individual.

Expected transaction types for the account.

First name of the legal person. Must adhere to Fedwire character validation.

Estimated pre-tax annual income. Accepts an array to allow passing income ranges.

Indicates whether the entity has been identified as high risk based on compliance screening

Whether this entity is going to be a root entity of the platform. Root entities have special requirements and validation rules.

Last name of the legal person. Must adhere to Fedwire character validation.

Indicates whether the individual expects to make international payments.

Middle name of the legal person. Must adhere to Fedwire character validation.

National ID details. At least one form of identification (ssn, passport, drivers_license, or national_id) is required. National ID country code must be non-U.S. When left blank, the National ID field returns null.

Industry of employment or occupation of the individual.

Passport details. At least one form of identification (ssn, passport, drivers_license, or national_id) is required. Passport country code must be non-U.S. When left blank, the Passport field returns an empty object and the Driver's License and National ID fields return null.

Politically Exposed Person screening status. Allowed values: not_checked, no, yes, potential.

Phone number of the individual in the E.164 format. Optional, but highly encouraged as it will increase likelihood of an automated verification. When left blank, the phone number field returns an empty string ("").

Intended use of the account.

Individual's role or job title at their place of employment.

Sources of income for the individual.

Social Security Number. ITIN may be shared in place of SSN. At least one form of identification (ssn, passport, drivers_license, or national_id) is required. If SSN is provided, country of citizenship is not required. When left blank (i.e., for non-U.S. citizens) the SSN field returns an empty string ("").