Skip to main content

Onsite Integration

With On-site verification, Shufti Pro directly interacts with the end-user, managing data collection to facilitate document signing. Document status updates are exclusively communicated to the Shufti Pro customer via the dedicated Shufti Pro Back Office.

info

The e-Signature service is available for Onsite only and before passing the esign object in the API, please make sure that you have copied the correct template_hash_id from the e-Signature Templates listed in Products Section.

Parameters and Descriptions

The parameters mentioned below apply to onsite verifications specifically for e-Signature payloads. Universal parameters integral to every verification request processed by Shufti Pro are listed in the General Parameters section.

ParametersDescription
contract_titleRequired: Yes
Type: string
Maximum: 60
Example: (contract_title: Partnership Agreement)
This parameter allows you to specify a suitable title for the e-Signature contract.
template_hash_idRequired: Yes
Type: string
Example: (template_hash_id: 1234abcd9iun)
The Template Hash Id is a unique identifier assigned to each template within the e-Signature service. This parameter is used to reference the template for execution.
recipients_dataRequired: Yes
Type: array
Maximum: 15
This parameter is an array containing an objects of recipient information. Each recipient object within the array specifies details about a single signer for the e-Signature contract. These recipient objects typically include: Role, Name, Email and Action.
roleRequired: No
Type: string
Maximum: 25
Example: (role: Director)
This optional parameter allows you to specify the recipient's role within the e-Signature contract.
nameRequired: Yes
Type: string
Maximum: 50
Example: (name: John Doe)
This parameter allows you to specify the recipient's full name for the e-Signature contract.
emailRequired: Yes
Type: string
Maximum: 70
Allowed Characters: Kindly ensure that email addresses adhere to the standard conventions, including valid characters such as letters, numbers, and symbols like '@' and '.'.
Example: (email: [email protected])
This parameter specifies the email address of the recipient who will be signing the e-Signature contract.
actionRequired: Yes
Type: string
Value: needs_to_sign or receives_a_copy
This parameter allows you to specify a specific action for the recipient within the e-Signature contract. The action would be either needs_to_sign or receives_a_copy.
Needs to Sign: This action indicates that the recipient needs to electronically sign the document.
Receives a Copy: This action indicates that the recipient should only receive a copy of the signed document
expiry_daysRequired: Yes
Type: number
Minimum: 1 (day)
Maximum: 999 (days)
Default: 7 (days)
This parameter allows you to specify the number of days for which the e-Signature request will remain valid for recipients. After this period, the signing link will expire, and recipients will no longer be able to access and sign the document.

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",
"esign" : {
"contract_title": "contract_title",
"template_hash_id": "12345678abcdefg12345678",
"recipients_data": [
{
"role": "role_title",
"name": "John Doe",
"email": "[email protected]",
"action": "needs_to_sign"
},
{
"role": "role_title_2",
"name": "John Doe",
"email": "[email protected]",
"action": "needs_to_sign"
},
{
"role": "role_title_3",
"name": "John Doe",
"email": "[email protected]",
"action": "receives_a_copy"
}
],
"expiry_days": 7,
}
}

e-Signature Single Recipient Sample Object

e-signature-single-recipient-sample-object
{
"esign": {
"contract_title": "unique_title",
"template_hash_id": "string_hashed_id",
"recipients_data": [
{
"role": "admin",
"action": "needs_to_sign",
"both": false,
"name": "John Doe",
"email": "[email protected]"
}
],
"expiry_days": 7,
}
}

e-Signature Multiple Recipients Sample Object

e-signature-multiple-recipients-sample-object
{
"esign": {
"contract_title": "unique_title",
"template_hash_id": "string_hashed_id",
"recipients_data": [
{
"role": "admin",
"action": "needs_to_sign",
"both": false,
"name": "John Doe",
"email": "[email protected]"
},
{
"role": "employee",
"action": "needs_to_sign",
"both": false,
"name": "John Doe",
"email": "[email protected]"
},
{
"role": "HR",
"action": "receives_a_copy",
"both": false,
"name": "John Doe",
"email": "[email protected]"
}
],
"expiry_days": 7,
}
}

e-Signature with Signer IDV Sample Object

e-signature-with-signer-idv-sample-object
{
"esign": {
"contract_title": "unique_title",
"template_hash_id": "string_hashed_id",
"recipients_data": [
{
"role": "admin",
"action": "needs_to_sign",
"both": false,
"name": "John Doe",
"email": "[email protected]"
},
{
"role": "HR",
"action": "receives_a_copy",
"both": false,
"name": "John Doe",
"email": "[email protected]"
}
],
"expiry_days": 7,
},
"face": {
"proof": "",
"check_duplicate_request": 0
},
"document": {
"proof": "",
"additional_proof": "",
"supported_types": ["id_card", "driving_license", "passport"],
"name": {
"first_name": "",
"last_name": ""
},
"dob": "",
"age": "",
"issue_date": "",
"expiry_date": "",
"document_number": "",
"allow_offline": "1",
"fetch_enhanced_data": "1",
"backside_proof_required": "0",
"verification_mode": "any",
"gender": ""
},
"phone": {
"phone_number": "",
"random_code": null,
"text": "Hi, Your code for verification is"
},
"background_checks": {
"name": {
"fuzzy_match": "1"
},
"dob": "",
"ongoing": "0",
"filters": [
"sanction",
"warning",
"fitness-probity",
"pep",
"pep-class-1",
"pep-class-2",
"pep-class-3",
"pep-class-4"
]
}
}
info

You can only use Face, Document, 2FA, and Background Screening services for identity verification with e-Signature, either separately or in combination.