Skip to main content

Onsite Integration

In onsite verification, Shufti Pro will directly interact with the end user to collect the required proof and information for verification purposes.

Parameters and Description​

ParametersDescription
ReferenceRequired: Yes
Type: string
Minimum: 6 characters
Maximum: 250 characters
Each request is issued a unique reference ID which is sent back to Shufti Pro’s client with each response. This reference ID helps to verify the request. The client can use this ID to check the status of already performed verification
CountryRequired: Yes
Type: string
Length: 2 characters
Country selection is mandatory as document proofs need to be uploaded according to the selected country's requirements.
LanguageRequired: No
Type: string
Length: 2 characters
If the Shufti Pro client wants their preferred language to appear on the verification screens they may provide the 2-character long language code of their preferred language.
Document ProofDefault: Yes
Values: Yes, No
Document proof is set to "Yes" by default, and if "No" is selected, it will redirect to Enhanced KYB.

Request Payloads​

request-object-sample-onsite
{
  "reference": "1234567",
  "callback_url": "https://yourdomain.com/profile/sp-notify-callback",
  "country": "GB",
  "language": "EN",
  "kyb": {
    "additional_proof_labels": ["label1", "label2"]
  }
}