Retrieve an Account

get https://api-sandbox.trice.co/hub/v1/accounts/{id}

Obtain child account details. The aggregator capability is required by the account to use GET

Responses

Response body

object

account_number

string

ABA compliant account number for receiving credit transfers.

business

object | null

Information about the company or business. This field is available for any business_type.

address

object

The business primary address.

business_dba

string | null

The business DBA name.

business_name

string

length ≤ 100

The business legal name.

formation_state

string | null

The state the business was formed in. Typically abbreviated (CA, NV,TX, etc.).

phone

object

The business phone number (used for verification).

tax_id_provided

boolean

Whether the business ID number was provided.

business_profile

object | null

Business information about the account.

estimated_monthly_volumes_provided

boolean

Whether the company provided estimates for monthly usage.

naics

string

length ≤ 50

The IRS industry code for the business. NAICSs are used to classify businesses based on the goods or services they provide.

name

string

length ≤ 100

The customer-facing business name.

product_description

string | null

Internal-only description of the product sold or service provided by the business. Its used by Trice for risk and underwriting purposes.

url

string

length ≤ 200

The business publicly available website.

business_type

string | null

The business type. Possible values: company, non_profit, government_entity, individual

company non_profit government_entity individual

capabilities

object

A hash containing the set of capabilities that was requested for this account and their associated states. Keys are names of capabilities. Values may be active, inactive, or pending.

aggregator

string

The aggregator capability (ability to represent your customers). This represents the status of the capability. Values can be active, inactive, or pending

active inactive pending

intermediary_rtp_v_2_9

string

DEPRECATED SEE enrollments ENDPOINT The intermediary capability (ability to use ultimate debtor and creditor for your customers as parties). V 2.9 makes sending the ultimate debtor and creditor fields backward compatible to RTP v2.9 and replaces the creditor or debtor with these fields. Mutually exclusive with intermediary_rtp_v_3_0. This represents the status of the capability. Values can be active, inactive, or pending

active inactive pending

intermediary_rtp_v_3_0

string

DEPRECATED SEE enrollments ENDPOINT The intermediary capability (ability to use ultimate debtor and creditor for your customers as parties). Mutually exclusive with intermediary_rtp_v_2_9. This represents the status of the capability. Values can be active, inactive, or pending

active inactive pending

party_underwriter

string

DEPRECATED SEE bank_capabilities ENDPOINT The party_underwriter capability (ability to verify your own parties). This represents the status of the capability. Values can be active, inactive, or pending

active inactive pending

rfp_rtp_v_2_9

string

DEPRECATED SEE enrollments ENDPOINT The rfp_rtp_3_0 capability (ability to use ultimate debtor and creditor for your customers as parties). V 2.9 makes sending the ultimate debtor and creditor fields backward compatible to RTP v2.9 and replaces the creditor or debtor with these fields. Mutually exclusive with rfp_rtp_v_2_9, intermediary_rtp_v_2_9, intermediary_rtp_v_3_0. This represents the status of the capability.

active inactive pending

rfp_rtp_v_3_0

string

DEPRECATED SEE enrollments ENDPOINT The rfp_rtp_2_9 capability (ability to use ultimate debtor and creditor for your customers as parties). Mutually exclusive with intermediary_rtp_v_2_9. Mutually exclusive with rfp_rtp_v_2_9, intermediary_rtp_v_2_9, intermediary_rtp_v_3_0. This represents the status of the capability.

active inactive pending

rtp_rfps

string

DEPRECATED SEE enrollments ENDPOINT The RTP request for payment capability. This represents the status of the capability. Values can be active, inactive, or pending

active inactive pending

rtp_transfers

string

DEPRECATED SEE enrollments ENDPOINT The RTP transfer capability. This represents the status of the capability. Values can be active, inactive, or pending

active inactive pending

transaction_monitor_parent

string

DEPRECATED SEE enrollments ENDPOINT The transaction_monitor_parent capability passes all transaction monitoring of descendants transactions to the parent. This represents the status of the capability. Values can be active, inactive, or pending

active inactive pending

underwriter

string

DEPRECATED SEE bank_capabilities ENDPOINT The underwriter capability (ability to underwrite your own customers). This represents the status of the capability. Values can be active, inactive, or pending

active inactive pending

created

string

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

string

length ≤ 100

Email address (RFC 822 characters).

enrollments

array of objects

DEPRECATED List of bank account enrollments for the account.

enrollments

object

bank_id

string

The bank id of bank associated with the routing number.

bank_name

string

Name of bank associated with the routing number.

capabilities

object

A hash containing the set of capabilities that were requested for this account and their associated states. Keys are names of capabilities. Values may be active, inactive, or pending.

created

string

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

fednow_support

object

Federal Reserve FedNow network support.

uuid

Unique enrollment id (RFC-4122 UUID).

routing_number

string

ABA compliant routing number for the enrollment bank account.

rtp_support

object

The Clearing House RTP network support.

updated

string | null

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

hold_details

object | null

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

individual

object | null

Information about the person represented by the account. This field is null unless business_type is set to individual.

address

object | null

The individual primary address.

dob

object | null

The individual date of birth.

string | null

Email address (RFC 822 characters).

first_name

string | null

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').

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 | null

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.

political_exposure

string | null

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

none existing

registered_address

object | null

The individual registered address.

relationship

object | null

Describes the individual relationship to the account.

ssn_provided

boolean

Whether the person Social Security number has been provided.

verification

object | null

Information on the verification state of the individual.

ip_address_allow_list

array of strings

List of ip addresses that are allowed to POST to the rtp_transfers and rtp_rfps endpoints.

ip_address_allow_list

status

string

Current status of the account: 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

tos_acceptance

object | null

Details on the acceptance of the TOS.

date

string

Formatted timestamp (YYYY-MM-DD HH:MM:SS) marking when the account representative accepted their service agreement.

string

The IP address from which the account representative accepted their service agreement.

service_agreement

string

The account service agreement type.

user_agent

string

The user agent of the browser from which the account representative accepted their service agreement.

updated

string | null

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

verified

string | null

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

verified_for

array of objects or null

List of bank verifications for the account.

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 GET \
2
     --url https://api-sandbox.trice.co/hub/v1/accounts/id \
3
     --header 'accept: application/json'

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

application/json

200Get account OK

400Bad request

401Unauthorized

404Not found

502Bad gateway

defaultError