All URIs are relative to /v1
| Method | HTTP request | Description |
|---|---|---|
| createBrand | POST /brand | Create new Brand (Blocking) |
| createBrandNonBlocking | POST /brand/nonBlocking | Create new Brand (Non-Blocking) |
| deleteBrand | DELETE /brand/{brandId} | Delete brand |
| getBrand | GET /brand/{brandId} | Get existing Brand by ID |
| getBrandFeedback | GET /brand/feedback/{brandId} | Get brand feedback by ID |
| importBrandExternalVetting | PUT /brand/{brandId}/externalVetting | Import external vetting record |
| listBrands | GET /brand | Search brands |
| listExternalVettings | GET /brand/{brandId}/externalVetting | Get list of external vetting record for a given brand |
| orderBrandExternalVetting | POST /brand/{brandId}/externalVetting | Order new external vetting for a brand |
| revetBrand | PUT /brand/{brandId}/revet | Revet the brand |
| updateBrand | PUT /brand/{brandId} | Update brand properties |
\TCR\Client\Model\Brand createBrand($body)
Create new Brand (Blocking)
Register a brand under your CSP account. Mandatory fields vary depending on the type of entity being registered. See the following table for details..
(GOVERNMENT entity type is for US government entity only. Please use PRIVATE_PROFIT for non-US government entity.) <table style="float: left;" border="1"> <tr style="height: 61px;"> <th style="height: 61px;">Property Name <th style="height: 61px;">Description <th style="height: 61px;">Validation <th style="height: 61px;">
Entity
SOLE_PROPRIETOR
<th style="height: 61px;">Entity
PRIVATE_PROFIT
<th style="height: 61px;">Entity
PUBLIC_PROFIT
<th style="height: 61px;">Entity
NON_PROFIT
<th style="height: 61px;">Entity
GOVERNMENT
<tr style="height: 21px;"> <td style="height: 21px;">displayName <td style="height: 21px;">Brand/Marketing/DBA name of the business <td style="height: 21px;">Max length 255 <td style="height: 21px;">Required <td style="height: 21px;">Required <td style="height: 21px;">Required <td style="height: 21px;">Required <td style="height: 21px;">Required <tr style="height: 21px;"> <td style="height: 21px;">companyName <td style="height: 21px;">The legal name of the business <td style="height: 21px;">Max length 255 <td style="height: 21px;">N/A <td style="height: 21px;">Required <td style="height: 21px;">Required <td style="height: 21px;">Required <td style="height: 21px;">Required <tr style="height: 21px;"> <td style="height: 21px;">ein <td style="height: 21px;">Tax ID of the business <td style="height: 21px;">Max length 21 <td style="height: 21px;">N/A <td style="height: 21px;">Required <td style="height: 21px;">Required <td style="height: 21px;">Required <td style="height: 21px;">Required <tr style="height: 21px;"> <td style="height: 21px;">einIssuingCountry <td style="height: 21px;">2 letter ISO-2 country code of Tax ID issuing country. E.g. US, CA <td style="height: 21px;">Default to country. Length 2. <td style="height: 21px;">N/A <td style="height: 21px;">Optional <td style="height: 21px;">Optional <td style="height: 21px;">Optional <td style="height: 21px;">Optional <tr style="height: 21px;"> <td style="height: 21px;">altBusinessIdType <td style="height: 21px;">Alternative Business Identifier Type. e.g. DUNS, LEI, GIIN. <td style="height: 21px;">Enumerated values <td style="height: 21px;">Optional <td style="height: 21px;">Optional <td style="height: 21px;">Optional <td style="height: 21px;">Optional <td style="height: 21px;">Optional <tr style="height: 21px;"> <td style="height: 21px;">altBusinessId <td style="height: 21px;">Alternative Business Identifier <td style="height: 21px;">Max length 50 <td style="height: 21px;">Optional <td style="height: 21px;">Optional <td style="height: 21px;">Optional <td style="height: 21px;">Optional <td style="height: 21px;">Optional <tr style="height: 21px;"> <td style="height: 21px;">firstName <td style="height: 21px;">First name of business contact <td style="height: 21px;">Max length 100 <td style="height: 21px;">Required <td style="height: 21px;">N/A <td style="height: 21px;">N/A <td style="height: 21px;">N/A <td style="height: 21px;">N/A <tr style="height: 21px;"> <td style="height: 21px;">lastName <td style="height: 21px;">Last name of business contact <td style="height: 21px;">Max length 100 <td style="height: 21px;">Required <td style="height: 21px;">N/A <td style="height: 21px;">N/A <td style="height: 21px;">N/A <td style="height: 21px;">N/A <tr style="height: 41px;"> <td style="height: 41px;">phone <td style="height: 41px;">The support contact telephone in e.164 format. E.g. +12023339999 <td style="height: 21px;">Max length 20 <td style="height: 41px;">Required <td style="height: 41px;">Required <td style="height: 41px;">Required <td style="height: 41px;">Required <td style="height: 41px;">Required <tr style="height: 21px;"> <td style="height: 21px;">street <td style="height: 21px;">Street name and house number. E.g. 1000 Sunset Hill Road <td style="height: 21px;">Max length 100 <td style="height: 21px;">Required <td style="height: 21px;">Required <td style="height: 21px;">Required <td style="height: 21px;">Required <td style="height: 21px;">Required <tr style="height: 21px;"> <td style="height: 21px;">city <td style="height: 21px;">City name <td style="height: 21px;">Max length 100 <td style="height: 21px;">Required <td style="height: 21px;">Required <td style="height: 21px;">Required <td style="height: 21px;">Required <td style="height: 21px;">Required <tr style="height: 41px;"> <td style="height: 41px;">state <td style="height: 41px;">State or province. For the United States, please use 2 character codes. E.g. 'CA' for California. <td style="height: 21px;">Max length 20 <td style="height: 41px;">Required <td style="height: 41px;">Required <td style="height: 41px;">Required <td style="height: 41px;">Required <td style="height: 41px;">Required <tr style="height: 21px;"> <td style="height: 21px;">postalCode <td style="height: 21px;">Zipcode or postal code. E.g. 21012 <td style="height: 21px;">Max length 10 <td style="height: 21px;">Required <td style="height: 21px;">Required <td style="height: 21px;">Required <td style="height: 21px;">Required <td style="height: 21px;">Required <tr style="height: 21px;"> <td style="height: 21px;">country <td style="height: 21px;">2 letter ISO-2 country code. E.g. US, CA <td style="height: 21px;">Length 2 <td style="height: 21px;">Required <td style="height: 21px;">Required <td style="height: 21px;">Required <td style="height: 21px;">Required <td style="height: 21px;">Required <tr style="height: 21px;"> <td style="height: 21px;">email <td style="height: 21px;">The email address of support contact <td style="height: 21px;">Max length 100 <td style="height: 21px;">Required <td style="height: 21px;">Required <td style="height: 21px;">Required <td style="height: 21px;">Required <td style="height: 21px;">Required <tr style="height: 21px;"> <td style="height: 21px;">stockSymbol <td style="height: 21px;">The stock symbol of the brand <td style="height: 21px;">Max length 10 <td style="height: 21px;">N/A <td style="height: 21px;">N/A <td style="height: 21px;">Required <td style="height: 21px;">N/A <td style="height: 21px;">N/A <tr style="height: 21px;"> <td style="height: 21px;">stockExchange <td style="height: 21px;">The stock exchange of the brand <td style="height: 21px;">Enumerated values <td style="height: 21px;">N/A <td style="height: 21px;">N/A <td style="height: 21px;">Required <td style="height: 21px;">N/A <td style="height: 21px;">N/A <tr style="height: 21px;"> <td style="height: 21px;">website <td style="height: 21px;">The website of the business <td style="height: 21px;">Max length 100 <td style="height: 21px;">Optional <td style="height: 21px;">Optional <td style="height: 21px;">Optional <td style="height: 21px;">Optional <td style="height: 21px;">Optional <tr style="height: 41px;"> <td style="height: 41px;">brandRelationship <td style="height: 41px;">Brand relationship level assessed by CSP <td style="height: 21px;">Enumerated values <td style="height: 41px;">N/A <td style="height: 41px;">Required <td style="height: 41px;">Required <td style="height: 41px;">Required <td style="height: 41px;">Required <tr style="height: 21px;"> <td style="height: 21px;">vertical <td style="height: 21px;">The segment in which the business operates in <td style="height: 21px;">Enumerated values <td style="height: 21px;">Optional <td style="height: 21px;">Required <td style="height: 21px;">Required <td style="height: 21px;">Required <td style="height: 21px;">Required <tr style="height: 21px;"> <td style="height: 21px;">referenceId <td style="height: 21px;">Customer unique identifier for preventing duplicate brand registration into TCR. Case-insensitive, empty string ignored. <td style="height: 21px;">Max length 50 <td style="height: 21px;">Required <td style="height: 21px;">Optional <td style="height: 21px;">Optional <td style="height: 21px;">Optional <td style="height: 21px;">Optional <tr style="height: 21px;"> <td style="height: 21px;">tag <td style="height: 21px;">Tags to be set on the Brand. <td style="height: 21px;">Please refer to the Searchable Keyword Tag <td style="height: 21px;">Optional <td style="height: 21px;">Optional <td style="height: 21px;">Optional <td style="height: 21px;">Optional <td style="height: 21px;">Optional <tr style="height: 21px;"> <td style="height: 21px;">mock <td style="height: 21px;">If true, marks the brand as a 'mock' brand that does not incur a billable charge on brand subsequent campaign registration. <td style="height: 21px;">Default to false <td style="height: 21px;">Optional <td style="height: 21px;">Optional <td style="height: 21px;">Optional <td style="height: 21px;">Optional <td style="height: 21px;">Optional<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: myBasicAuthSecurity
$config = TCR\Client\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
$apiInstance = new TCR\Client\Api\BrandApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$body = new \TCR\Client\Model\BrandRequest(); // \TCR\Client\Model\BrandRequest | Brand to be created
try {
$result = $apiInstance->createBrand($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling BrandApi->createBrand: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| body | \TCR\Client\Model\BrandRequest | Brand to be created |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\TCR\Client\Model\Brand createBrandNonBlocking($body)
Create new Brand (Non-Blocking)
This is the non-blocking version of the brand registration API call. Compared to the blocking version, this API call returns much faster because it does not wait for the initial brand scoring task, which can take more than 10 seconds to complete. The non-blocking version is suitable for an off-line process to register brands in bulk. Since the CSP cannot proceed to register a campaign for an 'unscored' brand, the CSP must wait for the BRAND_SCORE_UPDATE webhook notification event.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: myBasicAuthSecurity
$config = TCR\Client\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
$apiInstance = new TCR\Client\Api\BrandApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$body = new \TCR\Client\Model\BrandRequest(); // \TCR\Client\Model\BrandRequest | Brand to be created
try {
$result = $apiInstance->createBrandNonBlocking($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling BrandApi->createBrandNonBlocking: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| body | \TCR\Client\Model\BrandRequest | Brand to be created |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deleteBrand($brand_id)
Delete brand
This operation deletes a brand. A brand can be deleted if it does not have active campaigns. Once a brand is deleted the brand is in a DELETED state, and the brand cannot be restored to an ACTIVE state. Deleted brands will remain in the system for a period of TBD time and it can be searched using the GET /brand endpoint with query filter 'status' = ACTIVE. While deleted brands are searchable, all other API endpoints involving a deleted brand will result in a '502' - "Brand not found" error.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: myBasicAuthSecurity
$config = TCR\Client\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
$apiInstance = new TCR\Client\Api\BrandApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$brand_id = "brand_id_example"; // string | Brand alphanumeric identifier (prefixed with letter 'B')
try {
$apiInstance->deleteBrand($brand_id);
} catch (Exception $e) {
echo 'Exception when calling BrandApi->deleteBrand: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| brand_id | string | Brand alphanumeric identifier (prefixed with letter 'B') |
void (empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\TCR\Client\Model\BrandCSP getBrand($brand_id)
Get existing Brand by ID
Retrieve the brand record from TCR by the unique identifier assigned to the brand.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: myBasicAuthSecurity
$config = TCR\Client\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
$apiInstance = new TCR\Client\Api\BrandApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$brand_id = "brand_id_example"; // string | Brand alphanumeric identifier (prefixed with letter 'B')
try {
$result = $apiInstance->getBrand($brand_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling BrandApi->getBrand: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| brand_id | string | Brand alphanumeric identifier (prefixed with letter 'B') |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\TCR\Client\Model\BrandFeedbackCSP getBrandFeedback($brand_id)
Get brand feedback by ID
Retrieve the brand feedback details by the unique identifier assigned to the brand. Invoke this API after the brand creation/revet. For the blocking version of brand creation/revet, retrieve feedback details immediately. For the non-blocking version of brand creation/revet, retrieve feedback details after the brand scoring task is complete, which means CSP must wait for the BRAND_SCORE_UPDATE webhook notification event. 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.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: myBasicAuthSecurity
$config = TCR\Client\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
$apiInstance = new TCR\Client\Api\BrandApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$brand_id = "brand_id_example"; // string | Brand alphanumeric identifier (prefixed with letter 'B')
try {
$result = $apiInstance->getBrandFeedback($brand_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling BrandApi->getBrandFeedback: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| brand_id | string | Brand alphanumeric identifier (prefixed with letter 'B') |
\TCR\Client\Model\BrandFeedbackCSP
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\TCR\Client\Model\ExternalVetting importBrandExternalVetting($body, $brand_id)
Import external vetting record
This operation can be used to import external vetting record from a TCR approved vetting provider. If vetting provider confirms validity of the vetting record, the vetting record will be saved with the brand in the TCR and the vetting record will be considered for future campaign qualification. The JSON request body must contain valid 'evpId', the identity of the vetting provider and the 'vettingId', the unique ID of the vetting transaction. The 'vettingToken' field is required by some vetting provider.<table style="float: left;" border="1"> <tr style="height: 61px;"> <th style="height: 61px;" rowspan="2">Vetting Provider <th style="height: 61px; width: 61px;" rowspan="2">Evp Id <th style="height: 61px;" colspan="2">Vetting ID <th style="height: 61px;" colspan="2">Vetting Token <th style="height: 61px;" rowspan="2">Supported Vetting Class <th style="height: 61px;" rowspan="2">Notes <tr style="height: 16px;"> <th style="height: 50px;">Alias <th style="height: 50px;">Requirement <th style="height: 50px;">Alias <th style="height: 50px;">Requirement <tr style="height: 21px;"> <td style="height: 21px;">Aegis Mobile <td style="height: 21px;">AEGIS <td style="height: 21px;">ID <td style="height: 21px;">Required <td style="height: 21px;">Verification Certificate <td style="height: 21px;">Required <td style="height: 21px;">STANDARD <td style="height: 21px;">Following requirements are checked by TCR when importing an Aegis report:
- The legal name from Aegis's report and that of the TCR brand must match
- The entity type from Aegis's report and that of the TCR brand must match <tr style="height: 21px;"> <td style="height: 21px;">Campaign Verify <td style="height: 21px;">CV <td style="height: 21px;">Authorization Token <td style="height: 21px;">Required <td style="height: 21px;">N/A <td style="height: 21px;">N/A <td style="height: 21px;">POLITICAL <td style="height: 21px;">Following requirements are checked by TCR when importing a Campaign Verify report:
- Brand must be a US-based, NON_PROFIT entity type without a 501c (tax-exempt) status
- Unique CV token required for each brand. In another word, A CV token cannot be imported into two TCR brands even if they are under different CSP accounts <tr style="height: 21px;"> <td style="height: 21px;">WMC Global <td style="height: 21px;">WMC <td style="height: 21px;">Transaction ID <td style="height: 21px;">Required <td style="height: 21px;">N/A <td style="height: 21px;">N/A <td style="height: 21px;">STANDARD <td style="height: 21px;">Following requirements are checked by TCR when importing a WMC report:
- Brand must be a US-based and PRIVATE_PROFIT or PUBLIC_PROFIT entity type
<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure HTTP basic authorization: myBasicAuthSecurity $config = TCR\Client\Configuration::getDefaultConfiguration() ->setUsername('YOUR_USERNAME') ->setPassword('YOUR_PASSWORD'); $apiInstance = new TCR\Client\Api\BrandApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); $body = new \TCR\Client\Model\ExternalVettingImportRequest(); // \TCR\Client\Model\ExternalVettingImportRequest | External vetting record to be imported for a given brand $brand_id = "brand_id_example"; // string | Brand alphanumeric identifier (prefixed with letter 'B') try { $result = $apiInstance->importBrandExternalVetting($body, $brand_id); print_r($result); } catch (Exception $e) { echo 'Exception when calling BrandApi->importBrandExternalVetting: ', $e->getMessage(), PHP_EOL; } ?>
Name Type Description Notes body \TCR\Client\Model\ExternalVettingImportRequest External vetting record to be imported for a given brand brand_id string Brand alphanumeric identifier (prefixed with letter 'B') \TCR\Client\Model\ExternalVetting
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\TCR\Client\Model\BrandRecordSetCSP listBrands($reference_id, $display_name, $entity_type, $identity_status, $status, $state, $country, $ein, $reseller_id, $tag, $mock, $page, $records_per_page)
Search brands
Search for brands you registered by any combination of 'displayName', 'entityType', 'state', 'country'. This operation supports pagination with a maximum of 500 records per fetch. 'state' and 'country' if supplied must be an exact match.
<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure HTTP basic authorization: myBasicAuthSecurity $config = TCR\Client\Configuration::getDefaultConfiguration() ->setUsername('YOUR_USERNAME') ->setPassword('YOUR_PASSWORD'); $apiInstance = new TCR\Client\Api\BrandApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); $reference_id = "reference_id_example"; // string | Reference ID. $display_name = "display_name_example"; // string | DBA or trade name of the business. Partial spelling accepted. $entity_type = "entity_type_example"; // string | Brand entity type. $identity_status = "identity_status_example"; // string | Brand identity status. $status = "ACTIVE"; // string | Brand status. Default value is 'ACTIVE' $state = "state_example"; // string | State or province. For U.S. input must conforms to 2-letter abbreviation. $country = "country_example"; // string | ISO2 2-letter abbreveiation of country. $ein = "ein_example"; // string | Government assigned corporate tax ID. EIN is 9-digits in U.S. $reseller_id = "reseller_id_example"; // string | Reseller ID. $tag = array("tag_example"); // string[] | Tag $mock = true; // bool | Mock brand Default 'null' input returns both real and test brands. $page = 1; // int | $records_per_page = 10; // int | Number of records per page. Max size is 500 try { $result = $apiInstance->listBrands($reference_id, $display_name, $entity_type, $identity_status, $status, $state, $country, $ein, $reseller_id, $tag, $mock, $page, $records_per_page); print_r($result); } catch (Exception $e) { echo 'Exception when calling BrandApi->listBrands: ', $e->getMessage(), PHP_EOL; } ?>
Name Type Description Notes reference_id string Reference ID. [optional] display_name string DBA or trade name of the business. Partial spelling accepted. [optional] entity_type string Brand entity type. [optional] identity_status string Brand identity status. [optional] status string Brand status. Default value is 'ACTIVE' [optional] [default to ACTIVE] state string State or province. For U.S. input must conforms to 2-letter abbreviation. [optional] country string ISO2 2-letter abbreveiation of country. [optional] ein string Government assigned corporate tax ID. EIN is 9-digits in U.S. [optional] reseller_id string Reseller ID. [optional] tag string[] Tag [optional] mock bool Mock brand Default 'null' input returns both real and test brands. [optional] page int [optional] [default to 1] records_per_page int Number of records per page. Max size is 500 [optional] [default to 10] \TCR\Client\Model\BrandRecordSetCSP
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\TCR\Client\Model\ExternalVetting[] listExternalVettings($brand_id, $vetting_status, $evp_id, $vetting_class)
Get list of external vetting record for a given brand
Option to query by vetting partner id, vetting class and status.
<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure HTTP basic authorization: myBasicAuthSecurity $config = TCR\Client\Configuration::getDefaultConfiguration() ->setUsername('YOUR_USERNAME') ->setPassword('YOUR_PASSWORD'); $apiInstance = new TCR\Client\Api\BrandApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); $brand_id = "brand_id_example"; // string | Brand ID $vetting_status = array("vetting_status_example"); // string[] | $evp_id = "evp_id_example"; // string | Vetting provider ID $vetting_class = "vetting_class_example"; // string | Vetting class try { $result = $apiInstance->listExternalVettings($brand_id, $vetting_status, $evp_id, $vetting_class); print_r($result); } catch (Exception $e) { echo 'Exception when calling BrandApi->listExternalVettings: ', $e->getMessage(), PHP_EOL; } ?>
Name Type Description Notes brand_id string Brand ID vetting_status string[] evp_id string Vetting provider ID [optional] vetting_class string Vetting class [optional] \TCR\Client\Model\ExternalVetting[]
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\TCR\Client\Model\ExternalVetting orderBrandExternalVetting($body, $brand_id)
Order new external vetting for a brand
This operation requests the specific vetting provider to perform vetting on a brand. By issuing this operation, the CSP authorizes the vetting provider access to the particular brand information stored in TCR. Vetting process may take anywhere from a minute to 2 days depending on the vetting provider. TCR will attempt to locate pending or unscore vetting record prior to accepting new order. The JSON request body must contain valid 'evpId', the identity of the vetting provider and the 'vettingClass', the vetting classification(/enum/vettingClass).The following table describes the vendor support for external vetting via TCR based on brand type<table style="float: left;" border="1"> <tr style="height: 61px;"> <th style="height: 61px;">Vetting Provider <th style="height: 61px;">Evp ID <th style="height: 61px;">
US Brand
<th style="height: 61px;">Non-US Brand
<th style="height: 61px;">Brand Entity
SOLE_PROPRIETOR
<th style="height: 61px;">Brand Entity
PRIVATE_PROFIT
<th style="height: 61px;">Brand Entity
PUBLIC_PROFIT
<th style="height: 61px;">Brand Entity
NON_PROFIT
<th style="height: 61px;">Brand Entity
GOVERNMENT
<tr style="height: 21px;"> <td style="height: 21px;">Aegis Mobile <td style="height: 21px;">AEGIS <td style="height: 21px;">Allowed <td style="height: 21px;">Allowed <td style="height: 21px;">Not Allowed <td style="height: 21px;">Allowed <td style="height: 21px;">Allowed <td style="height: 21px;">Allowed <td style="height: 21px;">Allowed <tr style="height: 21px;"> <td style="height: 21px;">Campaign Verify <td style="height: 21px;">CV <td style="height: 21px;">Not Allowed <td style="height: 21px;">Not Allowed <td style="height: 21px;">Not Allowed <td style="height: 21px;">Not Allowed <td style="height: 21px;">Not Allowed <td style="height: 21px;">Not Allowed <td style="height: 21px;">Not Allowed <tr style="height: 21px;"> <td style="height: 21px;">WMC Global <td style="height: 21px;">WMC <td style="height: 21px;">Allowed <td style="height: 21px;">Not Allowed <td style="height: 21px;">Not Allowed <td style="height: 21px;">Allowed <td style="height: 21px;">Allowed <td style="height: 21px;">Not Allowed <td style="height: 21px;">Not Allowed<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure HTTP basic authorization: myBasicAuthSecurity $config = TCR\Client\Configuration::getDefaultConfiguration() ->setUsername('YOUR_USERNAME') ->setPassword('YOUR_PASSWORD'); $apiInstance = new TCR\Client\Api\BrandApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); $body = new \TCR\Client\Model\ExternalVettingOrderRequest(); // \TCR\Client\Model\ExternalVettingOrderRequest | External vetting information to be updated $brand_id = "brand_id_example"; // string | Brand alphanumeric identifier (prefixed with letter 'B') try { $result = $apiInstance->orderBrandExternalVetting($body, $brand_id); print_r($result); } catch (Exception $e) { echo 'Exception when calling BrandApi->orderBrandExternalVetting: ', $e->getMessage(), PHP_EOL; } ?>
Name Type Description Notes body \TCR\Client\Model\ExternalVettingOrderRequest External vetting information to be updated brand_id string Brand alphanumeric identifier (prefixed with letter 'B') \TCR\Client\Model\ExternalVetting
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\TCR\Client\Model\Brand revetBrand($brand_id, $non_blocking)
Revet the brand
This operation allows you to revet the brand.
<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure HTTP basic authorization: myBasicAuthSecurity $config = TCR\Client\Configuration::getDefaultConfiguration() ->setUsername('YOUR_USERNAME') ->setPassword('YOUR_PASSWORD'); $apiInstance = new TCR\Client\Api\BrandApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); $brand_id = "brand_id_example"; // string | Brand alphanumeric identifier (prefixed with letter 'B') $non_blocking = true; // bool | try { $result = $apiInstance->revetBrand($brand_id, $non_blocking); print_r($result); } catch (Exception $e) { echo 'Exception when calling BrandApi->revetBrand: ', $e->getMessage(), PHP_EOL; } ?>
Name Type Description Notes brand_id string Brand alphanumeric identifier (prefixed with letter 'B') non_blocking bool [optional] [default to true] - Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\TCR\Client\Model\Brand updateBrand($body, $brand_id)
Update brand properties
This operation enables the CSP to keep brand details updated in the registry. The following table describes the update policy for each brand property. The re-scoring can be triggered via revet(/brand/{brandId}/revet) API<table style="float: left;" border="1"> <tr style="height: 61px;"> <th style="height: 61px;">Property Name <th style="height: 61px;">Update Support <th style="height: 61px;">Re-scoring Required <tr style="height: 21px;"> <td style="height: 21px;">ein, einIssuingCountry, entityType <td style="height: 21px;">CSP API or CSP Portal. Update allowed if brand has no external vet. <td style="height: 21px;">Yes <tr style="height: 21px;"> <td style="height: 21px;">fistName, lastName, displayName, companyName, website, street, city, state, postalCode, country, email, phone, vertical, stockSymbol, stockExchange <td style="height: 21px;">CSP API or CSP Portal <td style="height: 21px;">Optional <tr style="height: 21px;"> <td style="height: 21px;">brandRelationship <td style="height: 21px;">CSP API or CSP Portal. Brand relationship can only be updated once every 3 months. <td style="height: 21px;">Optional
<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure HTTP basic authorization: myBasicAuthSecurity $config = TCR\Client\Configuration::getDefaultConfiguration() ->setUsername('YOUR_USERNAME') ->setPassword('YOUR_PASSWORD'); $apiInstance = new TCR\Client\Api\BrandApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); $body = new \TCR\Client\Model\UpdateBrand(); // \TCR\Client\Model\UpdateBrand | Brand properties to be updated $brand_id = "brand_id_example"; // string | Brand alphanumeric identifier (prefixed with letter 'B') try { $result = $apiInstance->updateBrand($body, $brand_id); print_r($result); } catch (Exception $e) { echo 'Exception when calling BrandApi->updateBrand: ', $e->getMessage(), PHP_EOL; } ?>
Name Type Description Notes body \TCR\Client\Model\UpdateBrand Brand properties to be updated brand_id string Brand alphanumeric identifier (prefixed with letter 'B') - Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]