Validation rules for caller ID phone numbers including format, presence, uniqueness, verification, and telephony restrictions

Caller ID Details

CallerIdDetailsMustBePresent

Definition	Severity	API	Sample	Mode
Validate that callerIdDetails is present			Link

Example Validation Report

{
  "code": "VALIDATION__CallerIdDetailsMustBePresent",
  "message": "'callerIdDetails' must be present",
  "severity": "VIOLATION",
  "details": {
    "createdDate": "2026-02-10T11:36:02.00Z",
    "submitted": [],
    "compared": [],
    "expected": []
  }
}

Phone Number

PhoneNumberAlreadyUsedByDifferentOrganization

Definition	Severity	API	Sample	Mode
Validate that a phone number does not exactly match an existing phone number under a different organization.

Example Validation Report

{
  "code": "VALIDATION__PhoneNumberAlreadyUsedByDifferentOrganization",
  "severity": "VIOLATION",
  "message": "'phoneNumber' '{{value}}' already used by different organization",
  "context": {
    "value": "+18005555555"
  },
  "details": {
    "createdDate": "2026-02-10T11:36:02.00Z",
    "submitted": [
      {
        "field": "$.callerIdDetails.phoneNumber",
        "value": "+18005555555"
      }
    ],
    "compared": [],
    "expected": []
  }
}

PhoneNumberInUseUnderDifferentBrand

Definition	Severity	API	Sample	Mode
Validate that a phone number does not exactly match an existing phone number under a different brand, same organization.

Example Validation Report

{
  "code": "VALIDATION__PhoneNumberInUseUnderDifferentBrand",
  "severity": "VIOLATION",
  "message": "'phoneNumber' already in use under brand ID '{{value}}'",
  "context": {
    "value": "9467895078742654921"
  },
  "details": {
    "createdDate": "2026-02-10T11:36:02.00Z",
    "submitted": [
      {
        "field": "$.callerIdDetails.phoneNumber",
        "value": "+18005555555"
      }
    ],
    "compared": [
      {
        "field": "id",
        "value": "9467895078742654921" /* id of brand resource */
      }
    ],
    "expected": []
  }
}

PhoneNumberIsMatched

Preconditions
Submitted resource has no department

Definition	Severity	API	Sample	Mode
Validate that a new caller ID resource's phoneNumber does not exactly match a phoneNumber in an existing resource under the same brand.			Link

Example Validation Report

{
  "code": "VALIDATION__PhoneNumberIsMatched",
  "severity": "VIOLATION",
  "message": "Caller ID with 'phoneNumber' '{{value}}' already exists",
  "context": {
    "value": "+18005555555"
  },
  "details": {
    "createdDate": "2026-02-10T11:36:02.00Z",
    "submitted": [
      {
        "field": "$.callerIdDetails.phoneNumber",
        "value": "+18005555555"
      }
    ],
    "compared": [
      {
        "field": "id",
        "value": "9467895078742654921" /* id of existing matched resource */
      }
    ],
    "expected": []
  }
}

PhoneNumberMustNotBeUpdated

Definition	Severity	API	Sample	Mode
Validate that submitted phoneNumber matches the existing phoneNumber in the identified resource

Example Validation Report

{
  "code": "VALIDATION__PhoneNumberMustNotBeUpdated",
  "severity": "VIOLATION",
  "message": "'phoneNumber' must not be updated",
  "details": {
    "createdDate": "2026-02-10T11:36:02.00Z",
    "submitted": [
      {
        "field": "$.callerIdDetails.phoneNumber",
        "value": "+18005555555"
      }
    ],
    "compared": [
      {
        "field": "phoneNumber",
        "value": "+18006666666"
      }
    ],
    "expected": []
  }
}

PhoneNumberNotIndependentlyMatched

Definition	Severity	API	Sample	Mode
Validate that the phoneNumber is matched by an independent source. (Prerequisite before an independent phone number ownership verification task can be performed.)

Example Validation Report

{
  "code": "VALIDATION__PhoneNumberNotIndependentlyMatched",
  "severity": "VIOLATION",
  "message": "'phoneNumber' '{{value}}' could not be independently matched",
  "context": {
    "value": "+18006666666"
  },
  "details": {
    "createdDate": "2026-05-10T11:36:02.00Z",
    "submitted": [
      {
        "field": "$.callerIdDetails.phoneNumber",
        "value": "+18006666666"
      }
    ],
    "compared": [],
    "expected": []
  }
}

PhoneNumberOwnerNotIndependentlyMatched

Definition	Severity	API	Sample	Mode
Validate that the brand name's association with a phoneNumber is independently verifiable. (In other words, an independent source corroborates the relationship between the name and the number.)

Example Validation Report

{
  "code": "VALIDATION__PhoneNumberOwnerNotIndependentlyMatched",
  "severity": "VIOLATION",
  "message": "'phoneNumber' '{{value}}' owner could not be independently matched",
  "context": {
    "value": "+18006666666"
  },
  "details": {
    "createdDate": "2026-05-10T11:36:02.00Z",
    "submitted": [
      {
        "field": "$.callerIdDetails.phoneNumber",
        "value": "+18006666666"
      }
    ],
    "compared": [],
    "expected": []
  }
}

PhoneNumberRegionNotSupported

Definition	Severity	API	Sample	Mode
Validate that a phoneNumber is registered in a supported country or region			Link

Example Validation Report

{
  "code": "VALIDATION__PhoneNumberRegionNotSupported",
  "severity": "VIOLATION",
  "message": "'phoneNumber' '{{value}}' is not registered in a supported country or region",
  "context": {
    "value": "+61742527777"
  },
  "details": {
    "createdDate": "2026-02-10T11:36:02.00Z",
    "submitted": [
      {
        "field": "$.callerIdDetails.phoneNumber",
        "value": "+61742527777"
      }
    ],
    "compared": [],
    "expected": []
  }
}

PremiumRateTelephoneNumberNotSupported

Definition	Severity	API	Sample	Mode
Validate that phoneNumber is not a premium-rate telephone number			Link

Example Validation Report

{
  "code": "VALIDATION__PremiumRateTelephoneNumberNotSupported",
  "severity": "VIOLATION",
  "message": "'phoneNumber' '{{value}}' is premium-rate",
  "context": {
    "value": "+19005555555"
  },
  "details": {
    "createdDate": "2026-02-10T11:36:02.00Z",
    "submitted": [
      {
        "field": "$.callerIdDetails.phoneNumber",
        "value": "+19005555555"
      }
    ],
    "compared": [],
    "expected": []
  }
}

PhoneNumberMustBePresent

Definition	Severity	API	Sample	Mode
Validate that phoneNumber is present			Link

Example Validation Report

{
  "code": "VALIDATION__PhoneNumberMustBePresent",
  "severity": "VIOLATION",
  "message": "'phoneNumber' must be present",
  "details": {
    "createdDate": "2026-02-10T11:36:02.00Z",
    "submitted": [],
    "compared": [],
    "expected": []
  }
}

PhoneNumberMustHaveValidFormat

Definition	Severity	API	Sample	Mode
Validate that phoneNumber formatting is valid

Example Validation Report

{
  "code": "VALIDATION__PhoneNumberMustHaveValidFormat",
  "message": "'phoneNumber' '{{value}}' must have valid format",
  "severity": "VIOLATION",
  "context": {
    "value": "+4479704802"
  },
  "details": {
    "createdDate": "2026-09-01T21:00:59.865Z",
    "submitted": [
      {
        "field": "$.callerIdDetails.phoneNumber",
        "value": "+4479704802"
      }
    ],
    "compared": [],
    "expected": []
  }
}

PhoneNumberMustNotBeEmpty

Definition	Severity	API	Sample	Mode
Validate that phoneNumber is not an empty string

Example Validation Report

{
  "code": "VALIDATION__PhoneNumberMustNotBeEmpty",
  "severity": "VIOLATION",
  "message": "'phoneNumber' must not be empty string",
  "details": {
    "createdDate": "2026-09-01T21:00:59.865Z",
    "submitted": [
      {
        "field": "$.callerIdDetails.phoneNumber",
        "value": ""
      }
    ],
    "compared": [],
    "expected": []
  }
}