SIsinch
10DLC Brand Registration

Get Brand Details

Get the US 10DLC brand details using the TCR brand ID.

get/v1/projects/{projectId}/brandRegistrations:fetchByTcrBrandId

Request

  • Base URL
    https://us10dlc.numbers.api.sinch.com
  • URL
    https://us10dlc.numbers.api.sinch.com/v1/projects/{projectId}/brandRegistrations:fetchByTcrBrandId
  • Auth
    • HTTP basic
    • or OAuth 2
      Client credentials
      Token URL: https://auth.sinch.com/oauth2/token

Path parameters

projectIdstring required

Sinch uses projects to group resources such as contacts and apps together to manage and connect a unique set of keys and secret IDs for all your Sinch API products. To identify a project, it is given a unique alphanumeric identifier that ties it to your account. Your project ID can be found in the Customer Dashboard.

Query parameters

brandIdstring required

Brand Id to be qualified

Response

A successful response.

brandRegistrationIdstring

Output only. Brand registration Id

brandIdstring

Output only. TCR brand Id

identityStatusstring

Identity status for the brand.

displayNamestring

Output only. Display name defined by user

brandRegistrationStatus'DRAFT' | 'IN_PROGRESS' | 'REJECTED' | 'APPROVED' | 'UPGRADE'
  • DRAFT: Registration has not yet been submitted. Only feasible when creating a brand registration in dashboard.sinch.com - IN_PROGRESS: Registration had been submitted for review - REJECTED: Registration has been rejected. Please contact your account manager for further information - APPROVED: Brand registration has been completed - UPGRADE: The Brand is being upgraded to FULL registration
brandRegistrationType'SIMPLIFIED' | 'FULL' | 'BRAND_REGISTRATION_TYPE_UNSPECIFIED'
  • SIMPLIFIED: Simplified Registration costs 10USD and will only verify your brand. - FULL: Full Registration will cost 50USD but perform an vetting and grant a vetted verified brand.
mockboolean

Defines if created brand should be mocked or real one

Changes

No recorded changes to this operation across all 5 revisions of this API.