Authentication

When making API requests, authentication is required in order to verify the permissions of the caller. Authentication is handled via API keys.

Key Management

Customers can manage their own API key access. On the Administration page in the Pearl Software, you should see a card called API Keys.

If you do not see this card on your Administration page, then API access has not been enabled for your firm. Please contact your Pearl representative to enable API access for your firm.

Select the +API Key Button toward the top-left to create a new API key, or select an existing key to edit it. You can disable or re-enable keys by editing the existing key. You can also delete a key from the key’s edit page. You are encouraged to rotate keys periodically to avoid the risks associated with long-standing key usage.

Using your API Key

The API Key is used for token-based authentication. To use token-based authentication, you’ll need to add an “Authorization” header to your request. The body of the header will be the string literal “Token” followed by a space and then your token. An example header would look like:

Authorization: Token 3392fc6e-dbf7-465a-9291-2351b4eb6f18

Using curl, you would simply add a -H parameter like such:

curl -X GET “https://api.pearlcertification.com/1.0/homes/" -H “accept: application/json” -H “Authorization: Token 3392fc6e-dbf7-465a-9291-2351b4eb6f18”