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.
requestId string The TDS-generated unique identifier for this recall request. This is newly generated for the recall itself, not the requestId supplied in the request body.
customerReference string The customerReference from the original check, reflected back for tracking purposes.
Risk_recall object Container for the recall result.
original_check_type string The type of check that was originally run and is now being recalled: "trust_score" or "mobile_kyc". Omitted if the signature could not be verified.
original_timestamp string ISO 8601 timestamp of when the original check was performed. Omitted if the signature could not be verified.
recall_timestamp string ISO 8601 timestamp of when this recall request was processed. Distinct from original_timestamp, which reflects the original check.
latency_ms integer Time taken to process this recall request, in milliseconds.
frozen boolean Indicates whether the returned data is the exact, unmodified result captured at the time of the original check.
signature_verified boolean Whether the supplied requestId/signature pair matched a stored record. When false, no original_response is returned.
original_response object The exact response payload originally returned by the recalled check (Trust Score or Mobile KYC), unmodified. Omitted if the signature could not be verified.
response object Nested within original_response. The check-specific result payload, in the same shape as the source API (Trust Score or Mobile KYC).
trustScore integer Present when recalling a Trust Score check. The trust score originally returned; values 0 to 1000.
callInSession string Present when recalling a Trust Score check. Indicates if a call was in session at the time of the original check.
details object Present when recalling a Trust Score check. Additional risk details captured during the original check.
riskLevel string Risk level captured during the original Trust Score check.
simTimestamp string ISO 8601 timestamp of the SIM event captured during the original Trust Score check.
callDirection string Direction of the call captured during the original Trust Score check (e.g. "IN", "OUT").
callDuration string Duration in seconds of the call captured during the original Trust Score check.
troubleshootingId string Present when recalling a Mobile KYC check. Unique transaction identifier used to identify the results of the original request.
verified boolean Present when recalling a Mobile KYC check. Indicator of verified identity between the mobile number and the identity data originally submitted.
numberInfo object Phone number metadata captured during the original check.
carrier string The carrier related to the phone number at the time of the original check.
lineType string Line type associated with the phone number: mobile, landline, etc.
countryCode string The country code associated with the phone number.
isLostStolen boolean Present when recalling a Mobile KYC check. Indicates if the number was flagged as lost or stolen at the time of the original check.
accountType string Present when recalling a Mobile KYC check. Indicates if the number was prepaid, postpaid, or corporate at the time of the original check.
name object Present when recalling a Mobile KYC check. Name match scores from the original check.
firstName integer Score of the first name match from the original check; values 0 to 100.
lastName integer Score of the last name match from the original check; values 0 to 100.
nameScore integer Overall name score from the original check; values 0 to 100.
address object Present when recalling a Mobile KYC check. Address match details from the original check.
addressScore integer Overall address score from the original check; values 0 to 100.
dob boolean Present when recalling a Mobile KYC check. Result of the date of birth match from the original check.
identifiers array Present when recalling a Mobile KYC check. Additional identifiers captured during the original check.
indicators array Array of indicator codes returned by the original check.
audit_url string URL to the full audit record for the original check, including the policy snapshot that was in effect at the time.
policy_version string The version of the Users Policy that was in effect at the time the original check was performed.
policy_hash string A cryptographic hash of the policy document that was active at the time of the original check. Can be used to verify the policy has not changed.
API Overview