Execute Correspondence POA
Extraction API for POA documents
/api/merchants/execute
Property | Value |
Content-type | application/json |
Authorization | <access token> |
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" / "passport" / "drivingLicence" / "voterid" |
-- task | Enum String (Required) | "autoRecognition" |
-- data | Object (Required) | payload |
---- images | Array (Required) "array of length 2(incase of 'aadhaar', 'voterid', 'passport'), length 1 or 2 (incase of DL) with valid URLs." | An array of image URLs of the ID card, front and back in order. In the case of PAN, pass the URL of the front Image, and in the case of Driving License pass URLs of either front or both sides of images. |
---- proofType | Enum String (Required) | "corrAddress" |
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 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) | "corrAddress" |
/api/merchants/digilocker
Must hit the execute 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” / “dlDigiLocker" |
-- task | Enum String (Required) | "createUrl” / “getDetails" |
-- proofType | Enum String (Required) | "corrAddress" |
Incase of DigiLocker(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].