Partner API (1.0)

Clym Partner API allows partners to onboard and manage domains.

Let's follow an example where a partner adds a domain for one of the websites they support.

1 Create a partner domain by performing a POST request to /portal/domains

Headers:
  Authorization: YOUR_API_KEY
  Content-type: application/json
Body:
  {
    "domain": "https://mycompany.com", //  The domain to be registered (required).
    "company_name": "My Company Inc", // The company legal name (required).
    "company_trade_name": "My Company", // The company trade name if different from the company (legal) name (optional).
    "company_id_number": "333000", // Internal company ID number (optional).
    "account_email": "fifth@apple.com", // The email account of the domain owner. This email address will be used for all transactional emails (including onboarding emails) (required).
    "account_first_name": "John", //  The first name of the individual owning the domain
    "account_last_name": "Doe", // The last name of the individual owning the domain
    "phone_number": "+442071838750", //  The phone number of the individual owning the domain
    "vat_number": "GB123456789", // Company VAT number (optional).
    "registration_number": "3123245432234", // Company registration number (optional).
    "country": "UK", // Company country code in ISO 3166-1 alpha-2
    "state": "", // Company state code in ISO 3166-1 alpha-2
    "city": "London",
    "postal_code": "E1 6DB",
    "address": "1st Main Street",
    "send_intro": true, // Determine if the system will send the customized email or not (optional).
    "action": "CREATE_SILENT", // Specify the action the system will take for that domain. SCAN will perform a scan on the domain and send a scan report to the account owner. SCAN_INVITE will scan the domain and start the onboarding process. CREATE_SILENT will just create the company account and its associated domain. This can be used at a later stage to invite the account owner to onboard.
    "primary_color": "#c3c3c3", // Optional, specify the domain's primary color
    "has_scripts": true, // Optional, when disabled, the Widget will not handle any kind of consent/cookie management and will not block any scripts.
    "has_dsar": true, // Optional, when disabled, the Widget will not allow any Data Subject Request creation
    "has_docs": true, // Optional, when disabled, the Widget will not display any legal documents
    "has_accessibility": true, // Optional, when disabled, the Widget will not have any accessibility functionality enabled.
    "display_company": true, // Optional, when disabled, the Company tab in the widget will be hidden
    "display_dpo": true, // Optional, when disabled, the DPO information in the widget will be hidden
    "default_notice_type": "DISCRETE" // Optional, the default widget notification type to be used by the Widget. Values are: CLASSIC, DISCRETE, FOOTER, TOP
  }

Partner Portal API reponds with:

{
  "result": {
    "id": "aa07e325ae3e4495b6c65c445onidzsb",
    "status": "NEW",
    "instance_property_id": "07b7c4f7fe5d48708d65336ezs7vosre",
    "instance_company_id": "a135ba365ce24f54ab3b8b29mmh9cshq",
    "created_at": "2022-10-06T07:00:45.038Z",
    "updated_at": "2022-10-06T07:00:45.033Z",
    "hostname": "mydomain.com",
    "is_active": true,
    "email": "john@doe.com",
    "company_trade_name": "My Company",
    "company_id_number": "333000",
    "source": "API",
    "partner_id": "ac276ff57f9b4d2196c28927gxh25xx6",
    "has_scripts": true,
    "has_dsar": true,
    "has_docs": true,
    "has_accessibility": true,
    "display_company": true,
    "default_notice_type": "DISCRETE",
    "display_dpo": true,
    "privacy_widget":
          "<script>
          window._clymInit=window._clymInit||[];
          window._clymInit.push(['privacy','YOUR_PROPERTY_ID',{}]);
          </script>
          <script src='https://widget.clym-sdk.net/blocking.js'></script>
          <script src='https://widget.clym-sdk.net/clym.js' async></script>",
    "privacy_center_link": "<a href='#' onclick='Clym.showWidget();'>Privacy Center</a>",
    "privacy_dnt_link": "<a href='#' onclick='Clym.showWidget('/requests/new/do_not_sell_my_information');'>Do not sell my personal information</a>"
  }
}

The result.id can be then used in subsequent calls. For example to send an invite to the domain owner.

2 Invite the domain owner with POST request to /portal/domains/1f19dbcbc7b84be5b40ffcc4ya0zqbtr/invite

If suceessfull the Clym API will response with HTTP 200 and, depending on the action used on creation, the system might send an email to the domain account_email with instructions on how to set up the widget or with a scan report.

Once the privacy widget is placed on branch website and Clym backend receives first page view the domain will become ACTIVE.