Parameters and Description
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.
caution
Additional charges are applicable for this feature.
| Parameters | Description |
|---|---|
| proof | Required: No Type: string Image Format: JPG, JPEG, PNG, PDF Maximum: 16MB Video Format: MP4/MOV Maximum: 20MB |
| supported_types | Required: 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_address | Required: Yes Type: string Minimum: 6 characters Maximum: 250 chracters Allowed Characters are numbers, alphabets, dots, dashes, spaces, underscores, hashes and commas. |
| address_fuzzy_match | Required: 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_date | Required: No Type: string Format: yyyy-mm-dd Provide a valid date. Example 2015-12-31 |
| name | Required: 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_required | Required: 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_instructions | Required: 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_form | Required: 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_mode | Required: 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. |
| 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 like document_type, document_country, address_validation, address_decomposition and calculated_distance. Note: The client can enable the specified keys individually by using the enhanced_address_verification key as an object. |
| 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. |
info
To check which countries are supported for enhanced address verification, please click here.