Response Definitions

Sandbox You are viewing Sandbox mode docs. Switch using the toggle on the dashboard.

Return Length
All return string types are a max of 128 bytes unless otherwise stated.

NAME TYPE DESCRIPTION
status integer The status of the request. A response of 0 indicates success. Any non-0 response is an error indication. For more information on status codes, see Error and Status Codes.
ipMatch boolean Indicates whether the request originated from an IP address on the API key's whitelist. Returns false if the requesting IP is not whitelisted, in which case no other data fields are returned.

If no IP whitelist is configured on the API key, this always returns true.
customerReference string The customerReference from the request, reflected back for tracking purposes.
requestId string The TDS-generated unique identifier for this request.
signature string A unique signature for this request. Store it alongside the requestId — pass both to the Risk Recall endpoint to retrieve this result again later.
troubleshootingId string Unique transaction identifier used to identify the results of the request.
carrier string The carrier related to the phone number.
countryCode string The country code associated with the phone number.
lineType string Line type associated with the phone number: mobile, landline, etc.
_fixedvoip
_nonfixedvoip
_landline
_mobile
other
verified boolean Indicator of verified identity between the mobile number and the identity data submitted.
firstName integer A score of the first name match; values 0 to 100. 100 indicates an exact match.
lastName integer A score of the last name match; values 0 to 100. 100 indicates an exact match.
nameScore integer An overall name score that uses both the first and last name scores to generate the overall score. Values 0 to 100. 100 indicates an exact match.
addressScore integer An overall address score that uses all the address attributes to generate the overall score; values 0 to 100. 100 indicates an exact match.
dob boolean The results of the date of birth match.
isLostStolen boolean Indicates whether the phone number has been reported as lost or stolen.
accountType string Indicates if the number is prepaid, postpaid, or corporate.
indicators array An array of indicator codes returned by the carrier. Each code represents a specific signal or flag associated with the number (e.g. OU, UV).
identifiers array An array of additional identifiers associated with the number or identity check result.
audit_url string A permanent URL linking to the immutable audit record for this check, including the policy snapshot that was active at the time of the request.
policy_version string The version of the Users Policy that was in effect at the time this check was performed.
policy_hash string A cryptographic hash of the policy document that was active at the time of the request. Can be used to verify the policy has not changed.
API Overview