What Is This?
Shufti Pro is a SaaS, that provides quick and accurate digital identity and document verification. E-KYC using government-issued documents like ID card, passport, driving license and even credit/debit cards, etc. has never been easier. Shufti Pro allows for simple and easy ID checks online, securing the virtual trading platforms and FinTech institutions against scams, frauds and money launderers.
Followings are minimum requirements for SDK:
- Internet connection
Supported architectures in SDK:
- armeabi-v7a, x86, arm64-v8a, x86_64
SDK Installation Guide
Installation through npm (Expo)
$ npm install expo-shuftipro-kyc --save`
We find it fair to share our
package.json dependencies with you! here are the main dependencies used inside Shuftipro.
- #### Dependencies in Expo
### Integration: See the sample project provided to learn the most common use. Make sure to build on real device.
- #### Expo
$ import ShuftiPro from ""
Make an instance
Instance can be made in two ways. First is by using clientId and secretKey, other one is by providing accessToken.
You can read more about accessToken here
In order to get verified, customers will have themselves verified through their mobile phones. They will do it through the merchant's mobile application. Merchant will collect the information and send us the data for verification. The Merchant shall provide us with the proofs(Videos). We will not collect them directly from the user.
- ### With OCR In verification with OCR, it means that the merchant has not provided us proofs (images/videos) and also no data in some keys. In this verification Shufti Pro will perform extraction of data from those proofs and finally verify the data.
const verificationObj =reference: "Unique reference"country: "GB"language: "EN"email: "email@example.com"callback_url: ""face: truedocument:supported_types"passport""id_card""driving_license""credit_or_debit_card"name:first_name: ""last_name: ""middle_name: ""dob: ""document_number: ""expiry_date: ""issue_date: ""fetch_enhanced_data: "1"address:full_address: ""name:first_name: ""last_name: ""middle_name: ""fuzzy_match: ""supported_types: "id_card" "utility_bill" "bank_statement"consent:format: "printed"text: "This is a customized text";
- ### Without OCR In verification without OCR, merchant gives us the data in keys as well as all the proofs required then Shufti Pro just have to verify the data. No customer interaction takes place in this kind of verification.
const verificationObj =reference: "Unique reference"country: "GB"language: "EN"email: "firstname.lastname@example.org"callback_url: ""face: truedocument:supported_types"passport""id_card""driving_license""credit_or_debit_card"name:first_name: "John"last_name: "Carter"middle_name: "Doe"dob: "1992-10-10"document_number: "2323-5629-5465-9990"expiry_date: "2025-10-10"issue_date: "2015-10-10"fetch_enhanced_data: "1"address:full_address: "3339 Maryland Avenue, Largo, Florida"name:first_name: "John"last_name: "Carter"middle_name: "Doe"fuzzy_match: "1"supported_types: "id_card" "utility_bill" "bank_statement"consent:format: "printed"text: "This is a customized text";
If async value is set to true you'll instantly get the user's control back so you don't have to wait for the verification results. When a request is completed you'll automatically get a callback.
async = "true"
This parameter specifies the types of proof that can be used for verification. If verificationMode value is set to image SDK will be capturing images. However by default it records videos as proofs for verification.
verificationMode = "image"
Parameters for request with OCR can be found here
Parameters for request without OCR can be found here
Response Status Codes
Shufti Pro Verification API uses conventional HTTP response codes to indicate the success or failure of an API request. Every response is generated in JSON with a specific HTTP code.
Following is a list of HTTP codes which are generated in responses by Shufti Pro Verification API.
|HTTP code||HTTP message||Message|
|400||Bad Request||bad request: one or more parameter is invalid or missing|
|401||Unauthorized||unauthorized: invalid signature key provided in the request|
|402||Request Failed||invalid request data: missing required parameters|
|403||Forbidden||forbidden: service not allowed|
|404||Not Found||resource not found|
|409||Conflict||conflicting data: already exists|
|500||Server Error||internal server error|
Events are sent in responses which show the status of request. These events are sent in both HTTP and callback responses.
|Event||description||HTTP Response||Callback Response|
|request.pending||Request parameters are valid and verification url is generated in case of on-site verification.||Yes||Yes|
|request.invalid||Request parameters provided in request are invalid.||Yes||Yes|
|request.cancelled||Request is cancelled by the user. This event occurs when end-user disagrees to terms and conditions before starting verifications.||Yes||Yes|
|request.timeout||Request has timed out after a specific period of time.||No||Yes|
|request.unauthorized||Request is unauthorized. The information provided in authorization header is invalid.||Yes||No|
|verification.accepted||Request was valid and accepted after verification.||Yes||Yes|
|verification.declined||Request was valid and declined after verification.||Yes||Yes|
Sample project setup
In Mode/VerificationSelector.js add your Client ID on line 13 and Secret Key on line 14, thats it!
Note: Run project on real device.
Shufti Pro provides the users with a number of test documents. Customers may use these to test the demo, instead of presenting their actual information.
If you have any questions/queries regarding implementation SDK please feel free to contact our tech support.
2016-20 © Shufti Pro Ltd.