v1

latestOpenAPI 3.1.02026-07-261520561.4 KB
Person Application

Create a Person Application

post/apply/person_application

Request body

bankdataobject

Optional arbitrary data the bank can attach to the object

citizenshipstring

Two letter ISO country code indicating where this person has citizenship

date_of_birthstring

Date of birth of the person, ISO 8601 format ('YYYY-MM-DD')

document_idsstring[]

Array of Document IDs pertaining to this person

email_addressstring required

Email address of the person

first_namestring required

First (given) name of the person (max of 36 ASCII characters)

gov_idstring
identification_numberstring

International identification number (max of 30 characters)

identification_number_typestring

Type of international identification number (max of 30 characters)

last_namestring required

Last name (surname) of the person (max of 40 ASCII characters)

middle_namestring

Middle name or initial of the person, if they have one

occupationstring

Occupation of the person

phone_numberstring

Phone number of the person

secondary_email_addressstring

Optional secondary email address of the person

tinstring

U.S. Social Security or IRS tax ID number of the person

userdataobject

Optional arbitrary data the user can attach to the object

Response

The apply.person-application created

bankdataobject

Optional arbitrary data the bank can attach to the object

citizenshipstring

Two letter ISO country code indicating where this person has citizenship

date_of_birthstring

Date of birth of the person, ISO 8601 format ('YYYY-MM-DD')

document_idsstring[]

Array of Document IDs pertaining to this person

email_addressstring

Email address of the person

first_namestring

First (given) name of the person (max of 36 ASCII characters)

gov_idstring
idstring

Unique identifier for object

identification_numberstring

International identification number (max of 30 characters)

identification_number_typestring

Type of international identification number (max of 30 characters)

last_namestring

Last name (surname) of the person (max of 40 ASCII characters)

middle_namestring

Middle name or initial of the person, if they have one

occupationstring

Occupation of the person

person_idstring

ID of the person object created as a result of a successful account application. Filterable.

phone_numberstring

Phone number of the person

secondary_email_addressstring

Optional secondary email address of the person

tinstring

U.S. Social Security or IRS tax ID number of the person

userdataobject

Optional arbitrary data the user can attach to the object