Onboard a client

Create a client under your partner account, with its own API keys. Use the client's keys for its widget and orders.

Authentication: create the access token with your partner keys, not a client's.

To give someone access to the client in the Teak Dashboard, pass user. Set send_activation to true to email them a link to activate their account.

The response is the only time the client's secret key is returned. Store it securely.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The client to create.

string
required

The client's name, as customers see it. Must be unique across Teak.

string
required

Your partner ID (af_...), from Settings in the Teak Dashboard.

string
required

The protection product to offer, exactly as your Teak integration contact gives it, for example Optional RaaS.

The client's website domain.

ClientOnboardingUser | null

A person to give access to the client in the Teak Dashboard.

boolean
Defaults to false

true to email user a link to activate their Teak Dashboard account.

Responses

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