---
title: "Generate Customer Account Onboarding Link"
method: POST
path: "/customer-accounts/onboard"
---

# Generate Customer Account Onboarding Link

`POST /customer-accounts/onboard`

## Request

- Base URL: `https://api.zeal.com`
- URL: `https://api.zeal.com/customer-accounts/onboard`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/zeal/apis/zeal-api/docs/customer-accounts/onboard/post.ts> (a function with typed inputs; its response is checked against the schema)

## Request body

- object
  - `companyID` string, required: ID of the company
  - `customerAccountID` string, required: ID of the customer account
  - `profileInfo` boolean: Flag to include profile info step of the onboarding flow
  - `bankInfo` boolean: Flag to include bank info (funding source) step of the onboarding flow

## Response `200`

200

- object
  - `data` object
    - `link` string
  - `success` boolean

## Other responses

- `400`: 400

---

[API](https://skmtc.dev/zeal/apis/zeal-api.md) - [All operations](https://skmtc.dev/zeal/apis/zeal-api/llms.txt) - [OpenAPI document](https://skmtc.dev/zeal/apis/zeal-api/revisions/01346dceb27d?raw)