OVERVIEW
The Campaign Registry (TCR) data model contains 3 key entities:
- Campaign Service Provider (CSP), who is contracted with Direct Connect Aggregator (DCA or 0-Hop)) and TCR. CSP is typically the party hosting the campaign on its own technology platform like Teli.
- Brand is the legal entity or role responsible for the messaging content in a campaign. A brand depends on the CSP for submitting a campaign request to TCR. TCR will perform Cyber and Identity verifications against every brand registered by CSP.
- Campaign is an encompassing entity that ties together the who (CSP and Brand) and the what (Use Case) for all 10DLC messaging campaigns. A campaign can only be submitted by the CSP.
A unique identifier is assigned to each above-referenced entity. CSP, Brand, and Campaign are assigned unique 7-char upper alphanumeric identity prefixed with the letter 'S', 'B' and 'C' respectively. These identities are used throughout all API operations.
When a Non-Sole Prop brand is registered, TCR will attempt to verify the identity of the brand based on the supplied information. The brand is assigned a
VERIFIED or UNVERIFIED status upon registration completion. If the brand has the UNVERIFIED identity status, then the brand will not qualify to run campaign on any MNO network.Levels of Brand Identity Statuses
- SELF_DECLARED Applicable to Sole-Proprietor entity type. TCR does not make attempt to verify the brand information.
- UNVERIFIED TCR is unable to verify or identify the existence of the brand. An UNVERIFIED brand is not permitted to run a 10DLC campaign.
- VERIFIED TCR is able to verify the information and identify the existence of the organisation. A VERIFIED brand is permitted to run standard 10DLC campaigns across all MNO networks.
- VETTED_VERIFIED Brand with an external STANDARD class vet. A VETTED_VERIFIED brand may potentially gain access to higher throughput and additional use-cases across some MNO networks.
If a brand is assigned an UNVERIFIED status, the CSP can make corrections based on the hints from the brand feedback API. The below table summarises the possible brand feedback issues by entity type and potential course of actions:
Entity Type | Potential causes for UNVERIFIED status | Recourse |
|---|---|---|
PRIVATE_PROFIT | Invalid ein, or mismatch between ein and company_name. | 1)Revet w/ correction. 2)External vet with correction. |
PUBLIC_PROFIT | Invalid ein, or mismatch between ein and company_name. | 1)Revet w/ correction. 2)External vet with correction. |
NON_PROFIT | Invalid ein, mismatch between ein and company_name. | 1)Revet w/ correction. 2)External vet with correction. |
GOVERNMENT | Invalid ein, mismatch between ein and company_name. | 1)Revet w/ correction. 2)External vet with correction. |
SOLE_PROPRIETOR | -- Not applicable -- | -- Not applicable -- |
Brand optional attributes are a collection of non-standard attributes applicable to some brands based on characteristics not limited to entity types. The brand optional attributes (optionalAttributes) is a property of Brand object. Some examples of optional attributes:
- russell3000 Recognizes public companies that are in the Russell 3000 index. The said brand may be granted higher throughput on some MNO networks.
- taxExemptStatus Identifies the tax-exempt 501c status for a non-profit brand. A '501c3' status is mandatory for accessing CHARITY use-case on some MNO networks.
- politicalCommitteeLocale Political committee Locale identified by a Campaign Verify vet. Possible values are federal, state, local and tribal.
- section527 Section 527 status identified by a Campaign Verify vet. A 527 group is a type of U.S. tax-exempt organization organized under Section 527 of the U.S. Internal Revenue Code. The said brand may be granted higher throughput on some MNO networks.
- governmentEntity Confirmation that the brand is a closely affiliated, generally by government ownership or control, with federal, state or local governments. The said brand may be granted higher throughput on some MNO networks.
The list of defined optional attributes can be retrieved through the
GET enum/optionalattributename API endpoint.
Some special campaign use-cases require the brand to be vetted by a participating vetting provider. TCR can either accept existing vetting records from a TCR approved vetting provider, or accept a new vetting request to be placed via an API call. The steps for both workflows are detailed as follow:
Existing Vet
- 1.Create a brand.
- 2.Make the
/brand/vetting/importAPI call to confirm the vetting credentialevp_id(Vetting Identifier) and optionally required for some vetting provider thevetting_tokenare passed into the API call. This API call will return synchronously with the latest vetting record status.
Order New External Vet
- 1.Create a brand.
- 2.Make the
/brand/vetting/orderAPI call to initiate a brand vetting through the desired EVP. This API call is not expected to return vetting results. - 3.Vetting results may take anywhere from 30 seconds to 24 hours depending on the vetting provider. When the vetting provider completes vetting, the results are recorded in TCR. Vetting status can either be pushed to you via web hook or retrieved via List vettings API call.
Here are some business rules around brand deletion:
- Brand deletion is an irreversible action.
- Brand can be deleted if the brand does not have any active campaigns.
Brand without a business EIN can be registered into TCR under the new SOLE_PROPRIETOR entity designation. Here are some key limitations of SOLE_PRPRIETOR entity type:
- Has lower message throughput.
- Is limited to a single campaign of SOLE_PROPRIETOR use-case, supporting mixed messaging content.
- Is limited to 5 10DLC numbers provisioned to the campaign.
- Is not eligible for external vet to gain higher messaging throughput.
- 1.Register brand: Every campaign must be associated with a brand.
- 2.Register campaign: This is done using the Create Campaign API. Most registered brands will qualify for a majority of standard campaign use-cases. There are some special use-cases that require proof of brand-vetting and/or Mobile Network Operator (MNO) approval. TCR can track campaign approval status across individual participating MNO networks. Customers can pull (via API call) and/or receive push (via webhook) on campaign MNO operation status changes.
- 3.Number assignment: Customer assigns phone number to campaign.
- 4.Sunset campaign: Campaign registration is paid on a quarterly basis. Customer can cancel auto-renewal or deactivate to terminate the campaign immediately.
Last modified 1yr ago