Generate Customer Account Onboarding Link

Time	Status	User Agent
Make a request to see history.

URL Expired

The URL for this request expired after 30 days.

Generates a secure onboarding link for a Customer Account in Zeal. This link expires after 15 days.

Returns

Returns response status and newly created Customer Account object.

attribute	type	description
success	boolean	Response status
data	string	Onboarding link for the customer account
errors	array	Contains list of error objects which consists of: `message`: Error message `code`: Error code as described in Error codes

Parameters

companyID

string

required

ID of the company

customerAccountID

string

required

ID of the customer account

profileInfo

boolean

Defaults to true

Flag to include profile info step of the onboarding flow

truefalse

bankInfo

boolean

Defaults to true

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

truefalse

``200 200

``400 400

curl --request POST \
     --url https://api.zeal.com/customer-accounts/onboard \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "profileInfo": true,
  "bankInfo": true
}
'

``200 - Result``400 - Result