API Overview

This endpoint verifies a consumer's identity by matching their phone number, name, date of birth, and address against mobile network operator (MNO) data to return a verification status and match scores.

Sandbox You are viewing Sandbox mode docs. Switch using the toggle on the dashboard.
Required Headers
http
Copy 
{
    "Authorization": "Bearer YOUR_SANDBOX_API_KEY",
    "Accept": "application/json",
    "data-locale": "UK",
    "Content-Type": "application/json"
}
Sample Request Body
json
Copy 
{
    "leadReference": "123456789",
    "phoneNumber": "447911123456",
    "firstName": "John",
    "lastName": "Smith",
    "address": "49 Featherstone Street",
    "extendedAddress": "apt 101",
    "city": "Manchester",
    "region": "Greater Manchester",
    "postalCode": "EC1Y 8SY",
    "dob": "1990-01-01"
}
Full Curl Request
bash
Copy 
    curl -X POST  "https://eloquent-shirley.77-68-26-98.plesk.page/api/sandbox/kyc"\
    -H "Authorization: Bearer YOUR_SANDBOX_API_KEY" \
    -H "Accept: application/json" \
    -H "data-locale: UK" \
    -H "Content-Type: application/json" \
    -d '{
        "leadReference": "123456789",
        "phoneNumber": "447911123456",
        "firstName": "John",
        "lastName": "Smith",
        "address": "49 Featherstone Street",
        "extendedAddress": "apt 101",
        "city": "Manchester",
        "region": "Greater Manchester",
        "postalCode": "EC1Y 8SY",
        "dob": "1990-01-01"
    }'
200 Sample Response with Details
200 
{
    "status": 0,
    "leadReference": "123456789",
    "requestId": "TDS7c179940d14b477f",
    "response": {
        "troubleshootingId": "b48c6082-2d18-4b4f-8aa1-4a891bb134d5",
        "numberInfo": {
            "carrier": "Three",
            "countryCode": "GB",
            "lineType": "mobile",
            "isLostStolen": false,
            "accountType": "postpay"
        },
        "verified": true,
        "name": {
            "firstName": 100,
            "lastName": 100,
            "nameScore": 100
        },
        "address": {
            "addressScore": 100
        },
        "dob": true,
        "indicators": [
            "OU",
            "UV"
        ],
        "identifiers": []
    },
    "audit_url": "https://risk.tds.com/policy/{id}",
    "policy_version": "1.1",
    "policy_approved_at": "2026-01-22T18:41:00Z",
    "last_policy_scan": "2026-01-23T00:01:00Z",
    "next_policy_scan": "2026-01-24",
    "policy_changed": false,
    "policy_hash": "abc123",
    "policy_character_count": 4876
}
200 Sample Response without Details
200 
{
    "status": 0,
    "leadReference": "123456789",
    "requestId": "TDS7c179940d14b477f",
    "response": {
        "troubleshootingId": "b48c6082-2d18-4b4f-8aa1-4a891bb134d5",
        "verified": true,
        "indicators": [
            "OU",
            "UV"
        ]
    },
    "audit_url": "https://risk.tds.com/policy/{id}",
    "policy_version": "1.1",
    "policy_approved_at": "2026-01-22T18:41:00Z",
    "last_policy_scan": "2026-01-23T00:01:00Z",
    "next_policy_scan": "2026-01-24",
    "policy_changed": false,
    "policy_hash": "abc123",
    "policy_character_count": 4876
}
Response Definitions