Download OpenAPI specification:Download
Create a 10DLC brand registration at TCR (The Campaign Registry). There are 2 types of registrations:
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. |
The request body to of the brand to be created
{ }
{- "brandRegistrationId": "string"
}
Lists all brand registrations per project.
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. |
{- "brandRegistrations": [
- {
- "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
}
], - "nextPageToken": "string",
- "totalSize": 0
}
Get brand registration details using brand registration ID when creating a brand.
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 |
A successful response.
If the page_token, number_pattern or order_by is not valid
Over limit
{- "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
}
Update Brand Registration details
object (Company Details) | |
object (Financial Details) | |
object (Contact Details) |
A successful response.
INVALID_ARGUMENT: If the brandRegistrationId is not valid
Brand could not be found
Over limit
INTERNAL: Internal server error. Typically, a server bug.
{ }
{- "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
}
Returns feedback information for brand registrations that were rejected. Following are the applicable category IDs:
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 |
{- "brandId": "string",
- "category": [
- {
- "id": "string",
- "displayName": "string",
- "description": "string",
- "fields": [
- "string"
]
}
]
}
Get the US 10DLC brand details using the TCR brand ID.
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. |
A successful response.
If the page_token, number_pattern or order_by is not valid
Over limit
{- "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
}
Upgrades brand from SIMPLIFIED
to FULL
.
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 |
A successful response.
INVALID_ARGUMENT: If the brandRegistrationId is not valid
Brand could not be found
Over limit
INTERNAL: Internal server error. Typically, a server bug.
{- "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
}
Returns the vetting information of a brand registration. Include optional query parameters to filter results by vetting partner ID, vetting class, or status.
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 |
A successful response.
INVALID_ARGUMENT: If the brandRegistrationId is not valid
Brand could not be found
Over limit
INTERNAL: Internal server error. Typically, a server bug.
{- "vettingInfo": [
- {
- "vettingId": "string",
- "provider": "AEGIS",
- "vettingStatus": "PENDING",
- "vettingClass": "STANDARD",
- "vettingToken": "string",
- "vettingScore": 0,
- "reasons": [
- "string"
], - "vettingDetails": {
- "property1": "string",
- "property2": "string"
}, - "vettedDate": "2019-08-24T14:15:22Z",
- "createDate": "2019-08-24T14:15:22Z"
}
]
}
Resends the two-factor authentication email.
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. |
No response