new-account-setup

New Account Setup

Step-by-step workflow for creating a synthetic account for a customer.

Step 1 — Identify the Customer

If you don't already have the customer UID:

list-customers  (filter by name, email, or external_uid as needed)
get-customer  uid=<customer_uid>

Note the customer's:

• uid — needed when associating the account
• pool_uids — the pools this customer already belongs to
• kyc_status — account creation may fail if KYC is not approved
• status — customer must be active

Step 2 — Select an Account Type

List all available synthetic account types for the program:

get-synthetic-account-types

Each type has:

• uid — the synthetic_account_type_uid required at creation
• name and description — what the account is for
• synthetic_account_category — e.g. general, external_checking, external_savings

Choose the type that matches the intended use. If the user has not specified a type, ask them or infer from context (e.g. "checking account" → external_checking category).

Step 3 — Select a Pool

List available pools:

list-pools

Choose the pool that:

• The customer already belongs to (their pool_uids from Step 1), or
• Matches the intended product/program context

Note the pool uid — this becomes pool_uid at creation.

Step 4 — Check Product Eligibility (Optional)

If you want to confirm the customer is eligible for a product before opening an account:

list-products
list-customer-products  (to see what the customer already has)

This step is informational — product eligibility is enforced by the API at creation time.

Step 5 — Determine Payment Rail Fields

Depending on the account type and use case, include the appropriate optional block:

ACH External Account

Include an ach block:

• account_type — checking or savings
• counterparty_name — name on the external account
• routing_number and account_number — external bank details

Wire External Account

Include a wire block:

• counterparty_name — name on the external account
• Optionally counterparty_bank_name and counterparty_bank_address