Create a Person

post https://api-sandbox.trice.co/hub/v1/persons

Creates a person associated with an account. The underwriter capability is required by the caller to use POST.

Body Params

Persons body

address

object

required

The individual primary address.

dob

object

The individual date of birth.

string

length ≤ 100

Email address (RFC 822 characters).

first_name

string

required

length ≤ 50

First name.

full_name_aliases

array of strings

A list of alternate names or aliases that the individual is known by.

full_name_aliases

gender

string

length ≤ 50

The individual gender (International regulations require either 'male' or 'female').

last_name

string

required

length ≤ 50

Last name.

maiden_name

string

length ≤ 50

Maiden name.

nationality

string

length ≤ 50

The country where the person is a national.

phone

object

The individual phone number.

political_exposure

string

Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction. Values can be none (The person has disclosed that they have no political exposure) or existing (The person has disclosed that they do have political exposure).

registered_address

object

The individual registered address.

relationship

object

Describes the individual relationship to the account.

ssn

string

The person Social Security number.

verification

object

Information on the verification state of the individual.

verified

boolean

DEPRECATED true or false and can only be set with the underwriter capability. WARNING, IF THIS IS NOT EXPLICITELY SET, THE SYSTEM WILL NULL THE verified FIELD WITH ANY POST OR PUT OPERATION

verified_for

array of strings

List of bank verifications for the individual. The set can include transpecos_banks, local_bank. WARNING, IF THIS IS NOT EXPLICITELY SET, THE SYSTEM WILL NULL THE verified_for FIELD WITH ANY POST OR PUT OPERATION

verified_for

Headers

X-TRICE-ACCOUNT

uuid

required

A parent account can include this header as reference to the descendent account being operated on.

Responses

Response body

object

address

object

The individual primary address.

city

string | null

The city of the address.

country

string | null

The country of the address. ISO 3166, Alpha-2 or Alpha-3 code (US, USA, CA, etc.). If long name is given, verification of the name will be attempted.

line1

string

length ≤ 100

Line 1 of address.

line2

string | null

Line 2 of address.

state

string | null

The state or province of the address. Typically abbreviated (CA, NV,TX, etc.).

zip

string

length ≤ 50

The zip code of the address.

created

string

Formatted timestamp (YYYY-MM-DD HH:MM:SS) determining when the individual was created.

dob

object | null

The individual date of birth.

day

int64

≥ 0

The day of the month, between 1 and 31.

month

int64

≥ 0

The month, between 1 and 12.

year

int64

≥ 0

The four-digit year.

string | null

Email address (RFC 822 characters).

first_name

string

length ≤ 50

First name.

full_name_aliases

array of strings | null

A list of alternate names or aliases that the individual is known by.

full_name_aliases

gender

string | null

The individual gender (International regulations require either 'male' or 'female').

hold_details

object | null

If present, the person is unable to participate in transactions.

message

string | null

More details about the hold.

reason

string | null

The reason for the hold.

timestamp

string

Formatted timestamp (YYYY-MM-DD HH:MM:SS) determining when the hold was placed.

uuid

Unique individual id (RFC-4122 UUID).

id_number_provided

boolean

Whether the individual personal ID number was provided.

id_number_secondary_provided

boolean

Whether the individual personal secondary ID number was provided.

last_name

string

length ≤ 50

Last name.

maiden_name

string | null

Maiden name.

nationality

string | null

The country where the person is a national.

phone

object | null

The individual phone number.

country_code

string | null

Country code without the plus (+), for example, for the United States, it would be 1.

number

string

10 digit phone number without the country code and without the delimiters (-,.,etc.). For example, 865-604-6546 would be 8656046546.

political_exposure

string | null

none existing

registered_address

object | null

The individual registered address.

city

string | null

The city of the address.

country

string | null

The country of the address. ISO 3166, Alpha-2 or Alpha-3 code (US, USA, CA, etc.). If long name is given, verification of the name will be attempted.

line1

string

length ≤ 100

Line 1 of address.

line2

string | null

Line 2 of address.

state

string | null

The state or province of the address. Typically abbreviated (CA, NV,TX, etc.).

zip

string

length ≤ 50

The zip code of the address.

relationship

object | null

Describes the individual relationship to the account.

director

boolean

Whether the person is a director of the account legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.

executive

boolean

Whether the person has significant responsibility to control, manage, or direct the organization.

owner

boolean

Whether the person is an owner of the accounts legal entity.

percent_ownership

number

The percent owned by the person of the accounts legal entity.

representative

boolean

Whether the person is authorized as the primary representative of the account. This is the person nominated by the business to provide information about themselves, and general information about the account. There can only be one representative at any given time. At the time the account is created, this person should be set to the person responsible for opening the account.

title

string

The person title (e.g., CEO, Support Engineer).

ssn_provided

boolean

Whether the person Social Security number has been provided.

status

string

Current status of the person: ok, on_hold. An account is ok if it has passed trice compliance checks. Some on_hold accounts may initially show as ok but then change to on_hold.

ok on_hold

updated

string | null

Formatted timestamp (YYYY-MM-DD HH:MM:SS) determining when the individual was last updated.

verification

object | null

Information on the verification state of the individual.

additional_document

object | null

A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.

document

object | null

An identifying document for the person, either a passport or local ID card.

status

string

The state of verification for the person. Possible values are unverified, pending, or verified.

unverified pending verified

verified

string | null

Formated timestamp (YYYY-MM-DD HH:MM:SS) determining when the person was last verified.

verified_for

array of objects or null

List of bank verifications for the individual.

verified_for

object | null

bank_id

string

This represents the bank id that has been verified. Values can be transpecos_banks for TransPecos Banks, local_bank for Local Bank (sandbox)

bank_name

string

This represents the bank name that has been verified.

verified

string

Formatted timestamp (YYYY-MM-DD HH:MM:SS) determining when verification happened.

Language

Credentials

Bearer

JWT


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api-sandbox.trice.co/hub/v1/persons \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201New persons response OK

400Bad request

401Unauthorized

404Not found

502Bad gateway

defaultError