Create client link


Closed beta

The Client Links API is in closed beta and only available to selected partners. Please contact your partner manager if you want to implement this.

Link a new or existing organization to your OAuth application, in effect creating a new client. The response contains a clientLink where you should redirect your customer to.

The clientLink URL behaves similar to the regular OAuth authorization URL. It supports the following parameters from the Authorize endpoint:

  • client_id
  • state
  • approval_prompt
  • scope

We recommend at least requesting the scopes onboarding.write this way.

Error handling is also dealt with similar to the Authorize endpoint: the customer is redirected back to your app's redirect URL with the error and error_description parameters added to the URL.