Execute Related Person’s POI (In Case Related Person is Applicable)

9 min

Extraction API for Related Person’s POI documents

Endpoint

/api/onboardings/execute

Headers

Property	Value
Content-type	application/json
Authorization	…access token… (alphanumeric string of length 64)

Input

{
    "merchantId": ".......",
    "inputData": {
        "service": ".......",
        "type": ".......",
        "task": ".......",
        "data": {
            "images": ["..direct url of the images of one side(incase of driving licence and PAN ) or two sides (for others) .."],
            "toVerifyData": {},
            "searchParam": {},
            "proofType": "identity"
        }
    }
}

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)	“relatedIdentity”
– type	Enum String (Required)	“individualPan”/“aadhaar”/“passport”/“drivingLicence”/“voterid”
– task	Enum String (Required)	“autoRecognition”
– data	Object (Required)	payload
—- images	Array (Required) array of length 2(in case of 'aadhaar', 'voterid', 'passport'), length 1 (in case of PAN) and, length 1 or 2 (in case 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 URL of front Image and in case of Driving License pass URLs of either front or both sides of images.
—- proofType	Enum String (Required)	“identity”

Expected Output

In Case of PAN Card

{
    "object": {
        "result": {
            "name": "Name as on card",
            "fatherName": "Father's name as on card",
            "dob": "DOB as on card",
            "number": "number as on card"
        }
    }
}

In Case of Aadhaar Card

{
    "object": {
        "result": {
            "uid": "...00000000XXXX....masked first eight digit...",
            "vid": "...virtual UID...",
            "name": "...name on id card...",
            "yob": "...year of birth...",
            "dob": "...date of birth...",
            "pincode": "...pincode...",
            "address": "...address as on card...",
            "gender": "male/female",
            "splitAddress": {
                "district": [],
                "state": [
                    []
                ],
                "city": [],
                "pincode": " ",
                "country": [
                    "IN",
                    "IND",
                    "INDIA"
                ],
                "addressLine": ""
            },
            "uidHash": "Secure Cryptographic conversion of UID"
        }
    }
}

In Case of Driving License

{
    "object": {
        "result": {
            "issueDate": "date-of-issue",
            "dob": "dob",
            "expiryDate": "date-of-expiry",
            "name": "name",
            "number": "dl number",
            "guardianName": "name of guardian",
            "address": "address",
            "splitAddress": {
                "state": [
                    []
                ],
                "district": [],
                "city": [],
                "pincode": "...pincode...",
                "country": [
                    "IN",
                    "IND",
                    "INDIA"
                ],
                "addressLine": "...addressLine..."
            },
            "dlType": ["array-of-vehicle-class"]
        }
    }
}

In Case of Passport

{
    "object": {
        "result": {
            "parentsGuardianName": "..parentsGuardianName...",
            "issueDate": "..issueDate..",
            "expiryDate": "..expiryDate..",
            "birthDate": "..birthDate..",
            "name": "..name..",
            "country": [
                "..country.."
            ],
            "nationality": "..nationality..",
            "sex": "F/M",
            "address": "..address..",
            "pincode": "..pincode..",
            "passportNumber": "..passportNumber..",
            "fileNumber": "..fileNumber..",
            "placeOfBirth": "..placeOfBirth..",
            "placeOfIssue": "..placeOfIssue..",
            "splitAddress": {
                "district": [
                    "..district.."
                ],
                "state": [
                    [
                        "..state.."
                    ]
                ],
                "city": [
                    "..city.."
                ],
                "pincode": "..pincode..",
                "country": [
                    "IN",
                    "IND",
                    "INDIA"
                ],
                "addressLine": "..addressLine.."
            }
        }
    }
}

In Case of VoterId

{
    "object": {
        "result": {
            "epicNumber": "...epic number...",
            "name": "...name...",
            "fatherName": "...father name...",
            "state": "...state name...",
            "dob": "...date of birth...",
            "yob": "...year of birth...",
            "ageAsOn": "...age in year...",
            "address": "...address found on card...",
            "splitAddress": {
                "district": [
                    "...name of district..."
                ],
                "state": [
                    [
                        "...name of state...",
                        "WB"
                    ]
                ],
                "city": [
                    "...name of the city..."
                ],
                "pincode": "...pincode of the city...",
                "country": [
                    "IN",
                    "IND",
                    "INDIA"
                ],
                "addressLine": "...address line on the card..."
            }
        }
    }
}

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].