shuftipro_flutter_sdk 1.0.1
shuftipro_flutter_sdk: ^1.0.1 copied to clipboard

ShuftiPro Flutter Package.

What is Shufti Pro? #

Shufti Pro is an AI-based identity verification SaaS (Software as a Service) provider that offers real-time global identity verifications for seamless KYC/AML and KYB compliance.

It provides businesses with a sound risk-cover and helps prevent fraud with its automated identity verification services including face verification, document verification, consent verification, address verification, biometric consent verification, phone verification, background checks, and 2-factor authentication.

AML screening services enable clients to gain an extra layer of security, by scanning cybercriminals and fraudsters at the source.

An easy to integrate API allows smooth customer onboarding and establishes longstanding trust while optimising customer processing costs altogether.

Shufti Pro is the go-to ID authentication solution for digital payment systems, FinTech firms, Cryptocurrency, banks, and trading platforms. Businesses can eradicate financial risk and digital ID theft, and boost operating efficiency all in a matter of seconds.

Table of contents #

General Requirements #

Minimum requirements for SDK include:

  • Android 5.0 (API level 21) or higher
  • Internet connection
  • Camera

Permissions: #

The Shufti Pro application requires permission from your device to access the following:

  1. Camera
  2. External Storage. All permissions are handled in SDK.

SDK Installation Guide #

In your Project follow the steps given below.

  1. Run this command: "dart pub add shuftipro_flutter_sdk" with dart or "flutter pub add shuftipro_flutter_sdk" with flutter
  2. Add dependency in pubspec.yaml as dependencies: shuftipro_flutter_sdk: ^1.0.1
  3. Import this 'package:shuftipro_flutter_sdk/ShuftiPro.dart' in your class in order to send the request to ShuftiPro's SDK.

Verifications: #

Shufti Pro offers three Verification services. You have the option to choose either all three or any one of them for mobile verification of your end-users.

Following is a list of all verification services, along with verification request parameters and other technical details.

  • With OCR #

    During verification with OCR, an end-user simply provides identity documents to Shufti Pro for authentication. The automated Shufti Pro API extracts credentials from the provided documents and verifies them as part of a single identity process.

  • Without OCR #

    During verification without OCR, Shufti Pro customer or end-user is required to provide not only the verification data but also the proof of that data in the form of identity documents.

  • Verification through hybrid view #

    If you opt for mobile verification with Shufti Pro’s hybrid view, a web-view built upon HTML 5 will be displayed to the end-user. All data points and fields are adequately defined in the hybrid view. The format for sending verification data will be a JSON object, similar to other mobile verification formats (OCR and Non-OCR). If you send true in the openWebView parameter then verification through hybrid view will be started, else verification with OCR or without OCR (based upon JSON object) will be triggered.

Integration: #

Take a look at the sample project and learn the most common use of framework/SDK. Make sure to build on a real device.

Make AuthKeys object using Clint ID and Secret Key

        var authObject = {
          "auth_type": "basic_auth",
          "client_id": clientId,
          "secret_key": secretKey,
        };


Or AuthKeys object using AccessToken

        var authObject = {
          "auth_type": "access_token",
          "access_token": accessToken,
        };

AuthKeys object parameters are explained here.


Request Object With OCR #

        //Creating Payload

          Map<String, Object> createdPayload = {
            "country": "US",
            "reference": "12345678",
            "language": "EN",
            "email": "",
            "callback_url": "http://www.example.com",
            "redirect_url": "https://www.dummyurl.com/",
            "verification_mode": "image_only",
            "show_consent": 1,
            "show_results": 1,
            "show_privacy_policy": 1,
            "open_webView": false,
          };

        //Creating Verification Object

        Map<String, Object> verificationObj = {
            "face": {},
            "background_checks": {},
            "phone": {},
            "document": {
              "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": "",
              "gender": "",
              "backside_proof_required": "1",
            },
            "document_two": {
              "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": "",
              "gender": "",
              "backside_proof_required": "0",
            },
            "address": {
              "full_address": "",
              "name": {
                "first_name": "",
                "last_name": "",
                "middle_name": "",
                "fuzzy_match": "",
              },
              "supported_types": ["id_card", "utility_bill", "bank_statement", "passport", "driving_license"],
            },
            "consent": {
              "supported_types": ["printed", "handwritten"],
              "text": "My name is John Doe and I authorize this transaction of \$100/-",
            },
          };

        //Adding Face Verification Service to Payload

        createdPayload["face"] = verificationObj['face'];

        //Adding Document Verification Service to Payload

        createdPayload["document"] = verificationObj['document'];

        //Adding Document Two Verification Service to Payload

        createdPayload["document_two"] = verificationObj['document_two'];

        //Adding Address Verification Service to Payload

        createdPayload["address"] = verificationObj['address'];

        //Adding Consent Verification Service to Payload

        createdPayload["consent"] = verificationObj['consent'];

Request Object Without OCR #


        //Creating Payload

          Map<String, Object> createdPayload = {
            "country": "US",
            "reference": "12345678",
            "language": "EN",
            "email": "",
            "callback_url": "http://www.example.com",
            "redirect_url": "https://www.dummyurl.com/",
            "verification_mode": "image_only",
            "show_consent": 1,
            "show_results": 1,
            "show_privacy_policy": 1,
            "open_webView": false,
          };

        //Creating Verification Object

        Map<String, Object> verificationObj = {
            "face": {},
            "background_checks": {},
            "phone": {},
            "document": {
              "supported_types": [
                "passport",
                "id_card",
                "driving_license",
                "credit_or_debit_card",
              ],
              "name": {
                "first_name": "Johon",
                "last_name": "Johsan",
                "middle_name": "Livone",
              },
              "dob": "",
              "document_number": "19901112",
              "expiry_date": "1996-11-12",
              "issue_date": "1990-11-12",
              "gender": "M",
              "backside_proof_required": "1",
            },
            "document_two": {
              "supported_types": [
                "passport",
                "id_card",
                "driving_license",
                "credit_or_debit_card"
              ],
              "name": {"first_name": "Johon", "last_name": "Johsan", "middle_name": "Livone"},
              "dob": "",
              "document_number": "19901112",
              "expiry_date": "1996-11-12",
              "issue_date": "1990-11-12",
              "gender": "M",
              "backside_proof_required": "0",
            },
            "address": {
              "full_address": "ST#2, 937-B, los angeles.",
              "name": {
                "first_name": "Johon",
                "last_name": "Johsan",
                "middle_name": "Livone",
              },
              "supported_types": ["id_card", "utility_bill", "bank_statement", "passport", "driving_license"],
            },
            "consent": {
              "supported_types": ["printed", "handwritten"],
              "text": "My name is John Doe and I authorize this transaction of \$100/-",
            },
          };

        //Adding Face Verification Service to Payload

        createdPayload["face"] = verificationObj['face'];

        //Adding Document Verification Service to Payload

        createdPayload["document"] = verificationObj['document'];

        //Adding Document Two Verification Service to Payload

        createdPayload["document_two"] = verificationObj['document_two'];

        //Adding Address Verification Service to Payload

        createdPayload["address"] = verificationObj['address'];

        //Adding Consent Verification Service to Payload

        createdPayload["consent"] = verificationObj['consent'];

Request Object parameters are explained here.


Initiate Request #

        new ShuftiPro(
            authObject: authObject,
            createdPayload: createdPayload,
            async: false,
            callback: (res) {
                response = res.toString();
            },
        homeClass: MyHomePage())


AuthKey Object Parameters #

In this object, we add authorization Key in verification request.

  • Basic Auth #

    Shufti Pro provides Authorization to clients through the Basic Auth header. Your Client ID will serve as your Username while the Secret Key will serve as your Password. The API will require this header for every request.
  • Access Token #

    Shufti Pro provides Bearer Access Token Authorization method. The client can generate the temporary access token using new access token endpoint. The shared token will be used to authorize API requests. The token shared with the client will be valid for 10 minutes and can be used once only.

  • open_webview #

    Required: No
    Type: boolean
    Accepted Values: true, false

    This boolean type of parameter is used to identify if you want to perform verification in its hybrid view. If open_webview is true, it means that the user wants verification in the hybrid view. If false, then the user wants verification with OCR or Without OCR. The value is false by default.

  • async #

    Required: No
    Type: boolean
    Accepted Values: true, false

    If asyncRequest value is set to TRUE you will instantly get the end-user's control back, so you do not have to wait for the verification results. When a request is completed you will automatically get a callback.

  • captureEnabled #

    Required: No
    Type: boolean
    Accepted Values: true, false

    This boolean type of parameter is used to identify whether the user wants to open native camera in Iframe or not. A true value means that the user wants to open native camera, otherwise not.


Request Object Parameters #

It is important to note here that each verification option offered by Shufti Pro is an exclusive service, and is activated following the nature of user’s request. Clients can choose one or all of the optional API keys.

In case a key is given in document and address verification, and no value is provided, then OCR will be performed for those particular keys.

  • reference #

    Required: Yes
    Type: string
    Minimum: 6 characters
    Maximum: 250 characters

    This is the unique reference ID of request, which we will send you back with each response, so you can verify the request. Only alphanumeric values are allowed. This reference can be used to get the status of already performed verification requests.

  • country #

    Required: No
    Type: string
    Length: 2 characters

    Send the 2 characters long ISO 3166-1 alpha-2 country code of where your customer is from. Please consult Supported Countries for country codes.

  • language #

    Required: No
    Type: string
    Length: 2 characters

    Send the 2 characters long language code of your preferred language to display the verification screens accordingly. Please consult Supported Languages for language codes. Default language english will be selected if this key is missing in the request.

  • email #

    Required: No
    Type: string
    Minimum: 6 characters
    Maximum: 128 characters

    This field represents email of the end-user. This is an optional field.

  • callback_url #

    Required: No
    Type: string
    Minimum: 6 characters
    Maximum: 250 characters

    During a verification request, we make several server to server calls to keep you updated about the verification state. This way you can update the request status at your end even if the customer is lost midway through the process.

  • verification_mode #

    Required: No
    Type: string
    Accepted Values: image_only, video_only

    Verification mode defines what types of proofs are allowed for a verification. In case of video_only, the user will upload videos and if verification mode is image_only, user will upload images.

  • show_privacy_policy #

    Required: No
    Type: string
    Accepted Values: 0, 1

    This key specifies whether to show privacy policy or not.If show_privacy_policy is 0, then privacy policy is not shown. And if it is set to 1 then privacy policy is displayed to the user on the result screen.

  • show_results #

    Required: No
    Type: string
    Accepted Values: 0, 1

    This key specifies whether the verification results will be displayed to the user or not. .If show_results is 0, then verification results are not shown to the user and sent to the merchant. If show_results is 1, then verification results are shown to the user.

  • Required: No
    Type: string
    Accepted Values: 0, 1

    This key specifies if the consent is shown to the user or not. If show_consent is 0, then the consent screen is not shown to the user. If show_consent is 1, then consent is shown to the user at the start of the verification.

  • Face #

    The easiest of all verifications is done by authenticating the face of the user. For this verification, the user has to upload a live image of their face for verification.

  • Document or Document 2 #

    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.

    • proof

    Required: Yes
    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_proof

    Required: 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_types

Required: Yes
Type: Array

You can provide anyone, two or more types of documents to verify the identity of the 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. All supported types are listed below.

Supported Types
passport
id_card
driving_license
credit_or_debit_card

Example 1 ["driving_license"]
Example 2 ["id_card", "credit_or_debit_card", "passport"]

  • name

Required: No
Type: object

In the name object used in document service, first_name and last_name are extracted from the document uploaded.

  • first_name

    Required: No
    Type: string
    Minimum: 2 characters
    Maximum: 32 characters

Allowed Characters are alphabets, - (dash), comma, space, dot and single quotation mark. Example John'O Harra

  • middle_name

Required: No
Type: string
Minimum: 2 characters
Maximum: 32 characters

Allowed Characters are alphabets, - (dash), comma, space, dot and single quotation mark.
Example Carter-Joe

  • last_name

Required: No
Type: string
Minimum: 2 characters
Maximum: 32 characters

Allowed Characters are alphabets, - (dash), comma, space, dot and single quotation mark. Example John, Hurricane Jr.

  • fuzzy_match

Required: No
Type: string
Value Accepted: 1

Provide 1 for enabling a fuzzy match of the name. Enabling fuzzy matching attempts to find a match which is not 100% accurate.

  • dob

Required: No
Type: string
Format: yyyy-mm-dd

Leave empty to perform data extraction from uploaded proofs. Provide a valid date. Please note that the date should be before today. Example 1990-12-31

  • document_number

Required: No
Type: string
Minimum: 2 characters
Maximum: 100 characters

Leave empty to perform data extraction from the proof which will be uploaded by end-users. Allowed Characters are numbers, alphabets, dots, dashes, spaces, underscores, and commas. Examples 35201-0000000-0, ABC1234XYZ098

  • issue_date

Required: No
Type: string
Format: yyyy-mm-dd

Leave empty to perform data extraction from the proof which will be uploaded by end-users. Provide a valid date. Please note that the date should be before today. Example 2015-12-31

  • expiry_date

Required: No
Type: string
Format: yyyy-mm-dd

Leave empty to perform data extraction from the proof which will be uploaded by end-users. Provide a valid date. Please note that the date should be after today. Example 2025-12-31

  • fetch_enhanced_data

Required: No
Type: string
Accepted value: 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) Extracted 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

  • Address #

    Address of an individual can be verified from the document but they have to enter it before it can be verified from an applicable document image.

  • proof

Required: Yes
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_types

Required: Yes
Type: Array

Provide any one, two, or more document types in supported_types 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. Following is the list of supported types for address verification.

Supported Types
id_card
passport
driving_license
utility_bill
bank_statement
rent_agreement
employer_letter
insurance_agreement
tax_bill

Example 1 [ "utility_bill" ]
Example 2 [ "id_card", "bank_statement" ]

  • full_address

Required: No
Type: string
Minimum: 2 characters
Maximum: 250 characters

Leave empty to perform data extraction from the uploaded proof. Allowed Characters are numbers, alphabets, dots, dashes, spaces, underscores, hashes and commas.

  • name

Required: No
Format object

In the name object used in address service, first_name is required if you don't want to perform OCR of the name parameter. Other fields are optional.

  • first_name

Required: No
Type: string
Minimum: 2 characters
Maximum: 32 characters

Allowed Characters are alphabets, - (dash), comma, space, dot and single quotation mark. Example John'O Harra

  • middle_name

Required: No
Type: string
Minimum: 2 characters
Maximum: 32 characters

Allowed Characters are alphabets, - (dash), comma, space, dot and single quotation mark.
Example Carter-Joe

  • last_name

Required: No
Type: string
Minimum: 2 characters
Maximum: 32 characters

Allowed Characters are alphabets, - (dash), comma, space, dot and single quotation mark. Example John, Hurricane Jr.

  • fuzzy_match

Required: No
Type: string
Value Accepted: 1

Provide 1 for enabling a fuzzy match of the name. Enabling fuzzy matching attempts to find a match which is not 100% accurate.

  • 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 the document can be verified in this verification module. Text whose presence on the note/customised document is to be verified is also needed to be provided.

    • proof

    Required: Yes
    Type: string
    Image Format: JPG, JPEG, PNG, PDF Maximum: 16MB
    Video Format: MP4/MOV Maximum: 20MB

    • supported_types

    Required: Yes
    Type: array

    Text provided in the consent verification can be verified by handwritten documents or printed documents.

    Supported Types
    handwritten
    printed

    Example 1 ["printed"]
    Example 2 ["printed", "handwritten"]

    • text

    Required: Yes
    Type: string
    Minimum: 2 characters
    Maximum: 100 characters

    Provide text in the string format which will be verified from the document which the end-user will provide us.

    • with_face

    Required: 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 the value of with_face is 1, then hand-written note will be accepted only with face which means your customer must 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.

  • Phone #

    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 the end-user, a phone number will stand verified. It is primarily an on-site verification and you have to provide the phone number of 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.

    • phone_number

    Required: No
    Type: string
    Minimum: 2 characters
    Maximum: 64 characters

    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_code

    Required: No
    Type: string
    Minimum: 2 characters
    Maximum: 10 characters

    Provide a random code. If this field is missing or empty. Shufti Pro will generate a random code.

    • text

    Required: No
    Type: string
    Minimum: 2 characters
    Maximum: 100 characters

    Provide a short description and random code in this field. This message will be sent to customers. This field should contain random_code. If the random_code field is empty then Shufti Pro will generate a random code and append the code with this message at the end.

  • Background_checks #

    It is a verification process that will require you to send us the full name of end-user in addition to the 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.

    • name

    Required: No
    Format: object

    In the name object used in background checks service, first_name is required and other fields are optional.

    • first_name

    Required: No
    Type: string
    Minimum: 2 characters
    Maximum: 32 characters

    Allowed Characters are alphabets, - (dash), comma, space, dot and single quotation mark. Example John'O Harra

    • middle_name

    Required: No
    Type: string
    Minimum: 2 characters
    Maximum: 32 characters

    Allowed Characters are alphabets, - (dash), comma, space, dot and single quotation mark.
    Example Carter-Joe

    • last_name

    Required: No
    Type: string
    Minimum: 2 characters
    Maximum: 32 characters

    Allowed Characters are alphabets, - (dash), comma, space, dot and single quotation mark. Example John, Hurricane Jr.

    • dob

    Required: No
    Type: string
    Format: yyyy-mm-dd

    Provide a valid date. Please note that the date should be before today. Example 1990-12-31


HTTP Codes #

Following is a list of HTTP codes which are generated in responses by Shufti Pro Verification API.

HTTP codeHTTP messageMessage
200OKsuccess
400Bad Requestbad request: one or more parameter is invalid or missing
401Unauthorizedunauthorized: invalid signature key provided in the request
402Request Failedinvalid request data: missing required parameters
403Forbiddenforbidden: service not allowed
404Not Foundresource not found
409Conflictconflicting data: already exists
500Server Errorinternal server error

Response Logging #

Response of the verification can be obtained via the code given below.


        callback: (res) {
            Response = res
        }

Status Response #

The Shufti Pro Verification API will send a JSON response if a status request is made.

  • reference

    This is the user’s unique request reference provided at the time of request, in order for the unique response to be identified.

  • event

    The request event shows the status of user’s request, and is different for every response. For more information, click here

Supported Document Types #

AddressDocument
id_cardid_card
passportpassport
driving_licensedriving_license
utility_billcredit_or_debit_card
bank_statement
rent_agreement
employer_letter
insurance_agre
tax_bill

Test IDs #

Shufti Pro provides users with a number of test documents. Customers may use these to test the demo, instead of presenting their actual information.

Contact #

If you have any queries regarding the implementation of SDK, please feel free to contact Shufti Pro tech support.

2017-21 © Shufti Pro Ltd.

Revision History #

DateDescription
26 Jul 2021Added all verifications(verification with OCR, without OCR and restful API) in one sdk.
28 Sep 2021Add new feature and improve user experience.