Parameters and Description

Enhanced Data Extraction

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. Shufti Pro is the first digital identity verification service that can fetch a huge bunch of information efficiently in mere seconds.

caution

Additional charges are applicable for this feature.

This feature can be used with document and document_two services.

enhanced-data-extraction
{
    "fetch_enhanced_data" :"1"
}

Parameters	Description
fetch_enhanced_data	Required: No Type: string Value Accepted: 1 Provide 1 for enabling enhanced data extraction for the document. 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

Name

name is an object and contains the following parameters

name-sample-object
{
    "name" : {
        "first_name"  : "John",
        "middle_name" : "Carter",
        "last_name"   : "Doe",
        "fuzzy_match" : "1"
    }
}

name-sample-object
{
    "name" : {
        "full_name"   : "John Carter Doe",
        "fuzzy_match" : "1"
    }
}

Parameter	Description
first_name	Required: No Type: string Minimum: 1 character Maximum: 32 characters Allowed Characters are alphabets, - (dash), comma, apostrophe, space, dot and single quotation mark. Example: John'O Harra
middle_name	Required: No Type: string Minimum: 1 character Maximum: 32 characters Allowed Characters are alphabets, - (dash), comma, apostrophe, space, dot and single quotation mark. Example: Carter-Joe
last_name	Required: No Type: string Minimum: 1 character Maximum: 32 characters Allowed Characters are alphabets, - (dash), comma, apostrophe, space, dot and single quotation mark. Example: John, Huricane 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 a 100% accurate.
full_name	Required: No Type: string Minimum: 1 character Maximum: 64 characters Some countries don't have the identity document holder name as their first, middle or last name instead its written in full. In such cases, you may provide the full name.

Fuzzy & Exact Match Cases

Parameters	Description	Decision
Fuzzy_match : 0	The First and Last names are matched with the provided name. Example: Name on Document: Sample Caron Elizabeth Provided Name in API: Sample Elizabeth	Accepted
	An additional name is present within the provided name. Example: Name on Document:DOE JANE Provided Name in API: DOE JANE Elizabeth
	Repeated (First, Mid, or Last) name within the provided name. Example: Name on Document:DOE JANE Provided Name in API: DOE JANE DOE
	An additional character is present within the provided name. Example: Name on Document:DOE JANE Provided Name in API: DOEE JANEY Provided Name in API: DOE JAN Provided Name in API: DO JANE
	The First or Last name is different from the provided name. Example: Name on Document:DOE JANE Provided Name in API: DOE Elizabeth Provided Name in API: Jane Elizabeth	Declined
	Name initials are present instead of the complete name within the provided name. Example: Name on Document:Sample Caron Elizabeth Name passed in API: Sample C Elizabeth Name on Document: DOE JANE Name passed in API: D JANE Name passed in API: D J	Declined
fuzzy_match : 1	The First and Last names are matched with the provided name. Example: Name on Document:Sample Caron Elizabeth Name passed in API: Sample Elizabeth	Accepted
	An additional name is present within the provided name. Example: Name on Document:DOE JANE Name passed in API: DOE JANE Elizabeth
	Repeated (First, Mid, or Last) name within the provided name. Example: Name on Document:DOE JANE Name passed in API: DOE JANE DOE
	An additional character is present within the provided name. Example: Name on Document:DOE JANE Name passed in API: DOEE JANEY Name passed in API: DOE JAN Name passed in API: DO JANE
	Name initials are present instead of the complete name within the provided name.. Example: Name on Document: Sample Caron Elizabeth Name passed in API: Sample C Elizabeth Name on Document: DOE JANE Name passed in API: D JANE
	The First or Last name is different from the provided name. Example: Name on Document: DOE JANE Name passed in API: DOE Elizabeth Name passed in API: Jane Elizabeth	Declined
	Only Name initials are present within the provided name. Example: Name on Document: DOE JANE Name passed in API: D J	Declined

info

Identical Match[Strict Check]: Match the complete provided name with the name on the document for stringent verification. To enable strict checking, please reach out at [email protected] .

Age

Shufti Pro provides its clients with an option to configure the Age verification from within the API request. This service allows the acceptance of users within the specified age limits according to their DOB. The client can specify lower and upper limits and according to that, the user's age will be verified. In case, minimum and maximum values are not set, Shufti Pro will calculate and return Age according to the DOB. If DOB is not present on the document, the verification will decline as Age will not be verified
Age is an object or integer that can be used to set the lower and upper limit for the Age of the user according to DOB. It contains the following parameters. min is used to specify the lower limit whereas max is used to specify the upper limit.

age-sample-object
//Passing the value “18” in the age parameter means that, end-users of age 18 will stand verified.
{
    "age" : 18    
}

age-sample-object
{
    "age" : {
        "min"   : "17",
        "max" : "165"
    }
}

Parameters	Description
age	Required: No Type: integer/array Allowed values are integers or array. Example: 18
min	Required: No Type: integer Minimum Value: 1 Allowed values are integers or array. Example: 17
max	Required: No Type: integer Maximum Value: 170 Allowed values are integers or array. Example: 165

Address Verification V2

Shufti Pro provides its customers with two options for address verification.

Standard Address Verification
Enhanced Address Verification

info

To review all the reasons for address service decline, please click on the following link.

Standard Address Verification

Standard address verification is an improved version of the previous address verification process.

In Standard Address Verification, the following checks are performed:

Verification of the document's originality and visibility
Validation of the provided address against the one mentioned on the document
Ensuring that the document is not expired.

To ensure successful verification in standard address verification, it is crucial for the client to provide complete and accurate address information in the full_address field of the request Object

standard-address-verification-sample-object
{
    "address": {
        "proof": "",
        "full_address": "2601 Amphitheatre Pkwy, ZA, 58023",
        "address_fuzzy_match": "1"
    }
}

info

Standard Address Verification is the default address verification for clients onboarded after Sep 26, 2023. Clients who were onboarded before this date can continue to use the previous address verification process without any alterations.

Enhanced Address Verification

The enhanced address verification feature in Shufti Pro includes a new key named enhanced_address_verification that is passed in the address service. This key upgrades the address verification process to enhanced address verification and can take on either an integer or object value.

If the key value is an integer, it can only accept the values of 0 or 1.
If the key value is an object, the client can enable different features of enhanced address verification by passing respective keys inside the object with a value of 1.

Shufti Pro's enhanced address verification feature includes document_type, document_country, address decomposition, address validation, and distance calculation from the user's current location to the address mentioned on the document or provided in the request. Each key accepts a value of 0 or 1 to enable or disable the corresponding feature.

info

To check which countries are supported for enhanced address verification, please click here.

caution

Additional charges are applicable for this feature.

enhanced-address-verification-sample-object
//Passing the value "1" in the enhanced_address_verification parameter means that all features of enhanced address verification is enabled for the client.
{
    "address": {
        "proof": "",
        "supported_types": [
            "id_card",
            "bank_statement"
        ],
        "name": "",
        "issue_date": "",
        "full_address": "",
        "address_fuzzy_match": "1",
        "enhanced_address_verification": "1"
    }
}

enhanced-address-verification-sample-object
// for enabling specific features, client can use enhanced_address_verification key as an object
{
    "address": {
        "proof": "",
        "supported_types": [
            "id_card",
            "bank_statement"
        ],
        "name": "",
        "issue_date": "",
        "full_address": "",
        "address_fuzzy_match": "1",
        "enhanced_address_verification": {
            "document_type": "1",
            "document_country": "0",
            "address_validation": "1",
            "address_decomposition": "0",
            "calculated_distance": "1"
        }
    }
}

Parameters	Description
enhanced_address_verification	Required: No Type: string/Object Allowed values are string or Object. In case of string, allowed values are 0, 1. Default Value: 0 By passing the value "1" in the enhanced_address_verification parameter, the client can enable all the features of enhanced address verification.
document_type	Required: No Type: string Allowed values: 0, 1 Default value: 0 Enabling this parameter allows Shufti Pro to validate the type of document being processed.
document_country	Required: No Type: string Allowed values: 0, 1 Default value: 0 By activating this parameter, Shufti Pro verify the country mentioned on the document that is being processed.
address_validation	Required: No Type: string Allowed values: 0, 1 Default value: 0 By activating this parameter, Shufti Pro verifies whether the client's address is legitimate or not, i.e., whether the address actually exists.
address_decomposition	Required: No Type: string Allowed values: 0, 1 Default value: 0 When this parameter is enabled, Shufti Pro decomposes and formats the address, and includes it in the response if address is validated.
calculated_distance	Required: No Type: string Allowed values: 0, 1 Default value: 0 By enabling this parameter, Shufti Pro calculates the distance in kilometers between the user's current location and the address mentioned on the document or provided in the request, and returns it in the response if the address is validated.

Enhanced Data Extraction​

Name​

Fuzzy & Exact Match Cases​

Age​

Address Verification V2​

Standard Address Verification​

Enhanced Address Verification​

Enhanced Data Extraction

Name

Fuzzy & Exact Match Cases

Age

Address Verification V2

Standard Address Verification

Enhanced Address Verification