Introduction

"API" stands for "Application Programming Interface." An API is the software that allows two applications to connect to each other. Chime has an "Open API" meaning users and/or vendors can access available endpoints as long as they have account credentials to do so.

Summary

• Accessing Chime's API
  • (1) API Key
  • (2) Vendor Key
• Email Verification

Accessing Chime's API

To access Chime's API, please see https://api.chime.me/docs/index.html.

In order to connect with Chime's API you will need two things:

(1) API Key

Each individual Chime user has a unique API key.

To access an individual Chime user's API key, the Chime user needs to navigate to Settings > Integrations > API:

(2) Vendor Key

As a third party vendor, you will be assigned a "Vendor Key" that will be utilized to identify your requests sent via the API on behalf of customers. This is labeled in the API documentation as the following:

vendorKey

To apply for a "vendorKey," please submit an application at THIS LINK and expect a response within three business days. You will be asked to provide the following information:

• Company Name
• Primary Business Contact
  • Contact Name
  • Contact Email
  • Contact Phone Number
• Primary Tech Contact
  • Contact Name
  • Contact Email
  • Contact Phone Number
• Description

**IMPORTANT: The "vendorKey" is a requirement that, if ignored, will result in a broken API connection. As of July 15, 2021, access to API calls without the approved vendor key will be revoked completely.

Once the vendorKey is obtained, you may need to make adjustments to your API connection. Vendors (or those using the API) should first use 2.2.1. Get Token By API key to fetch a new access token with the Chime user's API key and the newly-generated vendorKey. Vendors now need to include the vendorKey to obtain the access token before accessing other endpoints in the API.

Email Address Verification

As of July 5, 2021, leads that are brought into Chime via our API will now have their email address checked with a third party vendor to determine if it is valid or not. If an email address is found to be invalid, it will be marked as such within a lead profile page and this keeps auto-emails from being sent to that address.

Questions?

If you have any questions regarding this topic specifically, please reach out to our Integrations Team at <integration@chimeinc.com> and we will do our best to assist you.