Acquire an API Key

Our REST APIs use an API key for authentication, each key is tied to your account.

The API key will allow access to a suite of APIs based on your product subscription. Your key provides access to payment information associated to your account and the ability to authorize payments.


Managing API Keys

Create an API Key

Coordinate with your Resource Manager to obtain an API key or, if authorized, issue a POST request to /keys.

In order to support key rotation, we allow you to create up to five keys at a time.

Delete an API Key

If a key must be revoked, coordinate with your Resource Manager or issue a DELETE request to /keys and provide your API key in the API-Key header.

API Key Storage

Keys are CONFIDENTIAL and should not be shared with colleagues or documented in any form. Your API Key represents your account, and it must be treated like a password.


API key Utilization

Include the key in the API-Key header when making requests to our REST APIs or when configuring your Client SDK