API Reference

Generate Customer Account Onboarding Link

post
https://api.zeal.com/customer-accounts/onboard
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

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.

attributetypedescription
successbooleanResponse status
datastringOnboarding link for the customer account
errorsarrayContains list of error objects which consists of:
message: Error message
code: Error code as described in Error codes
Body Params
string
required

ID of the company

string
required

ID of the customer account

boolean
Defaults to true

Flag to include profile info step of the onboarding flow

boolean
Defaults to true

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

Responses

Updated 6 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago