GuidesReference Endpoints
Guides

Setting Up Clients Guide

šŸ“˜

Authenticating this Request

To properly make this API call, the request needs to be authorized by generating a JWT Token sourced from the Authentication API Call using the relevant Affiliate's Public and Secret Key.

Overview

Policies can only be created/sold under a client. You can use the accounts endpoint to create clients under your affiliate.

POST https://api.sandbox.protecht.com/api/v2/accounts/

This endpoint will create a client and an associated user in our database, granting access to the Teak dashboard. It will also return the Client's public and secret keys, which are needed for widget configuration and order submission.

Required Information:

  • Client Name
  • Affiliate ID
  • Product
šŸ“˜

Setting the Product

You must use the product: FanShield or Optional RaaS associated with your affiliate


Try it out!

If you'd like to see a working example of our Onboarding API calls, follow this link to our API Reference Guide ! Feel free to swap out the values and see what a proper request and response call looks like.

Payload Attributes

Attributes Max Length Description
name
string*
255 Name of the client being onboarded.
affiliate
string*
- required - ID of the affiliate this client belongs to. This can be sourced from the Teak Dashboard under settings.
product
string*
- The product branding for this client, this could be FanShield, RegShield, or TourShield.