Access to Sinch APIs is authenticated through the use of Access keys. Access keys are created for a project or subproject, and grant access to all resources within that project or subproject.Access keys are long-lived credentials which can be exchanged for short-lived access tokens using an OAuth2 token endpoint. This endpoint supports the client_credentials flow where a client_id and client_secret are used to authenticate the calling party.
An access key is comprised of:
- KEY ID - The client_id is referred to as KEY ID and is your API key. When sending a call through the API, it lets us know which account to bill.
- KEY SECRET - The client_secret is referred to as the KEY SECRET and is an extra layer of security which is only visible when you create an access key.
Important:
- When you create an Access key, note down your KEY SECRET carefully as this is only displayed when you create the Access key. If you lose your KEY SECRET (formerly called the secret ID) you will need to generate a new access key.
- Access keys created for a project also have access to all subprojects, which are children of that project.
- SMS Messaging uses a Service Plan ID and API Token for authentication. Read the SMS Service Plan IDs and API Tokens article to learn more.
Where can I find my Access Keys (KEY ID and KEY SECRET)?
- Log in to the Sinch Build Dashboard and select your profile icon in the top right corner. Your profile menu is displayed:
Click the Access Keys option. - The Access Keys page is displayed:
This page shows your project(s) and corresponding Project ID(s) and a list of your Access keys and the corresponding KEY IDs.
How do I create a new Access Key?
To create a new Access Key refer to the article: How do I create a new Access Key?
If you have any questions, contact Sinch or to reach out to your Sinch Account Manager.
