API Overview

This endpoint queries the consumer's phone number to return a TDS Trust Score and, potentially, other attributes to indicate the trustworthiness of a phone number and its identity.

Sandbox You are viewing Sandbox mode docs. Switch using the toggle on the dashboard.
Required Headers
http
Copy 
{
    "Authorization": "Bearer YOUR_SANDBOX_API_KEY",
    "Content-Type": "application/json"
}
Sample Request Body
json
Copy 
{
    "customerReference": "12345abc-67d8-910ef11-gh1213ijk",
    "phoneNumber": "447911123456",
    "country": "GB",
    "details": true
}
Full Curl Request
bash
Copy 
curl -X POST "https://eloquent-shirley.77-68-26-98.plesk.page/api/sandbox/trust-score" \
-H "Authorization: Bearer YOUR_SANDBOX_API_KEY" \
-H "Content-Type: application/json" \
-d '{
    "customerReference": "12345abc-67d8-910ef11-gh1213ijk",
    "phoneNumber": "447911123456",
    "country": "GB",
    "details": true
}'
200 Sample Response with Details
200 
{
    "status": 0,
    "ipMatch": true,
    "customerReference": "12345abc-67d8-928e11-gh12131",
    "requestId": "TDS68ba778a51ccb",
    "signature": "b5ed745afd02bd32a70f82dafc6fb2a41394e579206f39efa5",
    "response": {
        "trustScore": 1000,
        "indicators": [
            "NO",
            "NO"
        ],
        "callDivert": false,
        "phoneRisk": false,
        "details": {
            "riskLevel": "0",
            "simTimestamp": "2023-05-22T03:48:21Z"
        },
        "troubleshootingId": "7c179940-d14b-477f-8a5e-123456789abc",
        "numberInfo": {
            "carrier": "EE",
            "lineType": "mobile",
            "countryCode": "GB"
        }
    },
    "audit_url": "https://risk.tds.com/policy/{id}",
    "policy_version": "1.1",
    "policy_hash": "abc123"
}
200 Sample Response without Details
200 
{
    "status": 0,
    "ipMatch": true,
    "customerReference": "12345abc-67d8-910ef11-gh1213ijk",
    "requestId": "TDS68ba778a51ccb",
    "signature": "b5ed745afd02bd32a70f82dafc6fb2a41394e579206f39efa5",
    "response": {
        "trustScore": 1000,
        "indicators": [
            "WS",
            "ND"
        ],
        "callDivert": false,
        "phoneRisk": false
    },
    "audit_url": "https://risk.tds.com/policy/{id}",
    "policy_version": "1.1",
    "policy_hash": "abc123"
}
Response Definitions