Execute POI
Extraction API for POI documents
POST /api/merchants/execute
Property | Value |
Content-type | application/json |
Authorization | <accesstoken> |
Property | Type | Description |
merchanId | String | Merchant Id |
inputData | Object | parameters for extraction |
— service | Enum: "identity", "relatedIdentity", "roc", "nonRoc", "video", "esign", "verificationEngine" | type of document extraction needs to run on |
— type | Enum: "individualPan", "businessPan", "aadhaar", "drivingLicence", "passport", "voterId" | document type |
— task | Enum: "autoRecognition" | Task type |
— data | Object | query parameters for extraction of data |
—— images | Array of strings | list of image URLs |
—— toVerifyData | Object | data to verify |
—— searchParam | Object | search parameters |
—— proofType | Enum: "identity", "relatedIdentity", "roc", "nonRoc", "video", "esign", "verificationEngine" | type of proof |
Property | Data Type | Example Values |
merchantId | String (Required) alphanumeric string of length 24 | userId from investor login response |
inputData | Object (Required) | Metadata along with actual payload to be executed upon |
-- service | Enum String (Required) | "identity" |
-- type | Enum String (Required) | "aadhaar" |
-- task | Enum String (Required) | "offlineAadhaar" |
-- data | Object (Required) | payload |
---- images | Array (Required) empty array | In the case of Offline Aadhaar pass empty array [] |
---- url | Enum String (Required) | "URL of zip or XML file " |
---- password | Enum String (Required) | "password of the zip file (Required only if the file is zip) " |
---- proofType | Enum String (Required) | "identity" |
POST /api/merchants/digilocker
Must hit the digilocker API twice,
- First with the task as createUrl.
- In response, will receive a URL to grant permission from DigiLocker to access the documents.
- After completion of the process, Hit the same API with the task as getDetails.
Property | Data Type | Example Values |
merchantId | String (Required) alphanumeric string of length 24 | userId from investor login response |
inputData | Object (Required) | Metadata along with actual payload to be executed upon |
-- service | Enum String (Required) | "identity" |
-- type | Enum String (Required) | "aadhaarDigiLocker” / “panDigiLocker” / “dlDigiLocker" |
-- task | Enum String (Required) | "createUrl” / “getDetails" |
-- proofType | Enum String (Required) | "identity" |
In case of DigiLocker(PAN/DL) 2nd Step, the response will be similar to the respective cards as mentioned above.
Getting help
Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.
You can reach out to us at [email protected].