openapi: 3.0.0 info: title: TMT Teleshield API specs termsOfService: https://viteza.tmtid.com/download-terms-and-conditions contact: name: TMT Support email: support@tmtid.com url: https://www.tmtid.com x-logo: url: https://www.tmtid.com/developer/teleshield_logo_png.png altText: TMT Teleshield version: '' paths: /r-teleshield/{number}: post: tags: - HTTP API v2.0 summary: TeleShield Routing operationId: POST description: '' parameters: - name: X-API-Key in: header description: Your apikey (delivered via email). required: true schema: type: string - name: X-API-Secret in: header description: Your apisecret (delivered via email). required: true schema: type: string - name: number in: path required: true description: The number in E.164 format (includes the country code sufix). schema: type: string responses: '200': headers: {} content: application/json: examples: TeleShield Routing Successful Command and Response Example: value: number: 40766610060 cc: RO ocic: 4018760 oocn: null itype: 1 etype: 10 omcc: '226' omnc: '03' original_network: Telekom Romania Mobile (Cosmote) error: 0 trxid: Pp2dxrl TeleShield Routing Status Message for Invalid Credentials input (apikey/apisecret): value: number: 40721275636 status_message: Service or destination not authorized status: 2 TeleShield Routing Error response for a number that belongs to a Denied Destination: value: number: 40721275636 error: 254 error_message: no auth Input number has no Country Code match: value: number: 999999 error: 1 error_message: invalid number Input number has the wrong length: value: number: 407225702400 error: 2 error_message: invalid number length Input number is not part of an allocated range from the regulator: value: number: 40999123233 error: 3 error_message: invalid number range schema: type: object properties: number: type: number description: The telephone number queried cc: type: string ocic: type: number oocn: type: string itype: type: number etype: type: number omcc: type: number omnc: type: number original_network: type: string error: type: number trxid: type: string description: '' /f-teleshield/{number}: post: tags: - HTTP API v2.0 summary: TeleShield Fraud operationId: POST description: '' parameters: - name: X-API-Key in: header description: Your apikey (delivered via email). required: true schema: type: string - name: X-API-Secret in: header description: Your apisecret (delivered via email). required: true schema: type: string - name: number in: path required: true description: The number in E.164 format (includes the country code sufix). schema: type: string responses: '200': headers: {} content: application/json: examples: TeleShield Fraud Successful Command and Response Example: value: number: 247490XX cc: AC, ocic: 247501 oocn: null itype: 1 etype: 10 omcc: '658' omnc: '01' original_network: Sure South Atlantic iprn_number: true iprn_number_first_seen: '2023-02-07' iprn_number_last_seen: '2023-02-07' iprn_wildcard: true iprn_wildcard_first_seen: '2023-02-07' iprn_wildcard_last_seen: '2023-06-20' msrn: true msrn_first_seen: '2023-02-07' msrn_last_seen: '2023-02-07' ts: 25 tl: M error: 0 trxid: u621Kb3 TeleShield Fraud Status message for Invalid Credentials (apikey/apisecret): value: number: 40722570240 status_message: Service or destination not authorized status: 2 TeleShield Fraud Error response for a number that belongs to a Denied Destination: value: number: 40722570240 error: 254 error_message: no auth Input number has no Country Code match: value: number: 999999 ts: 100 tl: H error: 1 error_message: invalid number Input number has the wrong length: value: number: 4077 ts: 100 tl: H error: 2 error_message: invalid number length Input number is not part of an allocated range from the regulator: value: number: 40999123233 ts: 100 tl: H error: 3 error_message: invalid number range schema: type: object properties: number: type: number description: The telephone number queried cc: type: string ocic: type: number oocn: type: string itype: type: number etype: type: number omcc: type: number omnc: type: number original_network: type: string iprn_number: type: boolean iprn_number_first_seen: type: date iprn_number_last_seen: type: date iprn_wildcard: type: boolean iprn_wildcard_first_seen: type: date iprn_wildcard_last_seen: type: date msrn: type: boolean msrn_first_seen: type: date msrn_last_seen: type: date ts: type: number tl: type: string error: type: number trxid: type: string description: '' /e-teleshield/{number v2.0}: post: tags: - HTTP API v2.0 summary: TeleShield Enhanced Fraud operationId: POST description: '' parameters: - name: X-API-Key in: header description: Your apikey (delivered via email). required: true schema: type: string - name: X-API-Secret in: header description: Your apisecret (delivered via email). required: true schema: type: string - name: number in: path required: true description: The number in E.164 format (includes the country code sufix). schema: type: string responses: '200': headers: {} content: application/json: examples: TeleShield Fraud Successful Command and Response Example: value: number: 40766610060 cc: RO ocic: 4018760 oocn: null itype: 1 etype: 10 omcc: '226' omnc: '03' original_network: Telekom Romania Mobile (Cosmote) ported: false ported_date: '2017-11-23' cic: 4018760 ocn: '' mcc: 226 mnc: 3 network: Telekom Romania Mobile (Cosmote) present: 'yes' iprn_number: false iprn_wildcard: false msrn: false ts: 0 tl: L error: 0 trxid: Q4iRYrT TeleShield Enhanced Fraud Status message for Invalid Credentials (apikey/apisecret): value: number: 40722570240 status_message: Service or destination not authorized status: 2 TeleShield Enhanced Fraud Error response for a number that belongs to a Denied Destination: value: number: 40722570240 error: 254 error_message: no auth Input number has no Country Code match: value: number: 999999 ts: 100 tl: H error: 1 error_message: invalid number Input number has the wrong length: value: number: 4077 ts: 100 tl: H error: 2 error_message: invalid number length Input number is not part of an allocated range from the regulator: value: number: 40999123233 ts: 100 tl: H error: 3 error_message: invalid number range Available Number Portability (np) / Unavailable Presence: value: number: 23470100000xx cc: NG ocic: 234500 oocn: null itype: 1 etype: 10 omcc: '621' omnc: '20' original_network: Airtel ported: true ported_date: '2020-10-11' cic: 234503 ocn: null mcc: 621 mnc: 60 network: 9Mobile (ETISALAT/Emerging Markets) present: na iprn_number: false iprn_wildcard: false msrn: false ts: 5 tl: L error: 4 error_message: presence not available trxid: BiiN7LJ Unavailable Number Portability (np) / Unavailable Presence: value: number: 9230440783xx cc: PK ocic: 92500 oocn: null itype: 1 etype: 10 omcc: '410' omnc: '01' original_network: Jazz (Mobilink) cic: 92500 ocn: null mcc: 410 mnc: 1 network: Jazz (Mobilink) present: na iprn_number: false iprn_wildcard: false msrn: false ts: 0 tl: L error: 5 error_message: presence not available trxid: pximuMp schema: type: object properties: number: type: number description: The telephone number queried cc: type: string ocic: type: number oocn: type: string itype: type: number etype: type: number omcc: type: number omnc: type: number original_network: type: string ported: type: boolean ported_date: type: date cic: type: number ocn: type: string mcc: type: number mnc: type: number network: type: string present: type: string iprn_number: type: boolean iprn_wildcard: type: boolean msrn: type: boolean ts: type: number tl: type: string error: type: number trxid: type: string description: '' /teleshield/{number}: post: tags: - HTTP API v1.3 summary: POST method Teleshield operationId: POST description: '' parameters: - name: X-API-Key in: header description: The API key (obtained from https://viteza.tmtid.com or from Support during customer on-boarding). required: true schema: type: string - name: X-API-Secret in: header description: The API secret (obtained from https://viteza.tmtid.com or from Support during customer on-boarding). required: true schema: type: string - name: number in: path required: true description: The number in E.164 format. schema: type: string responses: '200': headers: {} content: application/json: examples: Successful response format: value: number: 376321407 cc: AD ocic: 376500 ocn: null itype: 1 etype: 10 mcc: 213 omnc: 3 original_network: Mobiland iprn_number: false iprn_wildcard: false msrn: false error: 0 trxid: d42wkyt Invalid number response format: value: number: 9999721275636 error: 1 error_message: invalid number Invalid number length response format: value: number: 4072127563699 error: 2 error_message: invalid number length Invalid number range response format: value: number: 590691369999 error: 3 error_message: invalid number range schema: type: object properties: number: type: number description: The telephone number queried cc: type: string ocic: type: number ocn: type: string itype: type: number etype: type: number mcc: type: number omnc: type: number original_network: type: string iprn_number: type: boolean iprn_wildcard: type: boolean msrn: type: boolean error: type: number trxid: type: string description: '' /e-teleshield/{number v1.3}: post: tags: - HTTP API v1.3 summary: POST method E-Teleshield operationId: POST description: '' parameters: - name: X-API-Key in: header description: The API key (obtained from https://viteza.tmtid.com or from Support during customer on-boarding). required: true schema: type: string - name: X-API-Secret in: header description: The API secret (obtained from https://viteza.tmtid.com or from Support during customer on-boarding). required: true schema: type: string - name: number in: path required: true description: The number in E.164 format. schema: type: string responses: '200': headers: {} content: application/json: examples: Successful response format: value: number: 376321407 cc: AD ocic: 376500 ocn: null itype: 1 etype: 10 mcc: 213 omnc: 3 original_network: Mobiland ported: false cic: 376500 mnc: 3 network: Mobiland present: 'yes' iprn_number: false iprn_wildcard: false msrn: false error: 0 trxid: XryJIIw Invalid number response format: value: number: 9999721275636 error: 1 error_message: invalid number Invalid number length response format: value: number: 4072127563699 error: 2 error_message: invalid number length Invalid number range response format: value: number: 590691369999 error: 3 error_message: invalid number range schema: type: object properties: number: type: number description: The telephone number queried cc: type: string ocic: type: number ocn: type: string itype: type: number etype: type: number mcc: type: number omnc: type: number original_network: type: string ported: type: boolean cic: type: number mnc: type: string network: type: string present: type: string iprn_number: type: boolean iprn_wildcard: type: boolean msrn: type: boolean error: type: number trxid: type: string description: '' tags: - description: "\n
Telecommunications fraud is a global issue that has become even more pervasive with the growth in IP telephony and Voice over IP (VoIP) providers. It costs service providers and their customers billions of dollars annually. The TMT TeleShield service enables companies to take control of their strategy to win against fraudsters.
\nWith our TeleShield products, companies can ‘shield’ themselves from incurring losses from telephony fraud schemes. TMT provides unique access to real-time data through a robust network of suppliers combined with its own SS7 infrastructure enabling us to provide responses when other suppliers may be blocked by a network operator.
\nTeleShield provides intelligence on telephone numbers which can identify suspicious activity and enable service providers to make informed decisions to avoid financial impact or negative customer experience. For example, TeleShield provides information on:
\n\n - Has the number been made available for service by the regulator?\n\n - Does the number have a suspicious service type, for example is it a premium rate, satellite or VoIP?\n\n - Has the number been assigned to a subscriber by a service provider?\n\n - Has the number been ported?\n\n| Parameter | TeleShield Routing | TeleShield Fraud | TeleShield Enhanced Fraud |
|---|---|---|---|
| Identification if a number is valid | |||
| Identification if a number has a valid length | |||
| Identification if a number is part of an allocated range | |||
| Identification if a number is Mobile or Fixed (itype) | |||
| Additional number identification type (etype) | |||
| Country Code (CC) | |||
| Original Carrier MNC, MCC, OCN, CIC, Name | |||
| TeleShield Score assessment (TS) | |||
| TeleShield Level assessment (TL) | |||
| International Premium Rated Number (IPRN) Flag | |||
| First and Last time a number was seen in the IPRN list | |||
| International Premium Rated Number Suspicious Range Flag | |||
| The First and the Last time a number was included in a suspicious range | |||
| Mobile Station Roaming Number (MSRN) Flag | |||
| First and Last time a number was seen in MSRN list | |||
| Subscriber Status / Presence | |||
| Identification if a number was ported | |||
| Ported Date | |||
| Current Carrier Data (MNC, MCC, OCN, CIC, Name) |
| Field Name (Http api) | Field Name (Enum) | HTTP API Response | Description |
|---|---|---|---|
| ENUM Response | |||
| cc | cc | ISO 2 code | Two (2) letter code as defined in ISO 3166-1, part of the ISO 3166 standard published by the International Organization for Standardization, to represent countries, dependent territories and special areas of geographical interest. |
| cic | cic | Integer value | Current Carrier Identification Code. It Identifies the current network owner of the queried number. Mapping of the code to a network name is provided by TMT |
| error | err | Values: 0, 1, 2, 3, 4, 5, 254 | ‘0’ – no error, valid number (correct number length, in an allocated range) ''1'' – no country code match ''2'' – input number has the wrong length ''3'' – input number is not part of a range allocated to a service provider by the regulator ''4'' – input number presence is not available, other attributes will be provided where available ''5'' – (presence not available) input number presence and portability are not available. Ported and Ported date fields will be hidden in query response. ''254'' – (no auth) queried destination was blocked as customer requested. |
| error_message | msg | invalid number invalid number length invalid number range presence not available no auth | Text information for the error codes.ENUM queries are filtered by firewalls. |
| invalid_number invalid_number_length invalid_number_range | |||
| etype | et | Values: [1 – 33] | Code that further identifies the service type for the number range e.g., Premium rate, VoIP Telephony. List provided as Attachment 2. |
| itype | it | 1 – mobile 2 – landline (fixed) | Service type for the range in which the telephone number is included. |
| iprn_number | iprnn | yes / no | Value that indicates if the input phone number has been detected as flagged for use to test access. |
| 1 / 0 | |||
| iprn_number_first_seen | iprnnd | yyyy/mm/dd | Date that the IPRN number was first included in a list of suspicious numbers |
| yyyymmdd | |||
| iprn_number_last_seen | iprnnl | yyyy/mm/dd | Date that the IPRN number was last included in a list of suspicious numbers |
| yyyymmdd | |||
| iprn_wildcard | iprnr | true / false | Code that indicates if the input TN has been detected as being part of the number range that has the potential to be used for fraud (e.g., Wangiri, IRSF) |
| 1 / 0 | |||
| iprn_wildcard_first_seen | iprnrd | yyyy/mm/dd | First date that a number in the range was flagged as suspicious |
| yyyymmdd | |||
| iprn_wildcard_last_seen | iprnrl | yyyy/mm/dd | Last date that the number was noted as being available for testing access |
| yyyymmdd | |||
| mcc | mcc | 3 – digit number | Current Carrier Mobile Country Code.The MCC identifies the country which a mobile subscriber belongs to. In combination with the Mobile Network Code (MNC), it uniquely identifies a mobile network operator. |
| mnc | mnc | 2 – 3-digit number used to identify a mobile network carrier | Current Carrier Mobile Network Code.Code assigned by the country regulator to identify a mobile network operator in a specific country. |
| msrn | msrn | true / false | Mobile Station Roaming Number.Flag for premium rate number that has been advertised as available to use for calls roaming from their home country. |
| 1 / 0 | |||
| msrn_number_first_seen | msrnd | yyyy/mm/dd | Date that the MSRN number was first included in a list of suspicious numbers |
| yyyymmdd | |||
| msrn_number_last_seen | msrnl | yyyy/mm/dd | Date that the MSRN number was last included in a list of suspicious numbers |
| yyyymmdd | |||
| network | nsn | Alpha-numeric value | Current Network Short Name |
| number | n/a | Input from customer | Queried phone number |
| ocic | ocic | Integer value | Original Carrier Identification Code. It Identifies the original network owner of the queried number. Mapping of the code to a network name is provided by TMT. |
| ocn | ocn | Integer value | Current Carrier Operating Company Number.Four (4) character ID for North American phone companies. |
| omcc | omcc | ||
| omnc | omnc | 2 – 3 digit number | Code assigned by the country regulator to identify a mobile network operator in a specific country. |
| oocn | oocn | Current Carrier Operating Company Number.Four (4) character ID for North American phone companies. | |
| original network | onsn | Alpha-numeric value | Original Network Short Name |
| ported | np | true / false / null | Provides indication of whether the number has been ported |
| 1 / 0 | |||
| ported_date | pd | yyyy-mm-dd | Date of last known port if applicable |
| yyyymmdd | |||
| present | ss | yes / no / na | Field that indicates whether the subscriber is present in the network e.g., is that a number has been assigned by the network operator range holder to a subscriber. |
| 1 / 0 / na | |||
| status | 2 | Status 2 Is received for wrong input of apikey or apisecret. | |
| status_message | Service or destination not authorized. | Text information for the status. | |
| tl | tl | L M H | TeleShield Level Field that converts the TeleShield Score into an assessment level for the number to have a propensity to be used in a fraud scheme:
|
| ts | ts | Values: [0 – 100] | TeleShield Score The result of the application of a consistent set of rules to publicly available number intelligence data. The relevant attributes are assigned a number that reflects the possibility for it to be fraudulent e.g., number format, suspicious number type, suspicious IPRN/MSRN number instance, suspicious range, port attributes and subscriber status. |
| trxid | 7 character code | Transaction ID Internally generated number for tracking of transactions. | |
| XXXXXX | xxxxxx | Alphanumeric values | Anonymized information |