{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs/brands/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Register a new brand","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":"Learn how to register a new brand."},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"getting-started-with-registering-a-brand","__idx":0},"children":["Getting started with registering a brand"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To register a brand, follow these steps:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"#getmetadata"},"children":["Get metadata"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"#createandsubmitbrand"},"children":["Create and submit brand"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"authentication","__idx":1},"children":["Authentication"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All API endpoints described below require authentication. You can authenticate your requests using one of the following two methods for the Authorization header:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Bearer Token:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"shell","header":{"controls":{"copy":{}}},"source":"    Authorization: Bearer <YourJwtToken>\n","lang":"shell"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Basic Authentication:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"shell","header":{"controls":{"copy":{}}},"source":"    Authorization: Basic <YourBase64EncodedCredentials>\n","lang":"shell"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"getmetadata","__idx":2},"children":["GetMetaData"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This endpoint returns the template of required information for creating or updating a brand. Think of it as a blueprint for the data payload you will send to both the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"#createandsubmitbrand"},"children":["CreateAndSubmitBrand"]}," and ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"#updatebrand"},"children":["UpdateBrand"]}," endpoints."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use this endpoint to find out:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Which fields are required for submission."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The correct name to use for each field."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["All validation rules, such as character limits, required formats, and accepted values."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following curl command demonstrates how to retrieve the metadata for a given brand ID:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"shell","header":{"controls":{"copy":{}}},"source":"    curl --location 'https://brands-api.numbers-registration.staging.sinch.com/v1/projects/27eb83b8-6030-491b-a3f5-2fc4b92a3aee/brand-metadata?brandType=US_SHORT_CODE_REGISTRY' \\\n    --header 'Authorization: ......'\n","lang":"shell"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"brandMetadataId\": \"e442df25-e1fb-4651-b841-aca1073cf978\",\n    \"brandType\": \"US_SHORT_CODE_REGISTRY\",\n    \"marketCode\": \"US\",\n    \"majorVersion\": 2,\n    \"minorVersion\": 0,\n    \"createTime\": \"2025-10-09T14:05:44.863006Z\",\n    \"data\": [\n        {\n            \"attributes\": [\n                {\n                    \"example\": \"E.g. Tech Innovators LLC\",\n                    \"minLength\": 1,\n                    \"name\": \"name\",\n                    \"required\": true,\n                    \"title\": \"Legal company name\",\n                    \"type\": \"string\"\n                },\n                {\n                    \"example\": \"E.g. Tech Solutions\",\n                    \"maxLength\": 80,\n                    \"name\": \"dba\",\n                    \"required\": false,\n                    \"title\": \"Doing business as\",\n                    \"type\": \"string\"\n                },\n                {\n                    \"enum\": [\n                        \"Corporation\",\n                        \"Limited Liability Corporation (LLC)\",\n                        \"Partnership\",\n                        \"S Corporation\",\n                        \"Sole Proprietorship\"\n                    ],\n                    \"name\": \"legal_entity_type\",\n                    \"required\": true,\n                    \"title\": \"Entity type\",\n                    \"type\": \"string\"\n                },\n                {\n                    \"example\": \"E.g. AAPL\",\n                    \"maxLength\": 5,\n                    \"name\": \"symbol\",\n                    \"required\": false,\n                    \"title\": \"Stock market symbol\",\n                    \"type\": \"string\"\n                },\n                {\n                    \"example\": \"E.g. www.techinnovators.com\",\n                    \"messages\": {\n                        \"minLength\": \"At least 1 character is required\",\n                        \"pattern\": \"Needs to be a valid URL address\"\n                    },\n                    \"minLength\": 1,\n                    \"name\": \"url\",\n                    \"pattern\": \"^(http://www.|https://www.|http://|https://)?[a-z0-9]+([-.]{1}[a-z0-9]+)*.[a-z]{2,63}(:[0-9]{1,5})?(/.*)?$\",\n                    \"required\": true,\n                    \"title\": \"Website URL\",\n                    \"type\": \"string\"\n                }\n            ],\n            \"categoryType\": \"GENERAL\",\n            \"title\": \"Company information\"\n        },\n        {\n            \"attributes\": [\n                {\n                    \"enum\": [\n                        \"AD\",\n                        \"AE\",\n                        \"AF\",\n                        \"AG\",\n                        \"AI\",\n                        \"AL\",\n                        \"AM\",\n                        \"AO\",\n                        \"AQ\",\n                        \"AR\",\n                        \"AS\",\n                        \"AT\",\n                        \"AU\",\n                        \"AW\",\n                        \"AX\",\n                        \"AZ\",\n                        \"BA\",\n                        \"BB\",\n                        \"BD\",\n                        \"BE\",\n                        \"BF\",\n                        \"BG\",\n                        \"BH\",\n                        \"BI\",\n                        \"BJ\",\n                        \"BL\",\n                        \"BM\",\n                        \"BN\",\n                        \"BO\",\n                        \"BQ\",\n                        \"BR\",\n                        \"BS\",\n                        \"BT\",\n                        \"BV\",\n                        \"BW\",\n                        \"BY\",\n                        \"BZ\",\n                        \"CA\",\n                        \"CC\",\n                        \"CD\",\n                        \"CF\",\n                        \"CG\",\n                        \"CH\",\n                        \"CI\",\n                        \"CK\",\n                        \"CL\",\n                        \"CM\",\n                        \"CN\",\n                        \"CO\",\n                        \"CR\",\n                        \"CU\",\n                        \"CV\",\n                        \"CW\",\n                        \"CX\",\n                        \"CY\",\n                        \"CZ\",\n                        \"DE\",\n                        \"DJ\",\n                        \"DK\",\n                        \"DM\",\n                        \"DO\",\n                        \"DZ\",\n                        \"EC\",\n                        \"EE\",\n                        \"EG\",\n                        \"EH\",\n                        \"ER\",\n                        \"ES\",\n                        \"ET\",\n                        \"FI\",\n                        \"FJ\",\n                        \"FK\",\n                        \"FM\",\n                        \"FO\",\n                        \"FR\",\n                        \"GA\",\n                        \"GB\",\n                        \"GD\",\n                        \"GE\",\n                        \"GF\",\n                        \"GG\",\n                        \"GH\",\n                        \"GI\",\n                        \"GL\",\n                        \"GM\",\n                        \"GN\",\n                        \"GP\",\n                        \"GQ\",\n                        \"GR\",\n                        \"GS\",\n                        \"GT\",\n                        \"GU\",\n                        \"GW\",\n                        \"GY\",\n                        \"HK\",\n                        \"HM\",\n                        \"HN\",\n                        \"HR\",\n                        \"HT\",\n                        \"HU\",\n                        \"ID\",\n                        \"IE\",\n                        \"IL\",\n                        \"IM\",\n                        \"IN\",\n                        \"IO\",\n                        \"IQ\",\n                        \"IR\",\n                        \"IS\",\n                        \"IT\",\n                        \"JE\",\n                        \"JM\",\n                        \"JO\",\n                        \"JP\",\n                        \"KE\",\n                        \"KG\",\n                        \"KH\",\n                        \"KI\",\n                        \"KM\",\n                        \"KN\",\n                        \"KP\",\n                        \"KR\",\n                        \"KW\",\n                        \"KY\",\n                        \"KZ\",\n                        \"LA\",\n                        \"LB\",\n                        \"LC\",\n                        \"LI\",\n                        \"LK\",\n                        \"LR\",\n                        \"LS\",\n                        \"LT\",\n                        \"LU\",\n                        \"LV\",\n                        \"LY\",\n                        \"MA\",\n                        \"MC\",\n                        \"MD\",\n                        \"ME\",\n                        \"MF\",\n                        \"MG\",\n                        \"MH\",\n                        \"MK\",\n                        \"ML\",\n                        \"MM\",\n                        \"MN\",\n                        \"MO\",\n                        \"MP\",\n                        \"MQ\",\n                        \"MR\",\n                        \"MS\",\n                        \"MT\",\n                        \"MU\",\n                        \"MV\",\n                        \"MW\",\n                        \"MX\",\n                        \"MY\",\n                        \"MZ\",\n                        \"NA\",\n                        \"NC\",\n                        \"NE\",\n                        \"NF\",\n                        \"NG\",\n                        \"NI\",\n                        \"NL\",\n                        \"NO\",\n                        \"NP\",\n                        \"NR\",\n                        \"NU\",\n                        \"NZ\",\n                        \"OM\",\n                        \"PA\",\n                        \"PE\",\n                        \"PF\",\n                        \"PG\",\n                        \"PH\",\n                        \"PK\",\n                        \"PL\",\n                        \"PM\",\n                        \"PN\",\n                        \"PR\",\n                        \"PS\",\n                        \"PT\",\n                        \"PW\",\n                        \"PY\",\n                        \"QA\",\n                        \"RE\",\n                        \"RO\",\n                        \"RS\",\n                        \"RU\",\n                        \"RW\",\n                        \"SA\",\n                        \"SB\",\n                        \"SC\",\n                        \"SD\",\n                        \"SE\",\n                        \"SG\",\n                        \"SH\",\n                        \"SI\",\n                        \"SJ\",\n                        \"SK\",\n                        \"SL\",\n                        \"SM\",\n                        \"SN\",\n                        \"SO\",\n                        \"SR\",\n                        \"SS\",\n                        \"ST\",\n                        \"SV\",\n                        \"SX\",\n                        \"SY\",\n                        \"SZ\",\n                        \"TC\",\n                        \"TD\",\n                        \"TF\",\n                        \"TG\",\n                        \"TH\",\n                        \"TJ\",\n                        \"TK\",\n                        \"TL\",\n                        \"TM\",\n                        \"TN\",\n                        \"TO\",\n                        \"TR\",\n                        \"TT\",\n                        \"TV\",\n                        \"TW\",\n                        \"TZ\",\n                        \"UA\",\n                        \"UG\",\n                        \"UM\",\n                        \"US\",\n                        \"UY\",\n                        \"UZ\",\n                        \"VA\",\n                        \"VC\",\n                        \"VE\",\n                        \"VG\",\n                        \"VI\",\n                        \"VN\",\n                        \"VU\",\n                        \"WF\",\n                        \"WS\",\n                        \"YE\",\n                        \"YT\",\n                        \"ZA\",\n                        \"ZM\",\n                        \"ZW\"\n                    ],\n                    \"name\": \"country\",\n                    \"required\": true,\n                    \"title\": \"Country\",\n                    \"type\": \"string\"\n                },\n                {\n                    \"example\": \"E.g. 123 Innovation Street\",\n                    \"minLength\": 1,\n                    \"name\": \"street\",\n                    \"required\": true,\n                    \"title\": \"Street address\",\n                    \"type\": \"string\"\n                },\n                {\n                    \"example\": \"E.g. Suite 500\",\n                    \"minLength\": 1,\n                    \"name\": \"street2\",\n                    \"required\": false,\n                    \"title\": \"Street address 2\",\n                    \"type\": \"string\"\n                },\n                {\n                    \"example\": \"E.g. Chicago\",\n                    \"minLength\": 1,\n                    \"name\": \"city\",\n                    \"required\": true,\n                    \"title\": \"City\",\n                    \"type\": \"string\"\n                },\n                {\n                    \"example\": \"E.g. Illinois\",\n                    \"minLength\": 1,\n                    \"name\": \"state\",\n                    \"required\": true,\n                    \"title\": \"State\",\n                    \"type\": \"string\"\n                },\n                {\n                    \"description\": \"2 characters\",\n                    \"example\": \"E.g. IL\",\n                    \"maxLength\": 2,\n                    \"minLength\": 2,\n                    \"name\": \"state_code\",\n                    \"required\": true,\n                    \"title\": \"State code\",\n                    \"type\": \"string\"\n                },\n                {\n                    \"minLength\": 5,\n                    \"name\": \"zip\",\n                    \"required\": true,\n                    \"title\": \"Zip / Postal Code\",\n                    \"type\": \"string\"\n                }\n            ],\n            \"categoryType\": \"BRAND_CLIENT_ADDRESS\",\n            \"title\": \"Address Information\"\n        },\n        {\n            \"attributes\": [\n                {\n                    \"description\": \"9 digits\",\n                    \"maxLength\": 9,\n                    \"minLength\": 9,\n                    \"name\": \"federal_tax_id\",\n                    \"required\": true,\n                    \"title\": \"Federal Tax ID (EIN)\",\n                    \"type\": \"string\"\n                },\n                {\n                    \"description\": \"9 digits\",\n                    \"maxLength\": 9,\n                    \"minLength\": 9,\n                    \"name\": \"duns\",\n                    \"required\": false,\n                    \"title\": \"Dun and Bradstreet (DUNS)\",\n                    \"type\": \"string\"\n                },\n                {\n                    \"description\": \"20 characters\",\n                    \"maxLength\": 20,\n                    \"minLength\": 20,\n                    \"name\": \"giin\",\n                    \"required\": false,\n                    \"title\": \"GIIN\",\n                    \"type\": \"string\"\n                },\n                {\n                    \"description\": \"20 characters\",\n                    \"maxLength\": 20,\n                    \"minLength\": 20,\n                    \"name\": \"lei\",\n                    \"required\": false,\n                    \"title\": \"Legal Entity Identifier (LEI)\",\n                    \"type\": \"string\"\n                }\n            ],\n            \"categoryType\": \"BUSINESS_IDENTIFIER\",\n            \"title\": \"Business identifiers\"\n        },\n        {\n            \"attributes\": [\n                {\n                    \"minLength\": 1,\n                    \"name\": \"first_name\",\n                    \"required\": true,\n                    \"title\": \"First name\",\n                    \"type\": \"string\"\n                },\n                {\n                    \"minLength\": 1,\n                    \"name\": \"last_name\",\n                    \"required\": true,\n                    \"title\": \"Last name\",\n                    \"type\": \"string\"\n                },\n                {\n                    \"messages\": {\n                        \"minLength\": \"At least 6 digits are required\",\n                        \"pattern\": \"The number needs to start with the country code prefix and must have at least 6 digits. For example +46999444444 or 0046999444444\"\n                    },\n                    \"name\": \"phone\",\n                    \"pattern\": \"^(?:\\\\+|00)\\\\d{6,}$\",\n                    \"required\": true,\n                    \"title\": \"Phone number\",\n                    \"type\": \"string\"\n                },\n                {\n                    \"example\": \"E.g. 1234\",\n                    \"maxLength\": 6,\n                    \"name\": \"phone_extension\",\n                    \"required\": false,\n                    \"title\": \"Phone extension\",\n                    \"type\": \"string\"\n                },\n                {\n                    \"description\": \"Public domains not allowed\",\n                    \"example\": \"E.g. john.doe@yourcompany.com\",\n                    \"messages\": {\n                        \"minLength\": \"At least 1 character is required\",\n                        \"pattern\": \"Needs to be a valid email address\"\n                    },\n                    \"name\": \"email\",\n                    \"pattern\": \"^\\\\S+@\\\\S+\\\\.\\\\S+$\",\n                    \"required\": true,\n                    \"title\": \"Email\",\n                    \"type\": \"string\"\n                }\n            ],\n            \"categoryType\": \"BRAND_CLIENT_POINT_OF_CONTACT\",\n            \"title\": \"Contact Information\"\n        },\n        {\n            \"attributes\": [\n                {\n                    \"description\": \"If you want to request a vanity Short Code, please specify your preference\",\n                    \"example\": \"21234\",\n                    \"maxLength\": 10,\n                    \"minLength\": 3,\n                    \"name\": \"vanity_sc\",\n                    \"required\": false,\n                    \"title\": \"Vanity Short Code\",\n                    \"type\": \"string\"\n                },\n                {\n                    \"description\": \"In case that you selected a Vanity Short Code and the selected code is not available, please select an alternative code\",\n                    \"example\": \"20666\",\n                    \"maxLength\": 10,\n                    \"minLength\": 3,\n                    \"name\": \"vanity_alt_sc\",\n                    \"required\": false,\n                    \"title\": \"Alternative Vanity Short Code\",\n                    \"type\": \"string\"\n                }\n            ],\n            \"categoryType\": \"SHORTCODE\",\n            \"title\": \"Short Code Information\"\n        }\n    ]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"createandsubmit-brand","__idx":3},"children":["CreateAndSubmit Brand"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This endpoint allows for the creation and submission of a new brand in a single API call."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["It requires a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["brand_name"]}," and a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["brand_metadata_id"]},". The structure of the data payload is dynamic and must conform to the specific requirements and fields defined by the chosen ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["brand_metadata_id"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following curl command demonstrates how to create and submit new brand using metadata's brand ID:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"shell","header":{"controls":{"copy":{}}},"source":"curl --location 'https://brands-api.numbers-registration.staging.sinch.com/v1/projects/27eb83b8-6030-491b-a3f5-2fc4b92a3aee/brands:submit' \\\n--header 'Content-Type: text/plain' \\\n--header 'Authorization: ......' \\\n--data-raw '{\n  \"brandName\": \"My New Brand\",\n  \"brandMetadataId\": \"e442df25-e1fb-4651-b841-aca1073cf976\",\n  \"data\": [\n    {\n            \"legal_entity_type\": \"Corporation\",\n            \"name\": \"Abc Store Corp.\",\n            \"symbol\": \"SNC\",\n            \"url\": \"https://abc-store.net\"\n        },\n        {\n            \"city\": \"Miami\",\n            \"country\": \"US\",\n            \"state\": \"Florida\",\n            \"state_code\": \"FL\",\n            \"street\": \"1450 SW 22nd St\",\n            \"zip\": \"33145\"\n        },\n        {\n            \"federal_tax_id\": \"234342344\"\n        },\n        {\n            \"email\": \"contactabcsinch.com\",\n            \"first_name\": \"Abc\",\n            \"last_name\": \"Sinch\",\n            \"phone\": \"+13054454855\"\n        }\n  ],\n  \"callbackUrl\": \"https://webhook.site/d73ba377-90c3-4029-9a99-fe5a7d485b49\"\n}'\n","lang":"shell"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"brandId\": \"01k7h5y64mh4fwcmxxa48h9m75\",\n    \"brandName\": \"My New Brand\",\n    \"brandMetadataId\": \"e442df25-e1fb-4651-b841-aca1073cf976\",\n    \"status\": \"NEW\",\n    \"data\": [\n        {\n            \"legal_entity_type\": \"Corporation\",\n            \"name\": \"Abc Store Corp.\",\n            \"symbol\": \"SNC\",\n            \"url\": \"https://abc-store.net\"\n        },\n        {\n            \"city\": \"Miami\",\n            \"country\": \"US\",\n            \"state\": \"Florida\",\n            \"state_code\": \"FL\",\n            \"street\": \"1450 SW 22nd St\",\n            \"zip\": \"33145\"\n        },\n        {\n            \"federal_tax_id\": \"234342344\"\n        },\n        {\n            \"email\": \"contact@abcsinch.com\",\n            \"first_name\": \"Abc\",\n            \"last_name\": \"sinch\",\n            \"phone\": \"+13054454855\"\n        }\n    ],\n    \"logs\": [\n        {\n            \"status\": \"NEW\",\n            \"comment\": \"\",\n            \"author\": \"AGENT\",\n            \"createTime\": \"2025-10-14T10:58:27.111076\"\n        }\n    ],\n    \"callbackUrl\": \"https://webhook.site/d73ba377-90c3-4029-9a99-fe5a7d485b49\",\n    \"createTime\": \"2025-10-14T10:58:27.095235\",\n    \"updateTime\": \"2025-10-14T10:58:27.095235\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"updatebrand","__idx":4},"children":["UpdateBrand"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This endpoint allows you to modify the details of an existing brand."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To use it, you must specify which brand to update by including its brandId in the API endpoint's URL. You can then provide a new brand_name and/or update the fields within the data payload."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Important!"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The data payload you send will completely replace the existing data for the brand. Therefore, you must include all required fields, not just the ones you wish to change."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"shell","header":{"controls":{"copy":{}}},"source":"curl --location --request PUT 'https://brands-api.numbers-registration.staging.sinch.com/v1/projects/27eb83b8-6030-491b-a3f5-2fc4b92a3aee/brands/01k7h5y64mh4fwcmxxa48h9m75' \\\n--header 'Content-Type: text/plain' \\\n--header 'Authorization: .....' \\\n--data-raw '{\n  \"brandName\": \"My New Brand2\",\n  \"data\": [\n    {\n            \"legal_entity_type\": \"Corporation\",\n            \"name\": \"Abc Store Corp.\",\n            \"symbol\": \"SNC\",\n            \"url\": \"https://abc-sinch.net\"\n        },\n        {\n            \"city\": \"Miami\",\n            \"country\": \"US\",\n            \"state\": \"Florida\",\n            \"state_code\": \"FL\",\n            \"street\": \"1450 SW 22nd St\",\n            \"zip\": \"33145\"\n        },\n        {\n            \"federal_tax_id\": \"234342344\"\n        },\n        {\n            \"email\": \"contact@abcsinch.com\",\n            \"first_name\": \"abc\",\n            \"last_name\": \"Sinch\",\n            \"phone\": \"+13054454855\"\n        }\n  ],\n  \"callbackUrl\": \"https://webhook.site/d73ba377-90c3-4029-9a99-fe5a7d485b49\"\n}'\n","lang":"shell"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"brandId\": \"01k7h5y64mh4fwcmxxa48h9m75\",\n    \"brandName\": \"My New Brand2\",\n    \"brandMetadataId\": \"e442df25-e1fb-4651-b841-aca1073cf976\",\n    \"status\": \"NEW\",\n    \"data\": [\n        {\n            \"legal_entity_type\": \"Corporation\",\n            \"name\": \"Abc Store Corp.\",\n            \"symbol\": \"SNC\",\n            \"url\": \"https://abc-sinch.net\"\n        },\n        {\n            \"city\": \"Miami\",\n            \"country\": \"US\",\n            \"state\": \"Florida\",\n            \"state_code\": \"FL\",\n            \"street\": \"1450 SW 22nd St\",\n            \"zip\": \"33145\"\n        },\n        {\n            \"federal_tax_id\": \"234342344\"\n        },\n        {\n            \"email\": \"contact@abcsicnh.com\",\n            \"first_name\": \"Abc\",\n            \"last_name\": \"Sinch\",\n            \"phone\": \"+13054454855\"\n        }\n    ],\n    \"logs\": [\n        {\n            \"status\": \"NEW\",\n            \"comment\": \"\",\n            \"author\": \"AGENT\",\n            \"createTime\": \"2025-10-14T10:58:27.111076\"\n        },\n        {\n            \"status\": \"NEW\",\n            \"comment\": \"\",\n            \"author\": \"AGENT\",\n            \"createTime\": \"2025-10-14T11:02:31.122552\"\n        }\n    ],\n    \"callbackUrl\": \"https://webhook.site/d73ba377-90c3-4029-9a99-fe5a7d485b49\",\n    \"createTime\": \"2025-10-14T10:58:27.095235\",\n    \"updateTime\": \"2025-10-14T11:04:06.2884\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"callback-event-reception","__idx":5},"children":["Callback event reception"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If the callback URL was specified in the CreateAndSubmit Request endpoint, then callback events will be received once the brand state changes."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When a brand is first submitted, it receives a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NEW"]}," status. Once it is picked up for the review process, its status will be updated to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PENDING_REVIEW"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PENDING_REVIEW"]}," status confirms that the brand is now actively in the queue for internal review by our team. Once the review is complete and the status changes again (for example, to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["APPROVED"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["REJECTED"]},"), a callback notification will be sent to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["callback_url"]}," you provided."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Please, read carefully the callback configuration API documentation to see how to authenticate this event."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"eventId\": \"01k6n0nva5enpgwehc8xqj80wg\",\n  \"eventType\": \"BRAND_STATUS_UPDATE\",\n  \"projectId\": \"27eb83b8-6030-491b-a3f5-2fc4b92a3aee\",\n  \"resourceId\": \"01k6n04h28hn8m29a77ee3bj4p\",\n  \"resourceType\": \"US_SHORT_CODE_REGISTRY\",\n  \"status\": \"PENDING\",\n  \"createTime\": \"2025-10-03T12:27:46.859110Z\"\n}\n","lang":"json"},"children":[]}]},"headings":[{"value":"Getting started with registering a brand","id":"getting-started-with-registering-a-brand","depth":1},{"value":"Authentication","id":"authentication","depth":2},{"value":"GetMetaData","id":"getmetadata","depth":2},{"value":"CreateAndSubmit Brand","id":"createandsubmit-brand","depth":2},{"value":"UpdateBrand","id":"updatebrand","depth":2},{"value":"Callback event reception","id":"callback-event-reception","depth":2}],"frontmatter":{"seo":{"title":"Register a new brand","description":"Learn how to register a new brand."},"excludeFromSearch":true},"lastModified":"2025-11-19T15:20:00.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/brands/getting-started/register-brand","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}