Skip to main content

With OCR Verification

Every verification request received from the end-user or Shufti Pro customer is assessed on certain parameters (discussed in detail below) by Shufti Pro’s intelligent system. These parameters allow Shufti Pro to:

  • Identify its customers.
  • Check the authenticity of the client’s credentials.
  • Read the client’s data.
  • Decide what information is being sent to perform a certain verification.
Onsite_verification_with_OCR

Verification Request​

On-site verification means that Shufti Pro will be interacting directly with end-user and will be responsible for data collection in order to perform Identity verification. Shufti Pro customer will only be notified about the verification status via Shufti Pro Back Office.

Shufti Pro collects the image or video proofs from end-users. In the verification request, Shufti Pro customer specifies the keys for the parameters to be verified. Shufti Pro extracts the required information from the provided document and then the verification form is automatically filled with the extracted information. This reduces the manual work for the end-user. Next, Shufti Pro’s intelligently driven system verifies the provided documents for authenticity. Please consult this Document for Onsite with OCR verifications.

OCR is offered on the following services: (Document and Address) but Shufti Pro customers can also avail other non-OCR services such as Face & Phone Verification along with these OCR services.

Shufti Pro offers following services in On-site verification: (Face, Document, Document Two, Address, Consent, Phone, Email Verification, Background Checks and Enhance Due Diligence)


Run in Postman


//POST / 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" : "http://www.example.com/",
    "email"        : "[email protected]",
    "country"      : "GB",
    "language"     : "EN",
    "redirect_url": "http://www.example.com",
    "ttl"         : 60,
    "verification_mode" : "any",
    "document"         : {
        "proof"           : "",
        "additional_proof" : "",
        "supported_types" : ["id_card","driving_license","passport"],
        "name"            : "",
        "dob"             : "",
        "age"             : "",
        "issue_date"      : "", 
        "expiry_date"     : "",
        "document_number" : "",
        "allow_offline"   : "1",
        "allow_online"    : "1",
        "gender"   : ""
    },
    
    "address"         : {
        "proof"            : "",
        "supported_types"  : ["id_card","bank_statement"],
        "name"             : "",
        "issue_date"       : "",
        "full_address"     : "",
        "address_fuzzy_match":"1",
        "document_number" : ""
    }
}

ParametersDescription
faceRequired: No
Type: object
This service key corresponds to Face Verification Service in which unique facial features of end-user are identified and verified in real-time.
Example 1 { "proof" : ""}
for more details Face Service
documentRequired: No
Type: object
This service key corresponds to Document verification service in which the authenticity of identity documents submitted by end-users is checked. Once verified, these identity documents serve as proof of end-user’s identity.
Example 1 { "document_number": "", "issue_date": "", "expiry_date": "", "dob": "", "name": "", "supported_types": ["id_card", "credit_or_debit_card", "passport"]}
for more details Document Service
addressRequired: No
Type: object
This service key corresponds to Address Verification service in which the authenticity of an end-user's provided address is checked with the help of an authentic Identity document, Utility bill or bank statement
Example 1 {"supported_types" : ["id_card","bank_statement"],"name": "","full_address": "" }
for more details Address Service
consentRequired: No
Type: object
This service key corresponds to Consent Verification services in which the consent provided by end-user for a certain action is cross-checked with the help of a handwritten document or customized printed document
Example 1 {"proof" : "","text" : ""}
for more details Consent Service
phoneRequired: No
Type: object
This service key corresponds to Phone Verification service of Shufti Pro. A customized code is sent to end-user on their phone number, that is sent back by end-user to verify their identity.
Example 1 {"phone_number" : "","random_code" : "","text" : ""}
for more details Phone Service
email_verifyRequired: No
Type: object
This service key corresponds to Email Verification service of Shufti Pro. A code is sent to end-user on their given email address, that is sent back by end-user to verify their identity.
Example 1 {"email" : ""}
for more details Email Verification Service
background_checksRequired: No
Type: object
This service key corresponds to AML Screening service offered by Shufti Pro. An AML background check is performed for every end-user in this service against a financial risk database compiled by Shufti Pro
Example 1 {"name" : "", "dob" : "" }
for more details Background Checks service

caution

If you are using iFrames on your web page, you need to add allow = “camera” attribute to enable the camera. 


<iframe src="" id="shuftipro-iframe" allow="camera" frameborder="0"></iframe>

Verification Response​

Responses will contain the following parameters:


ParametersDescription
referenceYour unique request reference, which you provided us at the time of request, so that you can identify the response in relation to the request made.
eventThis is the request event which shows status of request. Event is changed in every response.
Please consult Events for more information.
errorWhenever there is an error in your request, this parameter will have the details of that error.
tokenThis is the unique request token of the request.
verification_urlA URL is generated for your customer to verify there documents. It is only generated in case of on-site request.
verification_resultThis object will be returned in case of verification.accepted or verification.declined. This includes the results of each verification.
1 means accepted
0 means declined
null means not processed
Check verification.accepted and verification.declined responses in Events section for a sample response.
verification_dataThis object will be returned in case of verification.accepted or verification.declined. This object will include all the gathered data in a request process.
Check verification.accepted and verification.declined responses in Events section for a sample response.
infoThis object will be returned in case of verification.accepted or verification.declined. It contains the following keys:
Agent provides information about the device and browser of the end-user.
Geolocation provides information about the geographical location of the end-user.
For Details on info object go to Info
additional_dataThis object will be returned in case of verification.accepted or verification.declined. This object contains the additional data extracted by Shufti Pro on the document.
For Details on additional_data object go to Additional Data
declined_reasonThis parameter will have the reason due to which a verification has been declined, and is only returned in this case in the callback URL.
declined_codesThis array contains status codes of all declined verification reasons. It will return only for verification.declined.
services_declined_codesThis object contains status codes of declined reasons for each service separately. Each service object will contain an array of status codes for declined reasons specific to that service. It will return only for verification. declined.

sample-response
//Content-Type: application/json
//Signature: NmI4NmIyNzNmZjM0ZmNl

{
    "reference": "17374217",
    "event": "request.pending",
    "verification_url": "https://api.shuftipro.com/verify/474f51710fb60fdf9688f44ea0345eda28a9f55212a83266fb5d237babff2",
    "email": "[email protected]",
    "country": "GB"
}

caution

Callback response will be sent on the callback_url provided in the request callback_url parameter.


Verification Services​

Shufti Pro is performing variety of verifications for its customers. Our diverse services suite allows us to validate the identity of users through facial verification, documents verification and address verification. We can also check the authenticity of customised documents like official IDs and perform background checks for AML compliance. A mix of various service modules can also be acquired to perform multifaceted verifications like facial and document verification can help you perform a thorough KYC procedure.


Face Service​

The face verifications of end-users are the simplest to perform. End-user will have to show their face in front of a webcam or phone camera for verification


ParametersDescription
proofRequired: No
Type: string
Image Format: JPG, JPEG, PNG, PDF Maximum: 16MB
Video Format: MP4/MOV Maximum: 20MB
Provide valid BASE64 encoded string. Leave empty for an on-site verification.
allow_offlineRequired: No
Type: string
Accepted Values: 0, 1
Default Value: 1
This parameter allows user to upload their selfie in case of non-availability of a functional webcam. If value is 0, users can only perform Face Verification with the camera only.
allow_onlineRequired: No
Type: string
Accepted Values: 0, 1
Default-Value: 1
This parameter allows users to take their selfie in real-time when internet is available. If value: 0 users can upload already captured selfie.

Note: if allow_offline: 0 priority will be given to allow_offline
check_duplicate_requestRequired: No
Type: string
Accepted Values: 0, 1
Default-Value: 0
This parameter is used to enable the duplicate account detection service. Face mapping technology identify duplicate faces across all customers through which duplicate accounts are detected. The duplicate account detection will be disabled if the value is 0 and enabled if the value is 1.
verification_modeRequired: No
Type: string
Accepted Values: any, image_only, video_only
This key specifies the types of proofs that can be used for verification. In the "video_only" mode, Shufti Pro's client is restricted to submitting "Base64" encoded videos, which must be in the MP4 or MOV format. The "any" mode allows a combination of images and videos to be submitted as proofs for verification. If there is a conflict between the service level key and the general level key, priority is assigned to the service level key.

face-service-sample-object
{
  "face" : {
        "proof"         : "",
        "allow_offline" : "1",
        "allow_online" : "1",
        "verification_mode": "any",
        "check_duplicate_request" : "1"
  }
}

Document Service​

Shufti Pro provides document verification through various types of documents. The supported formats are passports, ID Cards, driving licenses and debit/credit cards. You can opt for more than 1 document type as well. In that case, Shufti Pro will give an option to end-users to verify their data from any of the given document types.

You can provide more than 1 document image and use “additional proof” parameter for this. This is to ensure that the required credentials are easily visible e.g. a document might have name and image of individual at the front but the date of birth of that person is printed at the back of the document or on another page of the passport. If you opt for both facial and document verification, face of individual from document will be used to validate uploaded selfie.


ParametersDescription
proofRequired: No
Type: string
Image Format: JPG, JPEG, PNG, PDF Maximum: 16MB
Video Format: MP4/MOV Maximum: 20MB
Provide valid BASE64 encoded string. Leave empty for an on-site verification.
additional_proofRequired: No
Type: string
Image Format: JPG, JPEG, PNG, PDF Maximum: 16MB
Video Format: MP4/MOV Maximum: 20MB
Provide valid BASE64 encoded string. Leave empty for an on-site verification.
supported_typesRequired: No
Type: Array
Document verification have two parameters: proof and additional_proof. If these two are not set or empty, it means that it should be an on-site verification. You can provide any one, two or more types of documents to verify the identity of user. For example, if you opt for both passport and driving license, then your user will be given an opportunity to verify data from either of these two documents. Please provide only one document type if you are providing proof of that document with the request. All supported types are listed here
Example 1 ["driving_license"]
Example 2 ["id_card", "credit_or_debit_card", "passport"]
dobRequired: No
Type: string
Format: yyyy-mm-dd
Provide a valid date.
Example 1990-12-31
ageRequired: No
Type: integer/array
Allowed values are integers or array.
The Age parameter allows the client to set a minimum and maximum limit for acceptance of a user. The minimum age is defined as min and the maximum is defined as max within this object.
Example 18
For More Details Age
document_numberRequired: No
Type: string
Maximum: 100 chracters
Allowed Characters are numbers, alphabets, dots, dashes, spaces, underscores and commas.
Examples 35201-0000000-0, ABC1234XYZ098
issue_dateRequired: No
Type: string
Format: yyyy-mm-dd
Provide a valid date.
Example 2015-12-31
expiry_dateRequired: No
Type: string
Format: yyyy-mm-dd
Provide a valid date.
Example 2025-12-31
genderRequired: No
Type: string
Accepted Values: M,F,O,m,f,o
Provide the gender which is given in the document.
F: Female
M: Male
O: Others
Example: M
allow_offlineRequired: No
Type: string
Accepted Values: 0, 1
Default Value: 1
This parameter allows user to upload their document in case of non-availability of a functional webcam. If value is 0, users can only perform Document Verification with the camera only.
allow_onlineRequired: No
Type: string
Accepted Values: 0, 1
Default-Value: 1
This parameter allows users to capture their document in real-time when internet is available. If value: 0 users can upload already captured document.

Note: if allow_offline: 0 priority will be given to allow_offline
fetch_enhanced_dataRequired: No
Type: string
Value Accepted: 1
Provide 1 for enabling enhanced data extraction for the document. Shufti Pro provides its customers with the facility of extracting enhanced data features using OCR technology. Now, instead of extracting just personal information input fields, Shufti Pro can fetch all the additional information comprising more than 100 data points from the official ID documents supporting 150 languages. For example height, place_of_birth, nationality, marital_status, weight, etc.(additional charges apply)
Extrated data will be returned in object under the key additional_data in case of verification.accepted or verification.declined.
For Details on additional_data object go to Additional Data
nameRequired: No
Type: object
In name object used in document service, first_name is required if you don't want to perform OCR of the name parameter. Other fields are optional.
Example 1 { "first_name" : "John", "last_name" : "Doe" }
Example 2 { "first_name" : "John", "last_name" : "Doe", "fuzzy_match" : "1"}
Parameters for name are listed here
backside_proof_requiredRequired: No
Type: string
Accepted Values: 0, 1
Default Value: 0
If the value of this parameter is set to 1, Shufti Pro will require the end-user to capture/upload both sides of the document to verify the identity. Enabling this parameter will also activate the front and back sides document match feature, which will verify if captured/uploaded front and back sides belong to the same document.
verification_instructionsRequired: No
Type: Object
This key allows clients to provide additional instruction for the service (document, document_two and address service). Such as if the client wants to allow paper-based, photocopied or laminated documents for verification.
Example {"allow_paper_based" : "1"}
For more details on Instructions Parameters click here
show_ocr_formRequired: No
Type: boolean
Accepted Values: 0, 1
default value: 1
The default value for this is 1. If this is set to 0, the user will not be shown the OCR form to validate the extracted information. This can be used within the Document, Document Two, and Address service. This value can also be applied to all services collectively. However, preference will be given to the value set within the service.

Note: Setting the value at 0 may cause data inaccuracy as the user does not have option to validate the extracted information.
verification_modeRequired: No
Type: string
Accepted Values: any, image_only, video_only
This key specifies the types of proofs that can be used for verification. In the "video_only" mode, Shufti Pro's client is restricted to submitting "Base64" encoded videos, which must be in the MP4 or MOV format. The "any" mode allows a combination of images and videos to be submitted as proofs for verification. If there is a conflict between the service level key and the general level key, priority is assigned to the service level key.

document-service-sample-object
{
   "document"         : {
         "supported_types" : ["id_card","driving_license","passport"],
         "name"            : {
           "first_name" : "",
           "last_name"  : ""
         },
         "proof"                : "",
         "additional_proof"     : "",
         "dob"                  : "",
         "age"                  : "",
         "issue_date"           : "", 
         "expiry_date"          : "",
         "document_number"      : "",
         "allow_offline"        : "1",
         "allow_online"         : "1",
         "fetch_enhanced_data"  : "1",
         "backside_proof_required" : "0",
         "verification_mode": "any",
         "gender"   : "",
         "show_ocr_form"        : "1",
         "nationality"           : ""

     }
}

Document Two Service​

Document Two Service is provided to verify the personal details of a user from more than 1 document e.g. If you have verified the DOB & Name of a user from their ID Card, you can use Document Two Service to verify the Credit Card Number of your customer.

Just like the “Document Service”, the supported formats for this service are also passports, ID Cards, driving licenses and debit/credit cards and more than one document type can be selected as well. In that case, Shufti Pro will give an option to end-users to verify their data from any of the given document types.

The end-user can be asked to provide more than 1 document image. For this, you can use the “additional proof” parameter. If you opt for both facial and document verification, the face of an individual from the document will be used to validate uploaded selfie.

It goes without saying that provided document proofs should belong to the same person in order to verify the identity of the user.


ParametersDescription
proofRequired: No
Type: string
Image Format: JPG, JPEG, PNG, PDF Maximum: 16MB
Video Format: MP4/MOV Maximum: 20MB
Provide valid BASE64 encoded string. Leave empty for an on-site verification.
additional_proofRequired: No
Type: string
Image Format: JPG, JPEG, PNG, PDF Maximum: 16MB
Video Format: MP4/MOV Maximum: 20MB
Provide valid BASE64 encoded string. Leave empty for an on-site verification.
supported_typesRequired: No
Type: Array
Document verification have two parameters: proof and additional_proof. If these two are not set or empty, it means that it should be an on-site verification. You can provide any one, two or more types of documents to verify the identity of user. For example, if you opt for both passport and driving license, then your user will be given an opportunity to verify data from either of these two documents. Please provide only one document type if you are providing proof of that document with the request. All supported types are listed here
Example 1 ["driving_license"]
Example 2 ["id_card", "credit_or_debit_card", "passport"]
dobRequired: No
Type: string
Format: yyyy-mm-dd
Provide a valid date.
Example 1990-12-31
ageRequired: No
Type: integer/array
Allowed values are integers or array.
The Age parameter allows the client to set a minimum and maximum limit for acceptance of a user. The minimum age is defined as min and the maximum is defined as max within this object.
Example 18
For More Details Age
document_numberRequired: No
Type: string
Maximum: 100 chracters
Allowed Characters are numbers, alphabets, dots, dashes, spaces, underscores and commas.
Examples 35201-0000000-0, ABC1234XYZ098
issue_dateRequired: No
Type: string
Format: yyyy-mm-dd
Provide a valid date.
Example 2015-12-31
expiry_dateRequired: No
Type: string
Format: yyyy-mm-dd
Provide a valid date.
Example 2025-12-31
genderRequired: No
Type: string
Accepted Values: M,F,O,m,f,o
Provide the gender which is given in the document.
F: Female
M: Male
O: Others
Example: M
allow_offlineRequired: No
Type: string
Accepted Values: 0, 1
Default Value: 1
This parameter allows user to upload their document in case of non-availability of a functional webcam. If value is 0, users can only perform Document Verification with the camera only.
allow_onlineRequired: No
Type: string
Accepted Values: 0, 1
Default-Value: 1
This parameter allows users to capture their document in real-time when internet is available. If value: 0 users can upload already captured document.

Note: if allow_offline: 0 priority will be given to allow_offline
fetch_enhanced_dataRequired: No
Type: string
Value Accepted: 1
Provide 1 for enabling enhanced data extraction for the document. Shufti Pro provides its customers with the facility of extracting enhanced data features using OCR technology. Now, instead of extracting just personal information input fields, Shufti Pro can fetch all the additional information comprising more than 100 data points from the official ID documents supporting 150 languages. For example height, place_of_birth, nationality, marital_status, weight, etc.(additional charges apply)
Extrated data will be returned in object under the key additional_data in case of verification.accepted or verification.declined.
For Details on additional_data object go to Additional Data
nameRequired: No
Type: object
In name object used in document service, first_name is required if you don't want to perform OCR of the name parameter. Other fields are optional.
Example 1 { "first_name" : "John", "last_name" : "Doe" }
Example 2 { "first_name" : "John", "last_name" : "Doe", "fuzzy_match" : "1"}
Parameters for name are listed here
backside_proof_requiredRequired: No
Type: string
Accepted Values: 0, 1
Default Value: 0
If the value of this parameter is set to 1, Shufti Pro will require the end-user to capture/upload both sides of the document to verify the identity. Enabling this parameter will also activate the front and back sides document match feature, which will verify if captured/uploaded front and back sides belong to the same document.
verification_instructionsRequired: No
Type: Object
This key allows clients to provide additional instruction for the service (document, document_two and address service). Such as if the client wants to allow paper-based, photocopied or laminated documents for verification.
Example {"allow_paper_based" : "1"}
For more details on Instructions Parameters click here
show_ocr_formRequired: No
Type: boolean
Accepted Values: 0, 1
default value: 1
The default value for this is 1. If this is set to 0, the user will not be shown the OCR form to validate the extracted information. This can be used within the Document, Document Two, and Address service. This value can also be applied to all services collectively. However, preference will be given to the value set within the service.

Note: Setting the value at 0 may cause data inaccuracy as the user does not have option to validate the extracted information.
verification_modeRequired: No
Type: string
Accepted Values: any, image_only, video_only
This key specifies the types of proofs that can be used for verification. In the "video_only" mode, Shufti Pro's client is restricted to submitting "Base64" encoded videos, which must be in the MP4 or MOV format. The "any" mode allows a combination of images and videos to be submitted as proofs for verification. If there is a conflict between the service level key and the general level key, priority is assigned to the service level key.

document-service-sample-object
{
   "document_two"         : {
         "supported_types" : ["id_card","driving_license","passport"],
         "name"            : {
           "first_name" : "",
           "last_name"  : ""
         },
         "proof"                : "",
         "additional_proof"     : "",
         "dob"                  : "",
         "age"                  : "",
         "issue_date"           : "", 
         "expiry_date"          : "",
         "document_number"      : "",
         "allow_offline"        : "1",
         "fetch_enhanced_data"  : "1",
         "backside_proof_required" : "0",
         "verification_mode": "any",
         "gender"   : "",
         "show_ocr_form"        : "1"

     }
}

Address Service​

For address verification, a valid identity document is required with the same address printed on it as the one claimed by the end-user. The address can also be verified with the help of Utility Bills and Bank Statements. The address document will be displayed or uploaded by end-user directly for verification.


ParametersDescription
proofRequired: No
Type: string
Image Format: JPG, JPEG, PNG, PDF Maximum: 16MB
Video Format: MP4/MOV Maximum: 20MB
supported_typesRequired: No
Type: Array
Provide any one, two or more document types in proof parameter in Address verification service. For example, if you choose id_card and utility_bill, then the user will be able to verify data using either of these two documents. Please provide only one document type if you are providing proof of that document with the request. Following is the list of supported types for address verification is here.
Example 1 [ "utility_bill" ]
Example 2 [ "id_card", "bank_statement" ]
full_addressRequired: No
Type: string
Minimum: 6 characters
Maximum: 250 chracters
Allowed Characters are numbers, alphabets, dots, dashes, spaces, underscores, hashes and commas.
address_fuzzy_matchRequired: No
Type: string
Accepted Values: 0, 1
Default Value: 0
Provide 1 for enabling a fuzzy match for address verification. Enabling fuzzy matching attempts to find a match which is not 100% accurate. Default value will be 0, which means that only 100% accurate address will be verified.
issue_dateRequired: No
Type: string
Format: yyyy-mm-dd
Provide a valid date.
Example 2015-12-31
nameRequired: No
Type: object
In name object used in document service, first_name is required if you don't want to perform OCR of the name parameter. Other fields are optional.
Example 1 { "first_name" : "John", "last_name" : "Doe" }
Example 2 { "first_name" : "John", "last_name" : "Doe", "fuzzy_match" : "1"}
Parameters for name are listed here
backside_proof_requiredRequired: No
Type: string
Accepted Values: 0, 1
Default Value: 0
If the value of this parameter is set to 1, Shufti Pro will require the end-user to capture/upload both sides of the document to verify the identity. Enabling this parameter will also activate the front and back sides document match feature, which will verify if captured/uploaded front and back sides belong to the same document.
verification_instructionsRequired: No
Type: Object
This key allows clients to provide additional instruction for the service (document, document_two and address service). Such as if the client wants to allow paper-based, photocopied or laminated documents for verification.
Example {"allow_paper_based" : "1"}
For more details on Instructions Parameters click here
show_ocr_formRequired: No
Type: boolean
Accepted Values: 0, 1
default value: 1
The default value for this is 1. If this is set to 0, the user will not be shown the OCR form to validate the extracted information. This can be used within the Document, Document Two, and Address service. This value can also be applied to all services collectively. However, preference will be given to the value set within the service.

Note: Setting the value at 0 may cause data inaccuracy as the user does not have option to validate the extracted information.
verification_modeRequired: No
Type: string
Accepted Values: any, image_only, video_only
This key specifies the types of proofs that can be used for verification. In the "video_only" mode, Shufti Pro's client is restricted to submitting "Base64" encoded videos, which must be in the MP4 or MOV format. The "any" mode allows a combination of images and videos to be submitted as proofs for verification. If there is a conflict between the service level key and the general level key, priority is assigned to the service level key.

address-service-sample-object
{
   "address" : {
       "supported_types"     : ["id_card","bank_statement"],
       "proof"               : "", 
       "name"                : "",
       "issue_date"          : "",
       "full_address"        : "",
       "address_fuzzy_match" : "1",
       "backside_proof_required" : "0",
       "show_ocr_form"       : "1",
       "verification_mode": "any"
   }
}

Customised documents/notes can also be verified by Shufti Pro. Company documents, employee cards or any other personalised note can be authenticated by this module. You can choose handwritten or printed document format but only one form of document can be verified in this verification module. Text whose presence on the note/customized document is to be verified, is also needed to be provided. The consent document will be displayed or uploaded by end-user directly for verification.


ParametersDescription
proofRequired: No
Type: string
Image Format: JPG, JPEG, PNG, PDF Maximum: 16MB
Video Format: MP4/MOV Maximum: 20MB
supported_typesRequired: No
Type: Array
Text provided in the consent verification can be verified by handwritten documents or printed documents. Supported types are listed here
Example 1 ["printed"]
Example 2 ["printed", "handwritten"]
textRequired: Yes
Type: string
Minimum: 2 characters
Maximum: 100 chracters
Provide text in the string format which will be verified from a given proof.
allow_offlineRequired: No
Type: string
Accepted Values: 0, 1
Default Value: 1
This parameter allows user to upload their Consent Document (Handwritten Note/printed document) in case of non-availability of a functional webcam. If value is 0, users can only perform Consent Verification with the camera only.
allow_onlineRequired: No
Type: string
Accepted Values: 0, 1
Default-Value: 1
This parameter allows users to capture their Consent in real-time when internet is available. If value: 0 users can upload already captured Consent.

Note: if allow_offline: 0 priority will be given to allow_offline
with_faceRequired: No
Type: string
Accepted Values: 0, 1
Default Value: 1
This parameter is applicable if supported_type is handwritten and default value is 1. If value of with_face is 1 then hand written note will be accepted only with face which means your customer must need to show his/her face along with the consent on a paper. If value of with_face is 0 then hand written note is accepted with or without face.
verification_modeRequired: No
Type: string
Accepted Values: any, image_only, video_only
This key specifies the types of proofs that can be used for verification. In the "video_only" mode, Shufti Pro's client is restricted to submitting "Base64" encoded videos, which must be in the MP4 or MOV format. The "any" mode allows a combination of images and videos to be submitted as proofs for verification. If there is a conflict between the service level key and the general level key, priority is assigned to the service level key.

consent-service-sample-object
{
    "consent" : {
          "proof"            : "",
          "supported_types"  : ["printed"],
          "text"             : "",
          "allow_offline"    : "1",
          "allow_online"     : "1",
          "verification_mode": "any"
      }
}

Phone Service​

Verify the phone number of end-users by sending a random code to their number from Shufti Pro. Once the sent code is entered into the provided field by end-user, phone number will stand verified. It is primarily an on-site verification and you have to provide phone number of the end-user to us, in addition to the verification code and the message that is to be forwarded to the end-user. Shufti Pro will be responsible only to send the message along with verification code to the end-user and verify the code entered by the end-user.

Verification is declined if a user enters the wrong code consecutively for five times.

If the user is unable to receive code then, user is provide with Code not received option if user clicks the “Code not received” option the verification will be declined automatically (because either the phone number was wrong or unreachable).


ParametersDescription
phone_numberRequired: No
Type: string
Minimum: 6 characters
Maximum: 64 chracters
Allowed Characters: numbers and plus sign at the beginning. Provide a valid customer’s phone number with country code. Shufti Pro 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 chracters
Provide a random code. If this field is missing or empty, Shufti Pro will generate a random code.
textRequired: No
Type: string
Minimum: 2 characters
Maximum: 100 chracters
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 Pro will generate a random code and append the code with this message at the end.

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

Email Verification Service​

Verify the email addresses of end-users by sending a unique code to the provided email address. The End-user is then prompted to enter the code into the designated field. Subsequently, our system conducts a validation check to ascertain the authenticity of the provided email address, whether the provided email address is real or potentially fake/temporary. If the email address is real, it will stand verified. It is primarily an on-site verification and end-user have to provide their email address to Shufti Pro.

Shufti Pro will be responsible only to send the unique code to the end-user and verify the code entered by the end-user.

caution

Verification is declined if a user enters the wrong code consecutively for five times.


ParametersDescription
emailRequired: No
Type: email
Maximum: 128 chracters
Allowed Characters: Kindly ensure that email addresses adhere to the standard conventions, including valid characters such as letters, numbers, and symbols like '@' and '.'.

email-verification-service-sample-object
{
  "email_verify" : {
      "email"    : ""
  }
}

Background Checks Service​

It is a verification process that will require you to send us the full Name of end-user in addition to date of birth. Shufti Pro will perform AML based background checks based on this information. Please note that the name and dob keys will be extracted from document service if these keys are empty.


ParametersDescription
dobRequired: No
Type: string
Format: yyyy-mm-dd
Provide a valid date.
Example 1990-12-31

Note: It is recommended to send dob for more accurate results.
nameRequired: No
Type: object
In name object used in background checks service, first_name required and other fields are optional. Parameters for name are listed here:
Example 1 { "first_name" : "John", "last_name" : "Doe"}
Example 2 { "first_name" : "John", "middle_name" : "Carter", "last_name" : "Doe"}
Example 3 { "full_name" : "John Carter Doe"}

Note: If full name is provided with first and last name priority will be given to full name.
ongoingRequired: No
Accepted values: 0, 1
Default: 0
This Parameter is used for Ongoing AML Screening, and is allowed only on Production Accounts. If Shufti Pro detects a change in AML statuses, then we will send you a webhook with event verification.status.changed. The new AML status can be checked using get status endpoint, or from the back-office. Use fuzzy_match = 1 in the name object for better results for Ongoing AML Screening.
filtersRequired: No
Type: Array
Default: ["sanction", "warning", "fitness-probity", "pep", "pep-class-1", "pep-class-2", "pep-class-3", "pep-class-4"]

This key includes specific filter types, namely, alert or warning, that are linked to the AML search. Use these filters within the search to refine and narrow down the results. All filter types are listed here

background_checks-service-sample-object
{
  "background_checks" : {
    "name" : {
      "first_name"  : "",
      "middle_name" : "",
      "last_name"   : ""
    },
    "dob"  : "",
    "filters" : ["sanction", "fitness-probity", "warning", "pep"]
  }
}

background_checks-service-sample-object
{
  "background_checks" : {
    "name" : {
      "full_name"  : "John Carter Doe"         
    },
    "dob"  : "1995-10-10",
    "filters" : ["sanction", "fitness-probity", "warning", "pep"]
  }
}

background_checks-service-sample-object
{
  "background_checks" : {
    "name" : {
      "first_name"  : "John",
      "middle_name" : "Carter",
      "last_name"   : "Doe"
    },
    "filters" : ["sanction", "fitness-probity", "warning", "pep"]
  }
}

Know Your Business Service​

Shufti Pro verifies millions of businesses in real-time through its KYB services. The KYB verification includes an in-depth screening of Ultimate Beneficial Owners (UBOs) and company registration documents. Develop trustworthy business relationships through in-depth screening of your prospects.

To access a detailed overview of the request parameter, please click on the following link.


Enhance Due Diligence Service​

Shufti Pro offers its clients a enhance due diligence service that helps them collect additional information from their customers. The service allows you to create a questionnaire that includes multiple questions with different answer types to choose from, including drop-downs, radio buttons, CSV files, text, integers, float values, etc. Shufti Pro’s clients have the option to use questionnaires with or without KYC service.


ParametersDescription
uuidRequired: Yes
Type: array
Example 1: ["example_uuid_1"]
Example 2: ["example_uuid_1","example_uuid_2"]
The UUID parameter is an array that takes one or multiple UUIDs (max five) in the array to execute the enhance due diligence service for your end users.
questionnaire_typeRequired: No
Type: string
Accepted Values: pre_kyc, post_kyc
Default-Value: pre_kyc
The questionnaire type parameters tell whether you want to execute the questionnaire for your end-users before KYC ("pre_kyc") or after KYC ("post_kyc").

enhance-due-diligence-service-sample-object
{
    "questionnaire": {
    "questionnaire_type": "pre_kyc",
    "uuid": [
            "TZJAEG","XYZABC"
        ]
    }
}