An API key is a unique string that verifies the account making an API request. These keys are essential for securing any request to Moov’s API. If a request does not include a valid API key, you will receive an error.
If you need to locate your API key, you can always find it in the Moov app. However, if your account doesn’t have API key read or write access, you won’t be able to access the API keys page in the Moov app. If you’re unable to find your API key, you may want to request access from an administrator on your Moov account.
API keys contain a public key and a secret key. The secret cannot be viewed in Moov after the API key is created, so we recommend immediately storing it in a safe place. If you have lost your secret key, you should delete that API key and create a new one.
To create a new API key, navigate to Developers in the Moov app. Select API keys, where you can view/edit existing keys and create new ones.
Note: only accounts with API key write permissions can create an API key. For more on permissions, see Managing roles.
Set a description for the API key.
You can describe the key however you’d like. This field is customizable so you can remember the purpose of the API key you’re creating.
(Optional) Set a URL to indicate where the origin of the API requests associated with this key.
Select the roles you want to designate for this API key. If you’re not sure what permissions are associated with a given role, you need to edit a certain role, or you’d like to create a new role, see the instructions on Managing roles.
If your API key is compromised, delete it from the list of API keys in Moov. This will immediately ensure that the key cannot be used. You can then create a new key.