Skip to main content

Offsite Integration

In the offsite verification process, Shufti Pro's merchants are solely responsible for gathering all necessary information from the end user and then submitting it to Shufti Pro for verification.

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.
search_byRequired: No
Type: string
This parameter contains the identifier used to search for a company. The identifier varies based on the company's registration country and includes country-specific options.
Note: You can use the search_by and search_word keys when you want to use any other search identifiers apart from company_name and company_registration_number.
Example: For Saudi Arabia, you can use "vat_number" in search_by and its value in search_word. For more details on supported identifiers, visit here.
search_wordRequired: No
Type: string
This depends on the option selected in 'Search_by' parameter and includes the actual value of the search identifier provided by the user for searching the company record.

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": "12345678",
"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": "SHUFTI PRO LIMITED",
"country_names": ["united_kingdom"],
"search_type": "start_with"
}
}
request-with-search_by-and-search_word

//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,
"search_by": "company_name",
"search_word": "SHUFTI PRO LIMITED",
"country_names":["united_kingdom"],
"search_type": "contains"
}
}
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.