Person entity object

An entity represents a person or organization possessing separate and distinct legal rights. You will create entities for each of your customers or users. An entity is required to create a bank account or a loan object. Read about entities in our data model for more information.

Object Parameters

documents

array of objects

List of documents which are uploaded with the Submit Document API

created_at

date-time

Timestamp at which the document was created.

description

string

Description of the uploaded document.

document_id

string

Unique identifier of the document.

entity_id

string

Unique identifier of the entity the document belongs to.

id

string

Unique identifier for the object

is_root

boolean

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

last_screened_at

date-time

The timestamp at which the entity was last screened for compliance.

name

string

Display name of the entity, derived from person or business details.

person_details

object

Person details for person entities. Present on single-entity responses, omitted in list responses.

address

object

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

city

string

City name

country_code

string

Two-letter ISO 3166-1 alpha-2 country code (e.g. US)

line_1

string

Street address line 1

line_2

string

Street address line 2

postal_code

string

Postal or ZIP code

state

string

State or province

country_of_citizenship

string

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

string

Date of birth (YYYY-MM-DD)

drivers_license

object

Driver's License Details. Passport, Driver's License or National ID is required for non U.S. citizens. When left blank, the Passport field returns an empty object ( ) and the Driver's License and National ID fields return null.

country_code

string

Two-letter ISO 3166-1 alpha-2 country code of the issuing country

number

string

Driver's license number

email

string

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

string

Employment status of the individual.

expected_payment_rails

string

Expected transaction types for the account.

first_name

string

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

income

array of numbers

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

is_beneficial_owner

boolean

Boolean value which specifies if this person is a designated beneficial owner.

is_control_person

boolean

Boolean value which specifies if this person is a designated control person.

is_high_risk

boolean

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

job_title

string

Job title of the beneficial owner or control person.

last_name

string

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

makes_international_payments

boolean

Indicates whether the individual expects to make international payments.

middle_name

string

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

national_id

object

National ID Details. Passport, Driver's License or National ID is required for non U.S. citizens. When left blank, the Passport field returns an empty object ( ) and the Driver's License and National ID fields return null.

country_code

string

Two-letter ISO 3166-1 alpha-2 country code of the issuing country

number

string

National ID number

occupation

string

Industry of employment or occupation of the individual.

ownership_percentage

integer

Percentage ownership, specified as an integer, of the beneficial owner

passport

object

Passport Details. Passport, Driver's License or National ID is required for non U.S. citizens. When left blank, the Passport field returns an empty object ( ) and the Driver's License and National ID fields return null.

country_code

string

Two-letter ISO 3166-1 alpha-2 country code of the issuing country

number

string

Passport number

pep_status

string

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

phone_number

string

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 ("").

purpose_of_account

array of strings

Intended use of the account.

role

string

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

source_of_income

array of strings

Sources of income for the individual.

ssn

string

Social Security Number. SSN is required for U.S. citizens. ITIN may be shared in place of SSN. 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 ("").

requires_screening

boolean

Whether the entity requires additional screening before it can be verified.

review_reasons

array of strings

List of reasons the entity is in Manual_Review.

search_metadata

object

Search-specific metadata returned when a query is provided.

highlights

object

Matched field fragments with highlighted terms

score

number

OpenSearch relevance score

type

string

Type of entity. PERSON for a person entity. BUSINESS for a business entity.

verification_status

string

Current status of the entity verification. Can be UNVERIFIED, PENDING, MANUAL_REVIEW, VERIFIED, or DENIED.