Add bank for insured
API Refs
- Production: Add bank for insured
- Staging: Add bank for insured
URI Parameters
Name | Type | Description | Required |
---|---|---|---|
userId | number | insure id | yes |
Request body
Name | Type | Description | Required |
---|---|---|---|
routingNumber | number string | A numeric string for the bank routing number corresponding to a US bank or credit union. The first two digits must be in a range from "01" through "12", or "21" through "32", and the string value must consist of nine digits. | yes |
accountNumber | number string | A numeric string of 4-17 digits. | yes |
accountType | string | The type of bank account this is must be one of these values: checking or savings. | yes |
Response body
Name | Type | Description | Required |
---|---|---|---|
id | string | This id is used for all ACH payments. | yes |
name | string | Name of the bank. | yes |
accountType | string | Type of bank account. Can be only checking or savings. | yes |
type | string | Type of current funding source. It will always be a bank, since we can only have bank-type funding sources. | yes |
status | string | Bank status. For clients created with the API it will always be undefined as we don't use PLAID to validate as we do in the application. | yes |
Example
- Get list of insuredās banks Request with userId = 1;
- Get list of insuredās banks Response:
[ { "id": "11a111a1-1111-1111-11a1-11a1a1aa11aa", "name": "Bank_995", "accountType": "checking", "type": "bank", "status": "unverified" } ]
- Add bank for insured Request:
{ "routingNumber": "021000021", "accountNumber": "1111222233331111", "accountType": "savings" }
- Add bank for insured Response:
{ "id": "11a111a1-1111-1111-11a1-11a1a1aa11aa", "name": "Bank_995", "accountType": "checking", "type": "bank", "status": "unverified" }
Description
If the insured did not have a bank added during registration, or you need to add a second one, this endpoint can help you with this.
To add a bank, you need to pass number routing, number account and what type of account (checking or savings).
There can only be five banks at a time.
If you need to add more, delete one of the active banks. Go to Delete insuredās bank by id for more information about deleting the bank.
Updated 12 months ago