Generate Customer Account Onboarding Link

post/customer-accounts/onboard

Request

Base URL
https://api.zeal.com
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

companyIDstring required

ID of the company

customerAccountIDstring required

ID of the customer account

profileInfoboolean

Flag to include profile info step of the onboarding flow

bankInfoboolean

Flag to include bank info (funding source) step of the onboarding flow

Response

200

successboolean

Example response

{
  "data": {
    "link": "https://app.zeal.com/customer-account-onboard?accessToken=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImMxOTgwMjY0ZmMyMjNhODkwYWZhZTgzYzkxYmQyZDQzOGVmMmFkMGRhZTc1MWZkZWEzNjYwYzNlNTU2YjEzOTYifQ.eyJjb21wYW55SUQiOiIyNGI1YjI5ZjA3OTI0ODQwYjExOWMzNGMxMzU4OTQwYyIsInBhcnRuZXJJRCI6ImMxMzNlZWQyYzliODQxOWJhMmYyMmRjMDU5YmQ0NDVhIiwiY3VzdG9tZXJBY2NvdW50SUQiOiIzMTE4ZGE5ZmMxNTQ0NGUyOTZlYTFiZTgyNDJhZTg3ZCIsInRlc3RNb2RlIjp0cnVlLCJlbnYiOiJsb2NhbCIsInN0YWdlcyI6eyJwcm9maWxlX2luZm8iOnRydWUsImZ1bmRpbmdfc291cmNlIjp0cnVlfSwiZXhwIjoxNzI4NTg5MzQ5LCJpYXQiOjE3MjcyOTMzNDl9.sAM5tuBjPFmwgh46hkJe1zJD2DLJJMGoyqwertyuiop"
  },
  "success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.