1 of 7

Provision Family plans via API

API access to creating free family plans associated to a business account

Note: This API is for partners of Keeper and Enterprise customers deployed in the Keeper Security Government Cloud region.

Overview

Capabilities of the API

Provision Family Plan API endpoint is for enterprise accounts & MSP partners to register Keeper Family licenses. This endpoint will create a 1 year license with the following Product/Add-ons:

Keeper Family
BreachWatch (Dark Web Monitoring)
10GB File Storage

In order to access this API, contact your support representative to request an API key, this will be shared in a Keeper record.

API definition

Additional API details

API Parameters

For more information on the required parameters, visit:

API Response codes

For more information on the response codes, visit:

API Explorer

For more information on exploring the API with swagger, visit:

If you need support or have additional questions on the usage of these APIs, please contact support or your sales representative.

Sample node.js script

Use the below sample so understand how you might implement this in your environment:

API Troubleshooting

This section contains the following documents in providing more details on troubleshooting with the API:

The API parameters required to make a successful API call:

API Parameters

API response code

API Response Codes

API Explorer guide with Swagger

API Explorer - Swagger

API Parameters

Prerequisite

Prior to working with the API endpoints, your Keeper representative will provided you with the following:

Partner Name
Salt

This information will be needed to get a successful response by the API endpoint.

If you don't have the Partner Name or Salt, contact your Keeper representative.

API Parameters

Keeper Provision APIs require the following API Parameters to be passed with the API endpoint in order to get a successful request: