Skip to content

List Brand Orders according to the filters applied.

Request

List Brand Orders, according to the filters applied. This endpoint allows filtering over all brands.

Security
OAuth2(Required scopes: read)
Path
projectIdstringrequired

Customer's project id

Query
statusArray of strings

The brand Order status to filter the brand orders.

metadataNamestring(BrandOrderMetadata)

Filter brand orders by brand registration process metadata name.

Enum ValueDescription
US_SC_REGISTRY

For US Short Code brand verification. This is a legacy manual process that is now disabled and read-only. New registrations are not possible through this process. For new Short Code registrations, please use US_SC_GCH.

US_SC_GCH

Unified US Short Code verification process via the US Short Code Registry. The specific process to be applied is automatically determined by the brand's programType field: Standard → standard process, Government → government process, Charitable Organization → charity process, Political → political process. This process is free of charge and, upon successful completion, the SHORT_CODE channel will be granted to the brand.

US_SC_GCH_CONTENT_PROVIDER

US Short Code verification process for Content Provider entities. This process internally uses the US Short Code Registry and is free of charge. Upon successful completion, the SHORT_CODE channel will be granted to the content provider.

US_10DLC_TCR_SOLE_PROPRIETOR

To register as a Sole Proprietor for 10-Digit Long Code (10DLC) messaging via 10DLC, you can complete the registration process without needing an Employer Identification Number (EIN). Upon initiating the registration, a One-Time Password (OTP) will be automatically sent to the provided mobile number for identity verification, which you must subsequently submit using the endpoint /v1/projects/{projectId}/us/brands/{brandId}/orders/{orderId}/verifyOtp to successfully authorize and finalize the process.

US_10DLC_TCR_PRIVATE_BRAND_REGISTRATION

Simple brand registration with 10DLC for private companies to obtain the 10DLC channel in the US. This process does not include vetting. You will receive a TCR ID upon completion (approx. 1 minute). Provides lower throughput and a maximum of 3 numbers. Once completed, this process can be re-requested if any data needs to be modified (there are some fields not allowed for edition: legalCompanyName, entityType, federalTaxId and taxCountry). This process can be initiated again for revetting the brand, in case that critical information needs to be updated: entityType, legalCompanyName, federalTaxId or taxCountry. In this case, the brand will go through the same process as a new registration, with the same time of completion, but keeping the same TCR ID and the history of previous registrations.

US_10DLC_TCR_PUBLIC_BRAND_REGISTRATION

Simple brand registration with 10DLC for public companies to obtain the 10DLC channel in the US. This process does not include vetting. You will receive a TCR ID upon completion (approx. 1 minutes). Provides lower throughput and a maximum of 3 numbers. Once completed, this process can be re-requested if any data needs to be modified (there are some fields not allowed for edition: legalCompanyName, entityType, federalTaxId and taxCountry). This process can be initiated again for revetting the brand, in case that critical information needs to be updated: entityType, legalCompanyName, federalTaxId or taxCountry. In this case, the brand will go through the same process as a new registration, with the same time of completion, but keeping the same TCR ID and the history of previous registrations.

US_10DLC_TCR_PRIVATE_BRAND_UPDATE

Brand data update process with 10DLC for private companies that already have the 10DLC channel. This process is used to update any brand data that needs to be modified after a successful registration, except for critical information such as entityType, legalCompanyName, federalTaxId or taxCountry. Cost: free. You will receive a confirmation of the update upon completion (approx. 1 minute). This process does not affect the TCR ID, the throughput or the number of phone numbers allowed. Update process cannot be used after standard or enhanced vetting, as the brand needs to be revetted in case of any critical information update.

US_10DLC_TCR_PUBLIC_BRAND_UPDATE

Brand data update process with 10DLC for public companies that already have the 10DLC channel. This process is used to update any brand data that needs to be modified after a successful registration, except for critical information such as entityType, legalCompanyName, federalTaxId or taxCountry. Cost: free. You will receive a confirmation of the update upon completion (approx. 1 minute). This process does not affect the TCR ID, the throughput or the number of phone numbers allowed. Update process cannot be used after standard or enhanced vetting, as the brand needs to be revetted in case of any critical information update.

US_10DLC_TCR_PRIVATE_MOCK

A free-of-charge mock process for private companies to test the 10DLC integration. Successfully completing this process does not grant the 10DLC channel but serves as a preliminary check to ensure that subsequent paid TCR registrations will be successful.

US_10DLC_TCR_PUBLIC_MOCK

A free-of-charge mock process for public companies to test the 10DLC integration. Successfully completing this process does not grant the 10DLC channel but serves as a preliminary check to ensure that subsequent paid TCR registrations will be successful.

US_10DLC_TCR_PRIVATE_STANDARD_BRAND_REGISTRATION

Initiates a standard brand registration with 10DLC for a private company, which involves an automated review of compliance history, employee count, and other business metrics. The process, which typically takes 5-10 days, is used to verify the brand and assign a vetting score from 0-100 that determines the brand's throughput level with network carriers. A successful registration provides higher throughput and allows for unlimited campaigns and numbers. Once completed, this process can be re-requested if any data not included in US_TCR_PATCH_BRAND needs to be modified. Once completed, this process can be re-requested if any data needs to be modified (there are some fields not allowed for edition: legalCompanyName, entityType, federalTaxId and taxCountry)

US_10DLC_TCR_PUBLIC_STANDARD_BRAND_REGISTRATION

Initiates a standard brand registration with 10DLC for a public company, which involves an automated review of compliance history, employee count, and other business metrics. The process, which typically takes 5-10 days, is used to verify the brand and assign a vetting score from 0-100 that determines the brand's throughput level with network carriers. A successful registration provides higher throughput and allows for unlimited campaigns and numbers. Once completed, this process can be re-requested if any data needs to be modified (there are some fields not allowed for edition: legalCompanyName, entityType, federalTaxId and taxCountry)

US_10DLC_TCR_PRIVATE_ENHANCED_BRAND_REGISTRATION

Initiates an enhanced brand registration for a private company, which is recommended if you are dissatisfied with your Standard vet score and believe a more thorough review could yield a higher rating. This process is designed to improve the brand's vetting score and potentially achieve better throughput. Please note that this enhanced vet can only be ordered after a STANDARD registration is complete.

US_10DLC_TCR_PUBLIC_ENHANCED_BRAND_REGISTRATION

Initiates an enhanced brand registration for a public company, which is recommended if you are dissatisfied with your Standard vet score and believe a more thorough review could yield a higher rating. This process is designed to improve the brand's vetting score and potentially achieve better throughput. Please note that this enhanced vet can only be ordered after a STANDARD registration is complete.

US_RCS_TCR_PRIVATE_BRAND_REGISTRATION

US RCS brand registration process with RCS for private companies. This process is used to verify a private brand for RCS in the US. Upon successful completion, the RCS channel will be granted to the brand.

US_RCS_TCR_PUBLIC_BRAND_REGISTRATION

US RCS brand registration process with RCS for public companies. This process is used to verify a public brand for RCS in the US. Upon successful completion, the RCS channel will be granted to the brand.

US_RCS_TCR_UPDATE_ASSETS

US RCS asset update process with RCS. This process is used to update the brand assets required for RCS, such as logos or banners, after the brand has already been registered.

sortstring

Sorting of the results using SQL-like syntax: comma-separated field names with an optional ':desc' or ':asc' suffix. Fields that support sorting are 'metadataName', 'status', 'createTime', 'updateTime'. Defaults to ascending order when no suffix is provided.

Example:sort=metadataName,status:desc
pageSizeinteger, (int32), [ 1 .. 100 ]

Size of the page to be returned. Default is 20. Maximum is 100.

Default:20
Example:pageSize=20
pageTokenstring

Page token to request subsequent pages when using pagination. This should be the value generated by the system in a previous list request.

curl -i -X GET \
  'https://compliance.api.sinch.com/v1/projects/{projectId}/us/orders?status=INCOMPLETE&metadataName=US_SC_REGISTRY&sort=metadataName%2Cstatus%3Adesc&pageSize=20&pageToken=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Headers
Bodyapplication/json
ordersArray of objects(BrandOrderSummary)read-only

List of brand orders

metaobject(PaginationMeta)

Pagination metadata.

Response
{ "orders": [ { … } ], "links": { "next": "https://compliance.api.sinch.com/v1/projects/proj-123/us/orders?pageToken=eyJsYXN0SWQiOiIyMTI0MjEifQ" }, "meta": { "totalCount": 15 } }
We'd love to hear from you!
Rate this content: