Enum

Enum

Get Alt Business Id Type

Get Alternative Business ID types

SecuritybearerAuth
Responses
200

Successful Response

Response Schema: application/json
string (Response Get Alt Business Id Type Enum Altbusinessidtype Get)
get/enum/altBusinessIdType
Request samples 
Response samples 
application/json
"string"
List Public Company
List all TCR approved public companies for use as a Brand


SecuritybearerAuth 
Request 
query Parameters
displayName
string (Displayname) 
 
symbol
string (Symbol) 
 
exchange
string (Exchange) 
 
country
string (Country) 
 
page
integer (Page) 
 Default:  1
 
recordsPerPage
integer (Recordsperpage) 
 Default:  10
 
Responses 
200
Successful Response


Response Schema: application/json
Array of objects (Records) 
 
page
integer (Page) 
 
totalRecords
integer (Totalrecords) 
 
get/enum/approvedPublicCompany
Request samples 
Response samples 
application/json
{
  • "records": [
    • {
      • "symbol": "string",
      • "exchange": "NONE",
      • "iso2": "string",
      • "isin": "string",
      • "displayName": "string"
      }
    ],
  • "page": 0,
  • "totalRecords": 0
}
Get Brand Relationship
Get Brand Relationship types


SecuritybearerAuth 
Responses 
200
Successful Response


Response Schema: application/json
string (Response Get Brand Relationship Enum Brandrelationship Get) 
 
get/enum/brandRelationship
Request samples 
Response samples 
application/json
"string"
Get Campaign Status Type
Get Campaign status types


SecuritybearerAuth 
Responses 
200
Successful Response


Response Schema: application/json
string (Response Get Campaign Status Type Enum Campaignstatus Get) 
 
get/enum/campaignStatus
Request samples 
Response samples 
application/json
"string"
List Connectivity Partners
List connectivity partners


SecuritybearerAuth 
Responses 
200
Successful Response


Response Schema: application/json
string (Response List Connectivity Partners Enum Cnp Get) 
 
get/enum/cnp
Request samples 
Response samples 
application/json
"string"
Get All Dcas
List all DCAs


SecuritybearerAuth 
Responses 
200
Successful Response


Response Schema: application/json
 Array 
id
required
string (Id)   <= 7 characters 
Unique identifier of the direct connect aggregator


 
displayName
required
string (Displayname)   <= 100 characters 
Display name of the direct connect aggregator.


 
get/enum/dca
Request samples 
Response samples 
application/json
[
  • {
    • "id": "string",
    • "displayName": "string"
    }
]
Get Entity Type
Get Entity types


SecuritybearerAuth 
Responses 
200
Successful Response


Response Schema: application/json
string (Response Get Entity Type Enum Entitytype Get) 
 
get/enum/entityType
Request samples 
Response samples 
application/json
"string"
Get Vetting Providers
Get External vetting providers


SecuritybearerAuth 
Responses 
200
Successful Response


Response Schema: application/json
 Array 
evpId
string (Evpid) 
 
displayName
string (Displayname) 
 
tcrBillable
boolean (Tcrbillable) 
 
vettingClasses
Array of strings (Vettingclasses) 
 
vettingInstruction
string (Vettinginstruction) 
 
get/enum/extVettingProvider
Request samples 
Response samples 
application/json
[
  • {
    • "evpId": "string",
    • "displayName": "string",
    • "tcrBillable": true,
    • "vettingClasses": [
      • "string"
      ],
    • "vettingInstruction": "string"
    }
]
Get All Mnos
List all MNOs


SecuritybearerAuth 
Responses 
200
Successful Response


Response Schema: application/json
 Array 
networkId
required
integer (Networkid)   >= 10000 
Unique network identifier assigned to MNO.


 
displayName
required
string (Displayname)   <= 100 characters 
Display name of the mobile network operator.


 
osrBitmaskIndex
required
integer (Osrbitmaskindex)   [ 1 .. 32 ] 
NetNumber OSR 'campaign_id' property's 'status' attribute holds individual MNO campaign operation status. The 'status' attribute leverages bitmasking technique to store multiple MNOs' operating status. The campaign operation status is reduced to '1' or '0' value where '1' indicate an 'ACTIVE' status and '0' represents every other non-active statuses, including REVIEW, REJECT and SUSPEND. The 'osrBitmaskIndex' holds the bitmask index of the MNO. For example, T-Mobile's bitmask index is 2, which implies T-Mobile's campaign operation status is stored in bit #2, or 3rd bit when counting from right.


 
get/enum/mno
Request samples 
Response samples 
application/json
[
  • {
    • "networkId": 10000,
    • "displayName": "string",
    • "osrBitmaskIndex": 1
    }
]
List Mno Operation Status
List all MNO campaign operation statuses


SecuritybearerAuth 
Responses 
200
Successful Response


Response Schema: application/json
string (Response List Mno Operation Status Enum Operationstatus Get) 
 
get/enum/operationStatus
Request samples 
Response samples 
application/json
"string"
List Stock Exchanges
List all stock exchanges


SecuritybearerAuth 
Responses 
200
Successful Response


Response Schema: application/json
 Array 
string
 
get/enum/stockExchange
Request samples 
Response samples 
application/json
[
  • "string"
]
Get All Usecases
List all use-cases


SecuritybearerAuth 
Request 
query Parameters
validSubUsecase
boolean (Validsubusecase) 
 
Responses 
200
Successful Response


Response Schema: application/json
any
 
get/enum/usecase
Request samples 
Response samples 
application/json
null
Get All Verticals
List all verticals


SecuritybearerAuth 
Responses 
200
Successful Response


Response Schema: application/json
any
 
get/enum/vertical
Request samples 
Response samples 
application/json
null
List Vetting Class
List all vetting classes


SecuritybearerAuth 
Responses 
200
Successful Response


Response Schema: application/json
 Array 
id
string (Id) 
 
enabled
boolean (Enabled) 
 
displayName
string (Displayname) 
 
description
string (Description) 
 
validityMonths
integer (Validitymonths) 
 
get/enum/vettingClass
Request samples 
Response samples 
application/json
[
  • {
    • "id": "string",
    • "enabled": true,
    • "displayName": "string",
    • "description": "string",
    • "validityMonths": 0
    }
]