Update a party

put https://api-sandbox.trice.co/hub/v1/parties/{id}

Updates a party

Path Params

uuid

required

Unique party id (RFC-4122 UUID).

Body Params

Parties body

address

object | null

The physical address of the person or business that owns the bank account.

bank_details

object | null

The account details for the bank account.

can_receive

boolean

If set to true the party can receive funds, if false funds will be rejected.

dob

object | null

If the party is an individual, this is the individual date of birth.

domestic

boolean | null

If set to true the party is domiciled in the united states, if false the party is domiciled outside the united states.

string | null

The email of the person or business that owns the bank account.

name

string | null

The name of the person or business that owns the bank account.

phone

object | null

The phone number of the person or business that owns the bank account.

tax_id

string | null

If the party is a business, this is the business EIN.

type

string | null

The type of entity that holds the account. This can be either individual or business.

verified

boolean | null

DEPRECATED true or false and can only be set with the underwriter or party_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 | null

List of bank verifications for the party. 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

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

Responses

Response body

object

account_number

string | null

ABA compliant account number for receiving credit transfers. Only present if can_receive is true.

address

object | null

The physical address of the person or business that owns the bank account.

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.

bank_details

object | null

The account holder bank details.

account_holder_name

string | null

The name of the person or business that owns the bank account.

account_holder_type

string | null

The type of entity that holds the account. This can be either individual or business.

individual business

account_number_last4

string

The last four digits of the bank account number.

account_type

string | null

The bank account type. This can only be checking or savings.

checking savings

bank_name

string | null

Name of the bank associated with the routing number (e.g., WELLS FARGO).

routing_number

string

The routing transit number for the bank account.

can_receive

boolean

If set to true the party can receive funds, if false funds will be rejected.

created

string

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

dob

object | null

If the party is an individual, this is 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.

domestic

boolean | null

If set to true the party is domiciled in the united states, if false the party is domiciled outside the united states.

string | null

The email of the person or business that owns the bank account.

hold_details

object | null

If present, the party 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 party id (RFC-4122 UUID).

name

string | null

The name of the person or business that owns the bank account.

phone

object | null

The phone number of the person or business that owns the bank account.

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.

status

string

Current status of the party: ok, on_hold. A party is ok if it has passed trice compliance checks. Some on_hold parties may initially show as ok but then change to on_hold.

ok on_hold

tax_id_provided

boolean

Whether the business ID number was provided.

type

string | null

The type of entity that holds the account. This can be either individual or business.

individual business

updated

string | null

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

verified

string | null

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

verified_for

array of objects or null

List of bank verifications for the party.

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 PUT \
2
     --url https://api-sandbox.trice.co/hub/v1/parties/id \
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

201Update party response OK

400Bad request

401Unauthorized

404Not found

502Bad gateway

defaultError