Create an Account

Creates an account by passing the required account information.
Accounts
Create an Account
 last updated: 
November 30, 2023

During the account creation, it is your responsibility to present an option for the user to accept the Terms, after which you should set acceptedTerms as true in the request body. Learn more about Account Types.

Please note:

- When creating a business account, pass the "businessId" in the request object.
- When creating a family account, pass the "familyId" in the request object.
- When creating a personal account, the "personId" is already included in the header.

ENDPOINT

  1. POST /v1/account

REQUEST

  1. {
  2.     "businessId": "{{businessId}}",
  3.     "label": "Primary",
  4.     "acceptedTerms": true,
  5.     "type": "businessChecking"
  6. }

RESPONSE

  1. {
  2.   "id": "acc-cdc4ca0a-2f1b-4c0b-9964-2339268c2d7b",
  3.   "familyId": "fam-d8b5d10e-9bc0-4c5d-9ecd-3ef95bf8f2fa”,
  4.   "businessId": "",
  5.   "label": "Doe Money",
  6.   "routingNumber": "084106768",
  7.   "accountNumber": "9991238158805732",
  8.   "status": "active",
  9.   "type": "personalChecking",
  10.   "programId": "prg-ddb08641-6565-465d-ba94-ed199497299f",
  11.   "isVerified": false,
  12.   "verifiedAt": "",
  13.   "acceptedTerms": true,
  14.   "interest": "0.00",
  15.   "fees": "0.00",
  16.   "currency": "USD",
  17.   "availableBalance": "170.00",
  18.   "sponsorBankName": "Test Bank",
  19.   "createdAt": "2022-06-21T14:23:48Z",
  20.   "modifiedAt": "2022-08-03T17:59:56Z",
  21.   "pendingDebit": "0.00",
  22.   "pendingCredit": "0.00",
  23.   "createdPersonId": "per-c1df28cb-a889-41ea-9ab3-6b33c8985c0f",
  24.   "accountInterestFrequency": "monthly",
  25.   "metadata": null,
  26.   "config": {
  27.     "card": {
  28.       "virtual": {
  29.         "enabled": true,
  30.         "count": "25"
  31.       },
  32.       "physical": {
  33.         "enabled": true,
  34.         "count": "5"
  35.       }
  36.     },
  37.     "send": {
  38.       "intrabank": {
  39.         "enabled": true
  40.       },
  41.       "ach": {
  42.         "enabled": true,
  43.         "sameDay": true
  44.       },
  45.       "wire": {
  46.         "enabled": true
  47.       },
  48.       "check": {
  49.         "enabled": true
  50.       },
  51.       "card": {
  52.         "enabled": true
  53.       },
  54.       "debitCard": {
  55.         "enabled": true
  56.       },
  57.       "internationalWire": {
  58.         "enabled": true
  59.       },
  60.       "digitalCheck": {
  61.         "enabled": false
  62.       },
  63.       "physicalCard": {
  64.         "enabled": false
  65.       }
  66.     },
  67.     "receive": {
  68.       "intrabank": {
  69.         "enabled": true
  70.       },
  71.       "ach": {
  72.         "enabled": true,
  73.         "sameDay": true
  74.       },
  75.       "check": {
  76.         "enabled": true
  77.       },
  78.       "debitCard": {
  79.         "enabled": true
  80.       }
  81.     },
  82.     "limits": {
  83.       "receive": {
  84.         "daily": "1000.00",
  85.         "monthly": "10000.00",
  86.         "intrabank": {
  87.           "daily": "0.00",
  88.           "monthly": "0.00"
  89.         },
  90.         "ach": {
  91.           "daily": "0.00",
  92.           "monthly": "0.00"
  93.         },
  94.         "check": {
  95.           "daily": "0.00",
  96.           "monthly": "0.00"
  97.         },
  98.         "debitCard": {
  99.           "daily": "0.00",
  100.           "monthly": "0.00"
  101.         }
  102.       },
  103.       "send": {
  104.         "daily": "1000.00",
  105.         "monthly": "10000.00",
  106.         "intrabank": {
  107.           "daily": "0.00",
  108.           "monthly": "0.00"
  109.         },
  110.         "ach": {
  111.           "daily": "0.00",
  112.           "monthly": "0.00"
  113.         },
  114.         "domesticWire": {
  115.           "daily": "0.00",
  116.           "monthly": "0.00"
  117.         },
  118.         "internationalWire": {
  119.           "daily": "0.00",
  120.           "monthly": "0.00"
  121.         },
  122.         "check": {
  123.           "daily": "0.00",
  124.           "monthly": "0.00"
  125.         },
  126.         "card": {
  127.           "daily": "0.00",
  128.           "monthly": "0.00"
  129.         },
  130.         "debitCard": {
  131.           "daily": "0.00",
  132.           "monthly": "0.00"
  133.         }
  134.       }
  135.     },
  136.     "fallback": {
  137.       "originated": null,
  138.       "received": null
  139.     },
  140.     "incoming": {
  141.       "achPull": {
  142.         "enabled": true,
  143.         "allowedOriginators": [],
  144.         "blockedOriginators": []
  145.       }
  146.     }
  147.   }
  148. }