Skip to main content

Offsite Integration

In offsite verification process, Shufti Pro's clients are solely responsible for gathering all necessary proof from the end user and then submitting it to Shufti Pro for verification.

Parameters and Description​

ParametersDescription
proofRequired: Yes
Type: string
Image Format: JPG, JPEG, PNG, PDF Maximum: 16MB
Video Format: MP4/MOV Maximum: 20MB
supported_typesRequired: No
Type: Array
Text provided in the consent verification can be verified by handwritten documents or printed documents. Supported types are listed here.
Example 1 ["printed"]
Example 2 ["printed", "handwritten"]
textRequired: Yes
Type: string
Minimum: 2 characters
Maximum: 100 characters
Provide text in the string format which will be verified from a given proof.
Note: Text whose presence on the note/customized document is to be verified.
with_faceRequired: 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 value of with_face is 1 then hand written note will be accepted only with face which means your customer must need to 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.
verification_modeRequired: 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.

Run in Postman

consent-service-sample-object-offsite-with-ocr
{
  "consent": {
    "proof": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAgAAAALCAYAAABCm8wlAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH4QoPAxIb88htFgAAABl0RVh0Q29tbWVudABDcmVhdGVkIHdpdGggR0lNUFeBDhcAAACxSURBVBjTdY6xasJgGEXP/RvoonvAd8hDyD84+BZBEMSxL9GtQ8Fis7i6BkGI4DP4CA4dnQON3g6WNjb2wLd8nAsHWsR3D7JXt18kALFwz2dGmPVhJt0IcenUDVsgu91eCRZ9IOMfAnBvSCz8I3QYL0yV6zfyL+VUxKWfMJuOEFd+dE3pC1Finwj0HfGBeKGmblcFTIN4U2C4m+hZAaTrASSGox6YV7k+ARAp4gIIOH0BmuY1E5TjCIUAAAAASUVORK5CYII=",
    "supported_types": ["printed"],
    "text": "",
    "allow_offline": "",
    "verification_mode": "any"
  }
}