Skip to main content

Onsite Integration

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

info

The Enhanced KYB service enables merchants to include empty keys in their request payload, which triggers the generation of a verification URL in the response. By clicking on this URL, users can directly submit the required information. ShuftiPro subsequently verifies the details and sends the verification report directly to the merchant in the backoffice.

Parameters & Description

ParametersDescription
advanced_searchRequired: Yes
Type: string
Accepted Values: 0, 1
Default Value: 0
This parameter is used to enable enhanced KYB service for the client when the parameter value is set to "1".
company_registration_numberRequired: Yes
Type: string
This parameter receives the company registration number to collect and verify the company information reports.
Example: 12345678
Note: The registration number is not required if the company name is provided.
company_nameRequired: No
Type: string
Minimum: 3 characters
This parameter receives the company name to collect and verify the company information reports.
Example: 'SHUFTI PRO LIMITED'
Note: The company name is not required if the registration number is provided.
country_namesRequired: Yes
Type: array
The option allows users to input the single country name in the form of an array for the search. Additionally, you can pass the state of the country to specify the search. Feel free to click on the following links to view supported countries and states
Example: ['united_kingdom'], ['alabama']
search_typeRequired: No
Type: string
Accepted Values: contains, start_with, fuzzy
Default Value: Contains
  • When using the "start_with" option, the API fetches a list of companies whose names start with the user-provided characters.
  • In contrast, with the "contains" option, the search covers companies having the given keywords anywhere in their names.
  • 'fuzzy' search expands to include less precise matches, broadening results by similarity rather than strict criteria.

Request Payloads

tip

Please include the country along with either the company registration number or the company name in your request.

Run in Postman

request-with-company_registration_number

//POST /status HTTP/1.1
//Host: api.shuftipro.com
//Content-Type: application/json
//Authorization: Basic NmI4NmIyNzNmZjM0ZmNlMTlkNmI4WJRTUxINTJHUw==
//replace "Basic" with "Bearer in case of Access Token"

{
"reference": "1234567",
"callback_url": "https://yourdomain.com/profile/sp-notify-callback",
"country": "GB",
"language": "EN",
"kyb": {
"advanced_search": "1",
"company_registration_number": "",
"country_names": ["united_kingdom"],
"search_type": "contains"
}
}

request-with-company_name

//POST /status HTTP/1.1
//Host: api.shuftipro.com
//Content-Type: application/json
//Authorization: Basic NmI4NmIyNzNmZjM0ZmNlMTlkNmI4WJRTUxINTJHUw==
//replace "Basic" with "Bearer in case of Access Token"

{
"reference": "1234567",
"callback_url": "https://yourdomain.com/profile/sp-notify-callback",
"country": "GB",
"language": "EN",
"kyb": {
"advanced_search": "1",
"company_name": " ",
"country_names": ["united_kingdom"],
"search_type": "start_with"
}
}
info

In an Enhanced KYB verification request, the results screen will not be displayed irrespective of the 'show_result' parameter's setting 0 or 1.