Skip to main content

Onsite Integration

In onsite verification, Shufti will directly interact with the end user to collect the required proofs for verification purposes.

Parameters and Description​

ParametersDescription
phone_numberRequired: No
Type: string
Minimum: 6 characters
Maximum: 64 characters
Allowed Characters: numbers and plus sign at the beginning. Provide a valid customer’s phone number with country code. Shufti will directly ask the end-user for phone number if this field is missing or empty.
random_codeRequired: No
Type: string
Minimum: 2 characters
Maximum: 10 characters
Provide a random code. If this field is missing or empty, Shufti will generate a random code.
textRequired: No
Type: string
Minimum: 2 characters
Maximum: 100 characters
Provide a short description and random code in this field. This message will be sent to customers. This field should contain random_code. If random_code field is empty then Shufti will generate a random code and append the code with this message at the end.
validate_phoneRequired: No
Type: string
Accepted Values: 0, 1
Default Value: 0
Enabling the key subjects the phone number to a strict validation process with predefined fraud prevention rules, aiming to identify any fraudulent activities or irregularities.
sms_pumpingRequired: No
Type: boolean
SMS Pumping Risk Detection helps identify fraudulent activities that involve artificially inflating SMS traffic, providing a risk score that reflects the likelihood of such behavior.
line_type_intelligenceRequired: No
Type: boolean
Line Type Intelligence categorizes phone numbers based on their type—such as mobile, VOIP, or landline—and identifies the associated carrier. This helps in evaluating the legitimacy and potential risk of the phone number, ensuring a more accurate fraud prevention process.

Run in Postman

phone-service-sample-object
{
  "phone" : {
      "phone_number"    : "",
      "random_code"     : "",
      "text"            : ""
  }
}

caution

Phone Service is not available in Offsite Verification.