The Campaign Registry CSP API (7.8.0)

Downloads any file that is attached to an existing campaign, including MMS sample media files and supporting documents. To download, first determine the file’s uuid value from the appropriate GET endpoint and pass it in the attachmentId parameter. For example, to download a specific MMS sample media file, first use the GET /campaign/{campaignId}/mms endpoint to list the campaign’s attached files and see their uuid attributes.

Deletes any file that is attached to an existing campaign, including MMS sample media files and supporting documents. To delete a file, first find its uuid value from the appropriate GET endpoint and pass it in the attachmentId parameter. For example, to delete a specific MMS sample media file, first use the GET /campaign/{campaignId}/mms endpoint to list the campaign’s attached files and see their uuid attributes.

Retrieve a list of brands you have registered in TCR along with their properties. Supports any combination of parameters. If supplying state, country, or entityType parameters, only exact matches will be returned. If no parameters are specified, this operation will list all brands that you have registered. This operation supports pagination with a maximum of 500 records per fetch.

Retrieves brand feedback details using the unique identifier assigned to the brand. This endpoint can be invoked following new brand registration, an appeal, or following a revet. CSPs should only retrieve feedback details after the brand scoring process is complete (i.e., after receiving the BRAND_IDENTITY_STATUS_UPDATE webhook notification event). The following items may be returned in the Category ID property:

• TAX_ID: Tax ID does not match with the company name or business type.
• STOCK_SYMBOL: Not a public company, or the stock ticker and/or exchange does not match with the legal company name.
• GOVERNMENT_ENTITY: Not recognized as a government entity. Must be a U.S. government entity.
• NONPROFIT: IRS tax exempt subsection status not found.
• WEB_DOMAIN: Not valid or recognized email domain.

Registers a new brand under a CSP account. Required fields vary depending on the type of entity being registered. See the table below for details. Additional notes:

• For foreign government entities: The entityType property should be specified as PRIVATE_PROFIT. Only US-based organizations can use the GOVERNMENT entity type.
• For Public Profit brands: PUBLIC_PROFIT brands are required to enter a businessContactEmail which is subject to validation. Common email distribution addresses (such as sales@company.com) are not allowed, nor are personal or free email addresses. Following registration, the brand will undergo Authentication+ validation which requires the business contact to complete a 2FA process before being eligible for campaign registration.
• For Sole Proprietor brands: New SOLE_PROPRIETOR brand registration must comply with TCR’s stricter SP 2.0 field validations on the following fields: street, city, state, postalCode, country, email, phone, mobilePhone, firstName, lastName and displayName fields. SP 2.0 policy mandates that all sole proprietor brands must pass an SMS one-time-password (OTP) verification before being eligible for campaign registration.
• Mock EIN testing: To test brand registration with mock EINs in a CSP non-production environment such as Staging, please refer to the CSP Non-Production Integration Testing document.

Property Name	Description	Entity Requirements
displayName	Brand/Marketing/DBA name of the business. Max length: 255	SOLE_PROPRIETOR: Required PRIVATE PROFIT: Required PUBLIC_PROFIT: Required NON_PROFIT: Required GOVERNMENT: Required
companyName	The legal name of the business. Max length: 255	SOLE_PROPRIETOR: N/A PRIVATE PROFIT: Required PUBLIC_PROFIT: Required NON_PROFIT: Required GOVERNMENT: Required
ein	Tax ID of the business. Max length: 21	SOLE_PROPRIETOR: N/A PRIVATE PROFIT: Required PUBLIC_PROFIT: Required NON_PROFIT: Required GOVERNMENT: Required
einIssuingCountry	Two-letter ISO-2 country code of Tax ID issuing country. Examples: US, CA. Defaults to US. Length: 2	SOLE_PROPRIETOR: N/A PRIVATE PROFIT: Optional PUBLIC_PROFIT: Optional NON_PROFIT: Optional GOVERNMENT: Optional
altBusinessId	Alternative Business Identifier. A valid identifier that corresponds to the altBusinessIdType. Max length: 50	SOLE_PROPRIETOR: Optional PRIVATE PROFIT: Optional PUBLIC_PROFIT: Optional NON_PROFIT: Optional GOVERNMENT: Optional
altBusinessIdType	Alternative Business Identifier Type. Examples: DUNS, LEI, GIIN. Enumerated values	SOLE_PROPRIETOR: Optional PRIVATE PROFIT: Optional PUBLIC_PROFIT: Optional NON_PROFIT: Optional GOVERNMENT: Optional
firstName	First name of business contact. Max length: 100	SOLE_PROPRIETOR: Required PRIVATE PROFIT: N/A PUBLIC_PROFIT: N/A NON_PROFIT: N/A GOVERNMENT: N/A
lastName	Last name of business contact. Max length: 100	SOLE_PROPRIETOR: Required PRIVATE PROFIT: N/A PUBLIC_PROFIT: N/A NON_PROFIT: N/A GOVERNMENT: N/A
phone	Support contact telephone number in E.164 format. Example: +12023339999. Max length: 20	SOLE_PROPRIETOR: Required PRIVATE PROFIT: Required PUBLIC_PROFIT: Required NON_PROFIT: Required GOVERNMENT: Required
mobilePhone	Valid wireless telephone in E.164 format. Example: +12023339999. Max length: 20	SOLE_PROPRIETOR: Required for OTP PRIVATE PROFIT: N/A PUBLIC_PROFIT: N/A NON_PROFIT: N/A GOVERNMENT: N/A
street	House number and street name. Example: 1000 Sunset Hill Road. Max length: 255	SOLE_PROPRIETOR: Required PRIVATE PROFIT: Required PUBLIC_PROFIT: Required NON_PROFIT: Required GOVERNMENT: Required
city	City Name. Max length: 100	SOLE_PROPRIETOR: Required PRIVATE PROFIT: Required PUBLIC_PROFIT: Required NON_PROFIT: Required GOVERNMENT: Required
state	State or province. For addresses in the United States, please use the two-character state code. Example: CA for California. Max length 20	SOLE_PROPRIETOR: Required PRIVATE PROFIT: Required PUBLIC_PROFIT: Required NON_PROFIT: Required GOVERNMENT: Required
postalCode	Zipcode or postal code. Example: 21012 Max length: 10	SOLE_PROPRIETOR: Required PRIVATE PROFIT: Required PUBLIC_PROFIT: Required NON_PROFIT: Required GOVERNMENT: Required
country	Two-letter ISO-2 country code. Examples: US, CA. Length: 2	SOLE_PROPRIETOR: Required PRIVATE PROFIT: Required PUBLIC_PROFIT: Required NON_PROFIT: Required GOVERNMENT: Required
email	Email address of support contact. Max length: 100	SOLE_PROPRIETOR: Required PRIVATE PROFIT: Required PUBLIC_PROFIT: Required NON_PROFIT: Required GOVERNMENT: Required
stockSymbol	Stock symbol of the PUBLIC_PROFIT brand. Max length: 10	SOLE_PROPRIETOR: N/A PRIVATE PROFIT: N/A PUBLIC_PROFIT: Required NON_PROFIT: N/A GOVERNMENT: N/A
stockExchange	The stock exchange where the PUBLIC_PROFIT brand is registered. Enumerated values	SOLE_PROPRIETOR: N/A PRIVATE PROFIT: N/A PUBLIC_PROFIT: Required NON_PROFIT: N/A GOVERNMENT: N/A
website	The website/online URL address of the brand. Max length: 255	SOLE_PROPRIETOR: Optional PRIVATE PROFIT: Optional PUBLIC_PROFIT: Required NON_PROFIT: Optional GOVERNMENT: Optional
brandRelationship	The brand relationship level to the CSP. Enumerated values	SOLE_PROPRIETOR: N/A PRIVATE PROFIT: Required PUBLIC_PROFIT: Required NON_PROFIT: Required GOVERNMENT: Required
vertical	The industry segment where the brand operates. Enumerated values	SOLE_PROPRIETOR: Optional PRIVATE PROFIT: Required PUBLIC_PROFIT: Required NON_PROFIT: Required GOVERNMENT: Required
referenceId	A customer-unique identifier managed by the CSP that prevents duplicate brand registration in TCR. Case-insensitive, empty strings are ignored. Max length: 50	SOLE_PROPRIETOR: Required PRIVATE PROFIT: Optional PUBLIC_PROFIT: Optional NON_PROFIT: Optional GOVERNMENT: Optional
tag	Tags that can be set on the brand. Please refer to the Searchable Keyword Tag heading.	SOLE_PROPRIETOR: Optional PRIVATE PROFIT: Optional PUBLIC_PROFIT: Optional NON_PROFIT: Optional GOVERNMENT: Optional
mock	A boolean value that signifies a brand as a mock brand. Mock brands do not incur a billable charge on campaign registrations. Defaults to FALSE.	SOLE_PROPRIETOR: Optional PRIVATE PROFIT: Optional PUBLIC_PROFIT: Optional NON_PROFIT: Optional GOVERNMENT: Optional
businessContactEmail	Email of the business contact for the brand. Max length: 255	SOLE_PROPRIETOR: N/A PRIVATE PROFIT: Optional PUBLIC_PROFIT: Required NON_PROFIT: Optional GOVERNMENT: Optional

Retrieves a brand’s SMS one-time password (OTP) status by a CSP-managed referenceId value. This endpoint confirms that the OTP verification was successful and, potentially, its delivery status. If the verifyDate property is present in the response, then the OTP verification was successfully completed. Note: The deliveryStatus property is only provided if supported by the underlying SMS service provider and is not guaranteed to arrive in a timely manner or match the OTP verify status. The deliveryStatus property should only be used to facilitate SMS delivery troubleshooting. Possible values for the deliveryStatus property include:

• Null: The SMS service provider hasn't provided any SMS delivery status for the given transaction.
• IN_TRANSIT: SMS message delivery is in progress.
• DELIVERED_GATEWAY: The SMS message was delivered to a carrier gateway. This may be a final status depending on the destination network.
• DELIVERED_HANDSET: The SMS message was delivered to the mobile device. This is a final status. No further updates will be provided.
• FAILED_ROUTING: The SMS message can’t be routed based on the provided phone number. This is a final error status. No further updates will be provided.
• FAILED_BLOCKED: The SMS message was blocked by a service provider or mobile network. This is a final error status. No further updates will be provided.
• FAILED_EXPIRED: The SMS message expired during delivery. This is a final error status. No further updates will be provided.
• FAILED_UNKNOWN: An unknown failure occurred. This is a final error status. No further updates will be provided.
• UNKNOWN_STATUS: The status was not recognized by TCR. Refer to the deliveryStatusDetails property for more information.

Get an existing brand record from TCR by specifying the brand’s unique identifier.

Allows a CSP to update an existing brand’s properties in the TCR system. Modifying some properties will change a brand’s identity status to UNVERIFIED and require resubmission using the PUT /brand/{brandId}/revet endpoint. Refer to the table below for additional information. Additional notes:

• For Public Profit brands: Updating the businessContactEmail will revoke a brand’s Auth+ compliance. The brand must request a new Auth+ vet to regain compliance. During this process, the business contact must reply to a 2FA email.
• Updating a brand’s mobilePhone field will change a brand’s identity status to UNVERIFIED.

Properties	Description	Resubmission required
companyName, ein, einIssuingCountry, entityType	An update is allowed if the brand has no external vets and no active campaigns. Modifying these fields will change the brand identity status to UNVERIFIED.	Yes
firstName, lastName, displayName, website, street, city, state, postalCode, country, email, referenceId, phone, vertical, stockSymbol, stockExchange, altBusinessId, altBusinessIdType	Updating these fields do not require resubmission.	Optional
brandRelationship	Can only be updated once every 3 months.	Optional
businessContactEmail	Updating this field will revoke a Public Profit brand’s Auth+ compliance.	No

Changes a brand to a DELETED status. A brand record can only be deleted if it does not have any active campaigns associated with it. Once a brand is deleted, it cannot be restored to an ACTIVE status. Deleted brands will remain in TCR for a TBD period of time and can be searched using the GET /brand endpoint with a query filter of 'status' = DELETED. The GET /brand/{brandId} endpoint will also return deleted brands.

Resends a 2FA email for a brand that has not completed Authentication+ or RCS verification. Used if a brand business contact has lost their original 2FA email or if the email has expired. Can only be triggered if the brand initiated the 2FA verification process within the last 30 days. If multiple 2FA emails are sent to the same email address, TCR will rate limit the sending to one every two hours. Refer to the Authentication+ documentation for more information.

Returns a list of all identity status appeals associated with a brand ID. Results can be limited by appeal status.

Allows a CSP to appeal the results of a brand’s identity status. This is used if the basic identity check was unsuccessful or did not properly return a necessary brand optionalAttribute that grants access to additional use cases. Attachments should be added to include documentation that justifies the appeal. For detailed information, please refer to Brand Vetting Appeals.

Retrieves a list of all appeal evidence files attached to a specified brand. These evidence files could have been used as part of an external vet appeal, identity status appeal, etc. See the Attachment group for API information on downloading and deleting attachments on a brand record.

Adds appeal evidence files to a specified brand. These evidence files can be used as part of an external vet appeal, identity status appeal, etc. See the Attachment group for API information on downloading and deleting attachments on a brand record.

Retrieves all external vetting records associated with a brand ID. Records can be queried by an external vetting partner ID, vetting class, or status.

This endpoint is used to import an external vetting record from a TCR-approved vetting partner. If the vetting partner confirms the validity of the record, it will be saved with the brand and used for future campaign qualification. The request body must contain the following properties:

• evpId: The vetting partner ID.
• vettingId: The unique value of the vetting transactionId.

Note: Import is not supported for the AUTHPLUS vetting class.

An optional vettingToken field may be required by the vetting partner. Refer to the table below for full details.

Vetting Provider	EvpId	Vetting ID Property	Vetting Token	Notes
Aegis Mobile	AEGIS	ID	Required. Referred to as the Verification Certificate.	Supports STANDARD, POLITICAL, and ENHANCED vetting classes. Validation Rules: During import, the following properties must match between the Aegis report and the TCR brand: Legal Name Entity Type
Campaign Verify	CV	Authorization Token	N/A	Only supports the POLITICAL vetting class. Validation Rules: The brand must be a US-based NON_PROFIT entity type without a 501(c) tax exempt status. Must be a unique token per brand and CSP.
WMC Global	WMC	Transaction ID	N/A	Only supports the STANDARD vetting class. Validation Rules: The brand must be a US-based PRIVATE_PROFIT or PUBLIC_PROFIT entity type.

Places an order for an external vet via a TCR-approved vetting provider. For detailed instructions, see the External Vetting Requests Using the CSP API document. To generate a mock vetting token for use in a CSP non-production testing environment, see the POST /brand/{brandId}/externalVetting/mockCvToken endpoint. For more information, see the Non-Production Integration Testing document.

Note: For RCS vets, you must wait 30 days from vet completion before requesting a new one.

Returns a list of all external vetting appeals associated with a brand ID. You can limit the results by vetting partner, vetting id, and status. If no appeals exist for a brand, then no results will be returned.

Allows a CSP to appeal a previously submitted external vet. This is used if the external vet did not return a brand optionalAttribute that grants access to additional use cases. It can also be used to appeal an external vet if the brand feels the outcome was incorrect, which can lead to lower throughput terms with network carriers. Attachments should be added to include documentation that justifies the appeal. For detailed information, please refer to Brand Vetting Appeals.

Retrieves the enhanced vetting reports that are associated with a brand ID.

Revetting a brand is necessary if a CSP changes brand information following initial registration. The revet verifies the brand’s identity through a external vetting provider. If successful, the brand’s identity status is changed to VERIFIED (or VETTED_VERIFIED in some instances). Revets should only be used to validate changes to brand information following a successful registration (or to correct information if, for example, an incorrect EIN was entered). If a brand wants to verify attributes that don’t appear after registration (such as a missing tax exempt status or government entity flag), they should submit a brand appeal and submit additional documentation to support their claim.

Only used for SOLE_PROPRIETOR entity types. Verifies a one-time password (OTP) sent to the brand’s mobilePhone property. Upon successful OTP verification, the brand is allowed to register campaigns. Additional Information

• Sole Proprietor OTP PINs expire after 24 hours.
• Resending an OTP can only be done by the CSP. API users can use the PUT /brand/smsOTP endpoint.
• Upon completion of OTP verification:
  • A CSP will receive a BRAND_OTP_VERIFIED webhook event.
  • The brand’s identity status will change to VERIFIED.

Only used for SOLE_PROPRIETOR entity types. Triggers the generation of a one-time password (OTP) sent to the mobilePhone number specified in a brand’s profile. Only valid for US and Canadian phone numbers that support SMS text messaging. OTP messages are sent from an A2P 10DLC phone number managed by TCR. OTP verification is required as part of the brand registration process for SOLE_PROPRIETOR entity types. Campaigns cannot be created until OTP verification is complete. CSPs can customize the pinSms and successSms messages to fit their business needs, including the ability to trigger a second SMS message to the OTP recipient upon successful OTP verification. Testing Without a US/Canadian Wireless Number Developers can register a brand via the CSP API with the attribute mock set to true. When this attribute is enabled, all SMS OTP messages will be redirected via a webhook with an event type of BRAND_MOCK_OTP. The OTP PIN will be visible in the webhook payload under the property name otpPin. For more information on how to subscribe to webhooks generated by TCR, please see the Webhook section of the CSP API.

Returns a list of brand assets associated with a specified brand. Optional filters can narrow results by the type or name. Response includes the attachmentUuid as well as verification information such as feedback reasons and expiration date (if applicable).

Uploads a new brand asset to a specified brand. The following business rules apply:

• Request body must contain a type of LOGO or BANNER.
• The associated brand cannot be a SOLE_PROPRIETOR.
• Only alphanumeric names are accepted. Spaces, dashes, and underscore characters are also allowed within the name, but leading and trailing spaces are not.
• Assets must have a unique name within the brand.
• Assets must be in the appropriate format (JEPG, JPG or PNG), dimensions (1440 x 448px for banners and 224 x 224px for logos), and within the allowed size (200 KB for banners and 50 KB for logos).
• Up to 50 banners and 50 logos are allowed (for a total of 100 assets) per brand.

Permanently deletes an existing brand asset record from a specified brand. Brand assets cannot be deleted if their verification status is PENDING, VERIFIED, or if they are associated with an active RCS campaign.

Returns a list of all verification appeals associated with a brand ID and brand asset name. Results can be limited by submitting an optional appeal status.