{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs/brands/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["partial"]},"type":"markdown"},"seo":{"title":"Overview | Brands API | Sinch","siteUrl":"https://developers.sinch.com","llmstxt":{"title":"Sinch Developer Documentation","description":"LLMs.txt containing a map of all the documentation files for Sinch.","sections":[{"title":"SMS API","description":"The SMS API allows you to send and receive SMS messages with a few easy steps. You can also send bulk SMS messages to multiple customers using the Sinch SMS service.","includeFiles":["docs/sms/**/*.md","docs/sms/**/*.yaml"],"excludeFiles":["docs/sms/index.md"]},{"title":"Numbers API","description":"The Numbers API enables you to search for, view, and activate numbers. It's considered a precursor to other APIs in the Sinch product family. The numbers API can be used in tandem with any of our APIs that perform messaging or calling.","includeFiles":["docs/numbers/**/*.md","docs/numbers/**/*.yaml"],"excludeFiles":["docs/numbers/index.md"]},{"title":"Conversation API","description":"Send and receive messages globally on many popular channels with ease and confidence when using Sinch's Conversation API. Conversation API is the preferred API for sending mobile messages on SMS and other social channels with Sinch. It is a simple API with unified error messages, consistent request payloads, and common webhook payloads that are channel-agnostic.","includeFiles":["docs/conversation/**/*.md","docs/conversation/**/*.yaml"],"excludeFiles":["docs/conversation/index.md"]},{"title":"Voice API","description":"The Voice API works as a big telephony switch. The Voice API handles incoming phone calls (also known as incoming call “legs”), sets up outgoing phone calls (or outgoing call “legs”), and bridges the two. The incoming call leg may come in over a data connection (from a smartphone or web application using the Sinch SDKs) or through a local phone number (from the PSTN network). Similarly, the outgoing call leg can be over data (to another smartphone or web application using the Sinch SDKs) or the PSTN network.","includeFiles":["docs/voice/**/*.md","docs/voice/**/*.yaml"],"excludeFiles":["docs/voice/index.md"]},{"title":"Verification API","description":"The Verification API is a platform for phone number verification. It consists of the API and different software development kits (the Sinch SDKs) that you integrate with your smartphone or web application and cloud based back-end services. Together they enable SMS, Flashcall, Phone Call and Data verification in your application.","includeFiles":["docs/verification/**/*.md","docs/verification/**/*.yaml"],"excludeFiles":["docs/verification/index.md"]},{"title":"Provisioning API","description":"Provisioning API allows you to programmatically set up your senders, accounts and templates on your favorite messaging platforms on the Conversation API. For now, you can create your first WhatsApp channel through Meta's Embedded sign up, you can configure your first SMS App and configure your webhooks. As development continues, we will be adding the most commonly used channels.","includeFiles":["docs/provisioning-api/**/*.md","docs/provisioning-api/**/*.json"],"excludeFiles":["docs/provisioning-api/index.md"]},{"title":"Elastic SIP Trunking API","description":"With Elastic SIP Trunking you can create and manage your SIP trunks and phone numbers programmatically.","includeFiles":["docs/est/**/*.md","docs/est/**/*.yaml"],"excludeFiles":["docs/est/index.md"]},{"title":"Fax API","description":"Send and receive HIPAA compliant faxes on our modern fax platform using our developer-friendly API.","includeFiles":["docs/fax/**/*.md","docs/fax/**/*.yaml"],"excludeFiles":["docs/fax/index.md"]},{"title":"In-app Voice and Video SDK","description":"The In-app Voice and Video SDK enables you to add voice and video calling capabilities directly into your mobile or web application using the Sinch SDKs.","includeFiles":["docs/in-app-calling/**/*.md"],"excludeFiles":["docs/in-app-calling/index.md"]}],"hide":false,"excludeFiles":[]},"description":"Use the Brands API to register and configure your campaigns and brands."},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"overview","__idx":0},"children":["Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Ready to register your brand? You're in the right place."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"authentication","__idx":1},"children":["Authentication"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["There are two ways to authenticate the Registration API: Basic and OAuth 2.0. The recommended way is via OAuth as it is more secure."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"oauth20-authentication","__idx":2},"children":["OAuth2.0 authentication"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Achieve more secure API authentication with OAuth 2.0 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["access tokens"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Access tokens are ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["short lived"]},". Typically, they will only last ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["one hour"]},". This is done to keep your data (and ours) safer."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In exchanging credentials, you'll get a long string called an ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["access token"]},". This access token will serve as your bearer token in the authorization header of API calls."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Find your credentials"]}," in the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":["Sinch Build Dashboard"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["There are two pieces of information needed to obtain an access token: the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["key ID"]}," and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["key secret"]}," corresponding to your project ID."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To get an access token, do the following:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Login to the Sinch Build Dashboard to get your ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":["access keys"]},"."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Click on ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create Access Key"]}," and when prompted, enter a display name, then click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Confirm"]},"."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Does it have to be a new key?"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Not at all. If you have existing credentials saved, feel free to use them."]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Key ID"]}," and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Key Secret"]}," will display. Save the project ID, key ID, and key secret someplace safe."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Important!"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["The key secret is only viewable at the time of initial creation."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you accidentally misplace they key secret, no worries! Create a new key."]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Using the following curl command, get your access token using the key ID and key secret."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"curl","header":{"controls":{"copy":{}}},"source":"curl https://auth.sinch.com/oauth2/token \\\n-d grant_type=client_credentials \\\n-u YOUR_Key_ID:YOUR_Key_Secret\n","lang":"curl"},"children":[]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You'll see your new access token in the response. Now you're ready to use this token on calls to the API. The access token will be useable for ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["one hour."]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Short lived"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The access token is meant to be short lived for enhanced security. Generate one as often as it is necessary."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"basic-authentication","__idx":3},"children":["Basic authentication"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"http://en.wikipedia.org/wiki/Basic_access_authentication"},"children":["HTTP Basic authentication "]},"works on all Sinch REST APIs. Basic auth is often the preferred option for testing because it is simple and easy to use."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Important!"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Basic authentication is intended for test purposes only, and should only be used for experimenting with APIs and building prototypes. API calls using basic authentication are heavily rate limited, and these limits may change at any time without warning. Production systems should use OAuth access tokens instead."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Basic authentication is sent in the authorization header with each call."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["No matter the programming language, there are three main components for successful basic authentication in a request:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The designation of authorization type, which is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["basic"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["username"]},", which in Sinch's case is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["YOUR_Key_ID"]},", corresponding to your project"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["password"]},", which is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["YOUR_Key_Secret"]},", again, corresponding to the project"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can view and manage your API credentials ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":["here"]},"."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Need help?"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Check out ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://community.sinch.com/t5/Virtual-Numbers/What-is-a-project-and-where-do-I-find-the-key-and-secret/ta-p/8794"},"children":["this article"]}," for a walk-through on finding your key and secret."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To use basic auth in an API call, do the following:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["First, create a new access key ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":["in the Sinch Build Dashboard"]}," by clicking ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create Access Key"]},"."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Copy your ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["project ID"]},", ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["key ID"]},", and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["key secret"]},"."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Important!"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Keep your key secret somewhere safe as it is ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["only viewable upon initial project creation"]},". The project ID and key ID are always readily available in the Sinch Build Dashboard. If you misplace your key secret, simply generate a new key!"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use your key ID as the username (sometimes called the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["client_id"]},") and your key secret as the password (can be referred to as the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["client_secret"]},") in every call made to a Sinch API."]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"base-url","__idx":4},"children":["Base URL"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following URLs can be used by the REST API."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Server"},"children":["Server"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"URL"},"children":["URL"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["HTTPS Brands API Server (Default(US))"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://brand.api.sinch.com"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"formats-and-conventions","__idx":5},"children":["Formats and conventions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Let's take a brief look at some of the formats used in the REST API."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"json","__idx":6},"children":["JSON"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["JSON (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/json"]},") is the content type of both requests and responses if not otherwise specified."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Requests with invalid JSON will be rejected."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"null-values","__idx":7},"children":["Null values"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Null values can be omitted in requests and will be omitted in responses. In some cases, explicitly setting ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["null"]}," will overwrite a previously set value with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["null"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"new-features","__idx":8},"children":["New features"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["New features might result in additional request and response parameters. New request parameters will either have a default value or be considered optional to retain backwards compatibility. It's highly recommended to ignore any unexpected parameters when reading JSON in API responses and in callback handlers."]}]},"headings":[{"value":"Overview","id":"overview","depth":1},{"value":"Authentication","id":"authentication","depth":2},{"value":"OAuth2.0 authentication","id":"oauth20-authentication","depth":2},{"value":"Basic authentication","id":"basic-authentication","depth":2},{"value":"Base URL","id":"base-url","depth":2},{"value":"Formats and conventions","id":"formats-and-conventions","depth":2},{"value":"JSON","id":"json","depth":3},{"value":"Null values","id":"null-values","depth":3},{"value":"New features","id":"new-features","depth":2}],"frontmatter":{"seo":{"title":"Overview | Brands API | Sinch","description":"Use the Brands API to register and configure your campaigns and brands."},"disableRating":true},"lastModified":"2025-09-05T14:04:57.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/brands/api-reference","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}