Download OpenAPI specification:Download

10DLC Brand Registration

Create or look up brand registration for 10DLC virtual numbers

Create Brand Registrations

Create a 10DLC brand registration at TCR (The Campaign Registry). There are 2 types of registrations:

  1. Simplified Registration - only verifies your brand.
  2. Full Registration - performs a vetting and grants a vetted verified brand.
SecurityBasicAuth or OAuth2
Request
path Parameters
projectId
required
string

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.

Request Body schema: application/json
required

The request body to of the brand to be created

displayName
string

Display name is defined by the user

brandRegistrationType
string (Brand Registration Type)
Default: "SIMPLIFIED"
  • 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.
Enum: "SIMPLIFIED" "FULL" "BRAND_REGISTRATION_TYPE_UNSPECIFIED"
object (Company Details)
object (Financial Details)
object (Contact Details)
mock
boolean

Defines if created brand should be mocked or real one

Responses
200

A successful response.

Response Schema: application/json
brandRegistrationId
string

Output only. Brand registration Id

400

If the page_token, number_pattern or order_by is not valid

429

Over limit

post/v1/projects/{projectId}/brandRegistrations:submit
Request samples
application/json
{ }
Response samples
application/json
{
  • "brandRegistrationId": "string"
}

List Brand Registrations

Lists all brand registrations per project.

SecurityBasicAuth or OAuth2
Request
path Parameters
projectId
required
string

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.

Responses
200

A successful response.

Response Schema: application/json
Array of objects (Brand Registration Details)
nextPageToken
string
totalSize
integer <int32>
400

If the page_token, number_pattern or order_by is not valid

429

Over limit

get/v1/projects/{projectId}/brandRegistrations
Request samples
Response samples
application/json
{
  • "brandRegistrations": [
    • {
      }
    ],
  • "nextPageToken": "string",
  • "totalSize": 0
}

Brand Registration Status

Get brand registration details using brand registration ID when creating a brand.

SecurityBasicAuth or OAuth2
Request
path Parameters
projectId
required
string

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.

brandRegistrationId
required
string

The Brand Registration ID is returned in the response when creating the brand

Responses
200

A successful response.

Response Schema: application/json
brandRegistrationId
string

Output only. Brand registration Id

brandId
string

Output only. TCR brand Id

identityStatus
string

Identity status for the brand.

displayName
string

Output only. Display name defined by user

brandRegistrationStatus
string (Brand Registration Status)
Default: "DRAFT"
  • 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
Enum: "DRAFT" "IN_PROGRESS" "REJECTED" "APPROVED" "UPGRADE"
brandRegistrationType
string (Brand Registration Type)
Default: "SIMPLIFIED"
  • 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.
Enum: "SIMPLIFIED" "FULL" "BRAND_REGISTRATION_TYPE_UNSPECIFIED"
object (Company Details)
object (Financial Details)
object (Contact Details)
mock
boolean

Defines if created brand should be mocked or real one

400

If the page_token, number_pattern or order_by is not valid

429

Over limit

get/v1/projects/{projectId}/brandRegistrations/{brandRegistrationId}
Request samples
Response samples
application/json
{
  • "brandRegistrationId": "string",
  • "brandId": "string",
  • "identityStatus": "string",
  • "displayName": "string",
  • "brandRegistrationStatus": "DRAFT",
  • "brandRegistrationType": "SIMPLIFIED",
  • "companyDetails": {
    • "companyName": "string",
    • "companyEmail": "string",
    • "businessContactEmail": "string",
    • "brandName": "string",
    • "country": "string",
    • "streetAddress": "string",
    • "city": "string",
    • "postalCode": "string",
    • "state": "string",
    • "webAddress": "string"
    },
  • "financialDetails": {
    • "brandEntityType": "PUBLIC",
    • "brandVerticalType": "PROFESSIONAL",
    • "taxIdCountry": "string",
    • "taxIdCorporate": "string",
    • "stockSymbol": "string",
    • "exchange": "string"
    },
  • "contactDetails": {
    • "firstName": "string",
    • "lastName": "string",
    • "phoneNumber": "string",
    • "email": "string"
    },
  • "mock": true
}

Brand Registration Update

Update Brand Registration details

SecurityBasicAuth or OAuth2
Request
path Parameters
projectId
required
string

Your project id can be found if you log into your account on dashboard.sinch.com.

brandRegistrationId
required
string

The Brand Registration ID is returned in the response when creating the brand

Request Body schema: application/json
required
object (Company Details)
object (Financial Details)
object (Contact Details)
Responses
200

A successful response.

Response Schema: application/json
brandRegistrationId
string

Output only. Brand registration Id

brandId
string

Output only. TCR brand Id

identityStatus
string

Identity status for the brand.

displayName
string

Output only. Display name defined by user

brandRegistrationStatus
string (Brand Registration Status)
Default: "DRAFT"
  • 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
Enum: "DRAFT" "IN_PROGRESS" "REJECTED" "APPROVED" "UPGRADE"
brandRegistrationType
string (Brand Registration Type)
Default: "SIMPLIFIED"
  • 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.
Enum: "SIMPLIFIED" "FULL" "BRAND_REGISTRATION_TYPE_UNSPECIFIED"
object (Company Details)
object (Financial Details)
object (Contact Details)
mock
boolean

Defines if created brand should be mocked or real one

400

INVALID_ARGUMENT: If the brandRegistrationId is not valid

404

Brand could not be found

429

Over limit

500

INTERNAL: Internal server error. Typically, a server bug.

patch/v1/projects/{projectId}/brandRegistrations/{brandRegistrationId}
Request samples
application/json
{ }
Response samples
application/json
{
  • "brandRegistrationId": "string",
  • "brandId": "string",
  • "identityStatus": "string",
  • "displayName": "string",
  • "brandRegistrationStatus": "DRAFT",
  • "brandRegistrationType": "SIMPLIFIED",
  • "companyDetails": {
    • "companyName": "string",
    • "companyEmail": "string",
    • "businessContactEmail": "string",
    • "brandName": "string",
    • "country": "string",
    • "streetAddress": "string",
    • "city": "string",
    • "postalCode": "string",
    • "state": "string",
    • "webAddress": "string"
    },
  • "financialDetails": {
    • "brandEntityType": "PUBLIC",
    • "brandVerticalType": "PROFESSIONAL",
    • "taxIdCountry": "string",
    • "taxIdCorporate": "string",
    • "stockSymbol": "string",
    • "exchange": "string"
    },
  • "contactDetails": {
    • "firstName": "string",
    • "lastName": "string",
    • "phoneNumber": "string",
    • "email": "string"
    },
  • "mock": true
}

Brand Registration Feedback

Returns feedback information for brand registrations that were rejected. Following are the applicable category IDs:

  • TAX_ID - Data mismatch related to tax id and its associated properties.
  • STOCK_SYMBOL - Non public entity registered as a public for profit entity or the stock information mismatch.
  • GOVERNMENT_ENTITY - Non government entity registered as a government entity. Must be a U.S. government entity.
  • NONPROFIT - No IRS 501c tax-exempt status found.
  • OTHERS - Details of the data misrepresentation if any.
SecurityBasicAuth or OAuth2
Request
path Parameters
projectId
required
string

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.

brandRegistrationId
required
string

The Brand Registration ID is returned in the response when creating the brand

Responses
200

A successful response.

Response Schema: application/json
brandId
string
Array of objects (v1alpha1Category)
400

INVALID_ARGUMENT: If the brandRegistrationId is not valid

404

Brand could not be found

429

Over limit

500

INTERNAL: Internal server error. Typically, a server bug.

get/v1/projects/{projectId}/brandRegistrations/{brandRegistrationId}/feedback
Request samples
Response samples
application/json
{
  • "brandId": "string",
  • "category": [
    • {
      }
    ]
}

Get Brand Details

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

SecurityBasicAuth or OAuth2
Request
path Parameters
projectId
required
string

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
brandId
required
string

Brand Id to be qualified

Responses
200

A successful response.

Response Schema: application/json
brandRegistrationId
string

Output only. Brand registration Id

brandId
string

Output only. TCR brand Id

identityStatus
string

Identity status for the brand.

displayName
string

Output only. Display name defined by user

brandRegistrationStatus
string (Brand Registration Status)
Default: "DRAFT"
  • 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
Enum: "DRAFT" "IN_PROGRESS" "REJECTED" "APPROVED" "UPGRADE"
brandRegistrationType
string (Brand Registration Type)
Default: "SIMPLIFIED"
  • 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.
Enum: "SIMPLIFIED" "FULL" "BRAND_REGISTRATION_TYPE_UNSPECIFIED"
object (Company Details)
object (Financial Details)
object (Contact Details)
mock
boolean

Defines if created brand should be mocked or real one

400

If the page_token, number_pattern or order_by is not valid

429

Over limit

get/v1/projects/{projectId}/brandRegistrations:fetchByTcrBrandId
Request samples
Response samples
application/json
{
  • "brandRegistrationId": "string",
  • "brandId": "string",
  • "identityStatus": "string",
  • "displayName": "string",
  • "brandRegistrationStatus": "DRAFT",
  • "brandRegistrationType": "SIMPLIFIED",
  • "companyDetails": {
    • "companyName": "string",
    • "companyEmail": "string",
    • "businessContactEmail": "string",
    • "brandName": "string",
    • "country": "string",
    • "streetAddress": "string",
    • "city": "string",
    • "postalCode": "string",
    • "state": "string",
    • "webAddress": "string"
    },
  • "financialDetails": {
    • "brandEntityType": "PUBLIC",
    • "brandVerticalType": "PROFESSIONAL",
    • "taxIdCountry": "string",
    • "taxIdCorporate": "string",
    • "stockSymbol": "string",
    • "exchange": "string"
    },
  • "contactDetails": {
    • "firstName": "string",
    • "lastName": "string",
    • "phoneNumber": "string",
    • "email": "string"
    },
  • "mock": true
}

Brand Registration Upgrade

Upgrades brand from SIMPLIFIED to FULL.

SecurityBasicAuth or OAuth2
Request
path Parameters
projectId
required
string

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.

brandRegistrationId
required
string

The Brand Registration ID is returned in the response when creating the brand

Responses
200

A successful response.

Response Schema: application/json
brandRegistrationId
string

Output only. Brand registration Id

brandId
string

Output only. TCR brand Id

identityStatus
string

Identity status for the brand.

displayName
string

Output only. Display name defined by user

brandRegistrationStatus
string (Brand Registration Status)
Default: "DRAFT"
  • 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
Enum: "DRAFT" "IN_PROGRESS" "REJECTED" "APPROVED" "UPGRADE"
brandRegistrationType
string (Brand Registration Type)
Default: "SIMPLIFIED"
  • 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.
Enum: "SIMPLIFIED" "FULL" "BRAND_REGISTRATION_TYPE_UNSPECIFIED"
object (Company Details)
object (Financial Details)
object (Contact Details)
mock
boolean

Defines if created brand should be mocked or real one

400

INVALID_ARGUMENT: If the brandRegistrationId is not valid

404

Brand could not be found

429

Over limit

500

INTERNAL: Internal server error. Typically, a server bug.

post/v1/projects/{projectId}/brandRegistrations/{brandRegistrationId}/upgrade
Request samples
Response samples
application/json
{
  • "brandRegistrationId": "string",
  • "brandId": "string",
  • "identityStatus": "string",
  • "displayName": "string",
  • "brandRegistrationStatus": "DRAFT",
  • "brandRegistrationType": "SIMPLIFIED",
  • "companyDetails": {
    • "companyName": "string",
    • "companyEmail": "string",
    • "businessContactEmail": "string",
    • "brandName": "string",
    • "country": "string",
    • "streetAddress": "string",
    • "city": "string",
    • "postalCode": "string",
    • "state": "string",
    • "webAddress": "string"
    },
  • "financialDetails": {
    • "brandEntityType": "PUBLIC",
    • "brandVerticalType": "PROFESSIONAL",
    • "taxIdCountry": "string",
    • "taxIdCorporate": "string",
    • "stockSymbol": "string",
    • "exchange": "string"
    },
  • "contactDetails": {
    • "firstName": "string",
    • "lastName": "string",
    • "phoneNumber": "string",
    • "email": "string"
    },
  • "mock": true
}

Brand Registration Vetting Information

Returns the vetting information of a brand registration. Include optional query parameters to filter results by vetting partner ID, vetting class, or status.

SecurityBasicAuth or OAuth2
Request
path Parameters
projectId
required
string

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.

brandRegistrationId
required
string

The Brand Registration ID is returned in the response when creating the brand

query Parameters
vettingStatus
required
string
Default: "ACTIVE"
Enum: "PENDING" "UNSCORE" "ACTIVE" "FAILED" "EXPIRED"
Responses
200

A successful response.

Response Schema: application/json
Array of objects (v1alpha1VettingInfo)
Array
vettingId
string
provider
string (v1alpha1VettingProvider)
Default: "AEGIS"
Value: "AEGIS"
vettingStatus
string (v1alpha1VettingStatus)
Default: "ACTIVE"
Enum: "PENDING" "UNSCORE" "ACTIVE" "FAILED" "EXPIRED"
vettingClass
string (v1alpha1VettingClass)
Default: "STANDARD"
Value: "STANDARD"
vettingToken
string
vettingScore
integer <int32>
reasons
Array of strings
object
vettedDate
string <date-time>
createDate
string <date-time>
400

INVALID_ARGUMENT: If the brandRegistrationId is not valid

404

Brand could not be found

429

Over limit

500

INTERNAL: Internal server error. Typically, a server bug.

get/v1/projects/{projectId}/brandRegistrations/{brandRegistrationId}/vettingInfo
Request samples
Response samples
application/json
{
  • "vettingInfo": [
    • {
      }
    ]
}

Resend 2FA Email

Resends the two-factor authentication email.

SecurityBasicAuth or OAuth2
Request
path Parameters
projectId
required
string

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.

bundleId
required
string

The ID of the bundle associated with the brand registration.

Responses
200

No response

post/v1/projects/{projectId}/brandRegistrations/{bundleId}/resend2faEmail
Request samples