This guide uses the following endpointsDocumentation Index
Fetch the complete documentation index at: https://docs.treasuryprime.com/llms.txt
Use this file to discover all available pages before exploring further.
/apply/person_application/apply/business_application/apply/deposit/apply/account_application/account/account_product/person/business
To apply to open a new bank account
- Create a Person Application
- Create a Business Application (if applying for a business account)
- Create a Deposit (optional)
- Select an Account Product
- Create an Account Application
Additional steps
- Check the status of an account application
- Retrieve information about an account
- List accounts by status
- Retrieve information about account owners
- Testing account applications
The resource hierarchy for account applications is as follows
Personal Accounts
Business Accounts
1. Create a Person Application
The first step in applying to open a new bank account is to create a Person Application for the person(s) associated with the application for the bank account. For business accounts, you will need to create a Person Application for each of the people who will be able to access the account, as well as any persons who have at least 25% ownership in the company (beneficial owners). To create a Person Application, make aPOST request to the person_application endpoint, passing a Person Application object containing the personal information of the individual who will be tied to the account.
The
date_of_birth field is validated against a minimum age requirement. This minimum age is configurable per organization through the apply_account_min_age setting. Contact Treasury Prime support if you need to adjust this requirement.Example Request to Create a Person Application
Example Response
This will return a Person Application object containing anid property referencing this application. Note the id value as it will be used in subsequent steps.
2. Create a Business Application
If applying for a personal bank account, you can move ahead to Create a Deposit (optional) or Create an Account Application To create a Business Application, make aPOST request to the business_application endpoint, passing in a Person Applications object for each person who will be associated with the account as part of the person_applications array.
Note the id property should contain the id of the Person Application for this person.
Valid roles for business person applications are signer, control_person, and debit_card_holder. Only one person can be assigned the control_person role per business application.
The format for the Person sub-object is as follows:
Example Request to Create a Business Application
Example Response
3. Create a Deposit
If you wish to initially fund the new account using an ACH pull or debit card, make aPOST request to the deposit endpoint passing a Deposit object containing information about the account the funds will be drawn from.
Example Request to Create a Deposit Via ACH Pull
Example Response
4. Select an Account Product
Use the/account_product endpoint to choose an appropriate Account Product
Example Request
Example Response
This will return a list of Account Product objects, each containing anid property. Select one and note its id value.
5. Create an Account Application
The final step in applying to open a new bank account is submitting the Account Application. This application will list the type of account being applied for, the person(s) who will have access to the account, and their roles as they pertain to the account. If successfully created, the Account Application will initially be in statussubmitted, then moving to status kyc (while identity verification is in progress), and then to processing. Depending on the results of the KYC (Know Your Customer) process, the Account Application will move to status approved, rejected, or manual_review. An application can also be set to canceled if it is withdrawn before approval.
Once an Account Application passes KYC, then an account is created and the account_id field is populated. The account is not fully setup until the status of the account is “approved”, signifying that the account setup process is complete.
Personal Account Application
To create a personal Account Application, make aPOST request to the account_application endpoint, passing an Account Application object containing information about the associated Person Application(s), the ID of the primary Person Application, and the ID of the Account Product being applied for.
Valid roles for personal account person applications are owner, signer, minor, authorized_user, and debit_card_holder. The minor role indicates a person who is a beneficiary but not of legal age to be a signer.
You can optionally include a nickname field on the Account Application to assign a user-facing label to the account (for example, “Savings for vacation”). This nickname is for the user’s reference only and does not affect account functionality.
Note: See the section Account application with initial deposit for an example of including a deposit with the Account Application.
Example Request to Create a Personal Account Application
Example Response for Personal Account Application
Joint Personal Account Application
To create a joint personal account application, make aPOST request to the account_application endpoint, passing an Account Application object containing two person application records for person_applications assigning both with owner and signer roles and ID of the Account Product being applied for. Set one of the two person application IDs as the primary Person Application.
Example Request to Create a Joint Personal Account Application
Example Response for Joint Personal Account Application
Business Account Application
To create a business Account Application, make aPOST request to the account_application endpoint, passing an Account Application object containing the ID of the Business Application, the ID of the primary Person Application, and the ID of the Account Product being applied for.
Note: See the section Account application with initial deposit for an example of including a deposit with the Account Application.
Example Request to Create a Business Account Application
Example Response for Business Account Application
Account Application with Initial Deposit
If funding the account with an initial deposit, add adeposit_id property to the Account Application object listing the ID of the Deposit. This works the same for both personal and business account applications.
See the section Create a Deposit for information on creating a Deposit.
Example Request to Create a Business Account Application with Initial Deposit
Example response, with initial deposit
Check the Status of an Account Application
Once the Account Application has been submitted, you can retrieve the latest status of the application using theid of the Account Application. To do this, make a GET request to the account_application/:id endpoint.
Example Request
Example Response
Retrieve Information About an Account
Once an Account Application is complete and status is approved, you can access the account using theaccount_id (found in the response from the account_application/:id endpoint outlined in the previous section). To do this, make a GET request to the account/:account_id endpoint.
Example Request
Example Response
List Accounts by Status
Use theGET /account endpoint with the status query parameter to list accounts that are in a specific lifecycle state. The status filter accepts one of the following values:
open— The account is active and able to send and receive funds.close_pending— An account closure has been initiated but is not yet finalized. The account is effectively locked to outbound payments.closed— The account is fully closed and can no longer be used.
close_pending), or display only active accounts in a customer-facing dashboard.
The status field is also returned on each account in the response, so you can inspect the current lifecycle state without making an additional request per account.
Example Request
Example Response
status filter can be combined with other filters, such as account_type or tags, to further refine results. See Filtering for details on combining query parameters.
Retrieve Information About Account Owners
Theperson_ids and business_ids properties in an Account object let you retrieve information about account owners (persons and businesses respectively).
Note that Person and Business objects are separate from the Person Application and Business Application objects. Information about persons and businesses are expected to change (such as changing a name or address) and reflect current data, while Person Application and Business Application objects are static and are a snapshot of these entities at the time that they applied for an account.
Retrieve Person Information
To retrieve information about a person related to an account, make aGET request to the person/:id endpoint passing the person_id which is found in the Account object.
Example Person Request
Example Person Response
Retrieve Business Information
To retrieve information about the business related to an account, make aGET request to the business/:id endpoint passing the business_id found in the Account object.
Example Business Request
Example Business Response
Testing Account Applications
When testing your integration, it may be useful to coerce an Account Application into a particular status (for example, forcing the status to show “approved”). This can be accomplished by adjusting specific values as outlined below.More information on testing can be found here.
Personal Account Applications
To manually trigger a status for a personal account application, the first digit of thetin property of each Person Application object submitted with the application must be set to one of the following values before submitting the Account Application. Note that all of the tin properties must be set to the same value. An x indicates any digit.
| Status | Test TIN |
|---|---|
| Approved | 1xx-xx-xxxx |
| Manual Review | 2xx-xx-xxxx |
| Processing | 3xx-xx-xxxx |
| Rejected | 4xx-xx-xxxx |
| Submitted | 5xx-xx-xxxx |
Business Account Applications
To manually trigger a status for a business account application, the first digit of thetin property of each Person Application object and the tin property of the Business Application object submitted with the application must be set to one of the following values before submitting the Account Application. Note that all of the tin properties must be set to the same value. An x indicates any digit.
| Status | Test TIN |
|---|---|
| Approved | 1x-xxxxxxx |
| Manual Review | 2x-xxxxxxx |
| Processing | 3x-xxxxxxx |
| Rejected | 4x-xxxxxxx |
| Submitted | 5x-xxxxxxx |