--- title: Pull Onboarding Detail slug: investor-onboarding-io/pull-onboarding-detail description: This document provides detailed information about endpoint /api/onboardings/pullonboardings, including required headers and input parameters for fetching onboardings. It covers customer information, verification details, ID cards, documents, video verific docTags: createdAt: 2023-06-19T12:35:34.000Z --- ## Endpoint POST **/api/onboardings/pullonboardings** ## Headers | **Property** | **Value** | | ------------- | ------------------------ | | Content-type | application/json | | Authorization | …channel’s access token… | ## Input (for Fetch by Onboarding Status) ```json { "channelId": "...channelId...", "limitLength": 10, "skipLength": 0, "status" : "accepted" } ``` | **Property** | **Data Type** | **Example Values** | | ------------ | ------------- | ------------------------------------------------------------------------ | | channelId | String | Channel Id | | limitLength | Integer | Limit to number of onboardings that are returned (helpful in pagination) | | skipLength | Integer | Skip these many onboardings before generating the list of onboardings | | status | String | Status of onboarding wanted to be pulled (all/pending/accepted/rejected) | ## Input (for Fetch by Onboarding Id) ```json { "channelId": "...channelId...", "onboardingId": "...onboardingId...", "extraFields" : ["..cams.."] } ``` | **Property** | **Data Type** | **Example Values** | | ------------ | --------------- | -------------------------------------------------------------------------- | | channelId | String | Channel Id | | onboardingId | String | Onboarding Id | | extraFields | Array(optional) | ExtraFields required to be appended in response (Possible values : 'CAMS’) | ## Expected Output ```json { "customerId": "....", "status": "....", "limitLength": "....", "skipLength": "....", "id": 4, "instanceId": "....", "result": [{ "email": "....", "phone": "....", "name": "....", "username": "....", "customerId": "....", "merchantId": "....", "status": "....", "reason": "....", "verificationData": { "idCards": [{ "type": "....", "purpose": [ "POI" ], "name": "....", "idNo": "....", "dob": "....", "address": "....", "state": "....", "issueDate": "....", "images": [ "...." ], "verificationStatus": { "verification": true, "message": "....", "isSet": 1 }, "faceExtraction": { "isSet": 1 } }, { "purpose": [ "POA" ], "name": "....", "idNo": "....", "dob": "....", "address": "....", "state": "....", "issueDate": "....", "images": [ "....", "...." ], "pincode": "....", "type": "....", "verificationStatus": { "isSet": 1 }, "faceExtraction": { "cropped": "....", "isSet": 1 } }], "documents": [{ "type": "....", "beneficiaryMobile": "....", "beneficiaryAccount": "....", "beneficiaryName": "....", "beneficiaryIFSC": "....", "images": [ "...." ] }, { "type": "....", "beneficiaryMobile": "....", "beneficiaryAccount": "....", "beneficiaryName": "....", "beneficiaryIFSC": "....", "images": [], "bankTransferOutput": { "active": "....", "nameMatch": "....", "mobileMatch": "....", "signzyReferenceId": "....", "auditTrail": { "nature": "....", "value": "....", "timestamp": "....Z" }, "bankTransfer": { "response": "....", "bankRRN": "....", "beneName": "....", "beneMMID": "....", "beneMobile": "....", "beneIFSC": "....9" } }, "verifyAmountOutput": { "amountMatch": "....", "owerName": "....", "mobile": "....", "mmid": "....1" } }], "video": { "url": "....", "matchImage": "....", "signzyVerifiableString": "....", "seconds": [ "00:00:02", "00:00:03", "00:00:04" ], "videoMatch": { "matchAudioScore": "....", "isSet": 1 }, "matchImageEla": { "task": "....", "essentials": { "url": "...." }, "id": "....", "patronId": "....", "result": "....", "isSet": 1 }, "forensics": { "staticRisk": { "staticPhoto": false, "ageGroup": "....", "isSet": 1 }, "videoLandMarks": { "result": "....", "isSet": 1 }, "videoFaceMatch": { "videoImages": [ "https://preproduction-persist.signzy.tech/api/files/64344/download/r2jhdPYWwVt3qgrEW6bbQA8EFML2QSyP7UNxzhlsnJbM2VC5kj.jpg", "https://preproduction-persist.signzy.tech/api/files/64345/download/BkENcX31h0HeVPqtPHUV7prEGOmSYjlznOI5sAlKrBy2ZGJgqn.jpg", "https://preproduction-persist.signzy.tech/api/files/64347/download/12KWSe9eJhh1Q517RaB4oz2SRXv3heFoaai9BM0ZzFPbAkOx4M.jpg" ], "finalMatchImage": "....", "matchStatistics": { "coVariance": "....", "matchPercentage": "....%" }, "isSet": 1 }, "exif": { "metadataFound": "....", "message": "....", "image": {}, "gps": {}, "isSet": 1 } }, "faceLandmarks": { "result": "....", "isSet": 1 } }, "contract": { "signedContract": "....f" }, "photo": {}, "fatca": { "pep": "....", "rpep": "....", "residentForTaxInIndia": "....", "relatedPerson": "....O" }, "signature": { "signatureImageUrl": "...." }, "formData": { "gender": "....", "maritalStatus": "....", "nomineeRelationShip": "....", "maidenTitle": "....", "motherTitle": "....", "occupationType": "....", "maidenName": "....", "motherName": "....", "applicationStatus": "....", "countryCode": 91, "emailId": "....", "pincode": 560078, "kycAccountType": "....", "mobileNumber": "....", "communicationAddress": "....", "nomineeTitle": "....", "nomineeName": "....A", "annualIncome": "... refer Table 1.8", "placeOfBirth": "...." }, "info": { "name": "....", "dob": "....", "emailId": "....", "phone": "....", "communicationAddress": "....", "permanentAddress": "...." } }, "formFilledData": { "identityProof": { "type": "....", "purpose": [ "POI" ], "name": "....", "idNo": "....", "dob": "....", "expiryDate": "....", "verify": "....", "address": "....", "state": "....", "issueDate": "....", "images": [ "...." ], "proofType": "....f" }, "addressProof": [{ "purpose": [ "POA" ], "name": "....", "idNo": "....", "dob": "....", "verify": "....", "address": "....", "expiryDate": "....", "state": "....", "issueDate": "....", "addressType": "....", "proofType": "....", "images": [ "....", "...." ], "pincode": "....", "type": "....t" }], "bankAccount": { "type": "....", "images": [ "...." ] }, "formFields": { "gender": "....", "maritalStatus": "....", "nomineeRelationShip": "....", "maidenTitle": "....", "motherTitle": "....", "occupationType": "....", "maidenName": "....", "motherName": "....", "applicationStatus": "....", "countryCode": 91, "emailId": "....", "pincode": 560078, "kycAccountType": "....", "mobileNumber": "....", "communicationAddress": "....", "nomineeTitle": "....", "nomineeName": "....A", "annualIncome": ".. refer Table 1.8", "placeOfBirth": "...." }, "fatca": { "pep": "....", "rpep": "....", "residentForTaxInIndia": "....", "relatedPerson": "....O" }, "signature": { "signatureImageUrl": "...." }, "photo": {}, "video": { "url": "....", "matchImage": "....", "signzyVerifiableString": "....", "seconds": [ "00:00:02", "00:00:03", "00:00:04" ] }, "contract": { "signedContract": "....f" } }, "verificationResult": { "idCards": [{ "status": "....", "type": "....", "purpose": "....", "number": "....", "businessFlag": 0 }, { "status": "....", "type": "....", "purpose": "....", "number": "....", "businessFlag": 0 }], "bankAccount": "....", "video": "....", "amlStatus": "....", "overalStatus": "....y" } }, { "email": "....", "phone": "....", "name": "....", "username": "....", "customerId": "....", "merchantId": "....", "status": "....", "reason": "....", "verificationData": { "idCards": [], "documents": [], "video": {}, "contract": {}, "photo": {}, "fatca": {}, "signature": {}, "formData": {} }, "formFilledData": { "identityProof": {}, "addressProof": [], "bankAccount": { "type": "....n" }, "formFields": {}, "fatca": {}, "signature": {}, "photo": {}, "video": { "url": "....", "matchImage": "....", "signzyVerifiableString": "....", "seconds": "...." }, "contract": {} }, "verificationResult": {} }, { "email": "....", "phone": "....", "name": "....", "username": "....", "customerId": "....", "merchantId": "....", "status": "....", "reason": "....", "verificationData": { "idCards": [{ "type": "....", "purpose": [ "POI" ], "name": "....", "idNo": "....", "dob": "....", "address": "....", "state": "....", "issueDate": "....", "images": [ "...." ], "verificationStatus": { "verified": true, "message": "....", "upstreamName": "....", "isSet": 1 }, "faceExtraction": { "cropped": "....", "isSet": 1 } }, { "purpose": [ "POA" ], "name": "....", "idNo": "....", "dob": "....", "address": "....", "state": "....", "issueDate": "....", "images": [ "...." ], "pincode": "....", "type": "....", "verificationStatus": { "message": "....", "verified": true, "moreInfo": { "issueDate": "....", "expiryDate": "....", "vehicleClass": [ "LMV" ] }, "instance": {}, "isSet": 1 }, "faceExtraction": { "cropped": "....", "isSet": 1 } }], "documents": [], "video": { "url": "....", "matchImage": "....", "signzyVerifiableString": "....", "seconds": [ "00:00:02", "00:00:04", "00:00:06", "00:00:08" ], "videoMatch": { "matchAudioScore": "....", "isSet": 1 }, "matchImageEla": { "task": "....", "essentials": { "url": "...." }, "id": "....", "patronId": "....", "result": "....", "isSet": 1 }, "forensics": { "staticRisk": { "staticPhoto": false, "ageGroup": "....", "isSet": 1 }, "videoLandMarks": { "result": "....", "isSet": 1 }, "videoFaceMatch": { "videoImages": [ "https://preproduction-persist.signzy.tech/api/files/123/download/videoimage.jpg", "https://preproduction-persist.signzy.tech/api/files/456/download/videoimage.jpg", "https://preproduction-persist.signzy.tech/api/files/789/download/videoimage.jpg", "https://preproduction-persist.signzy.tech/api/files/234/download/videoimage.jpg" ], "finalMatchImage": "....", "matchStatistics": { "coVariance": "....", "matchPercentage": "....%" }, "isSet": 1 }, "exif": { "metadataFound": "....", "message": "....", "image": {}, "gps": {}, "isSet": 1 } }, "faceLandmarks": { "result": "....", "isSet": 1 } }, "contract": {}, "photo": {}, "fatca": { "pep": "....", "rpep": "....", "residentForTaxInIndia": "....", "relatedPerson": "....O" }, "signature": { "signatureImageUrl": "...." }, "formData": { "gender": "....", "maritalStatus": "....", "nomineeRelationShip": "....", "maidenTitle": "....", "panNumber": "....", "aadhaarNumber": "....", "motherTitle": "....", "occupationDescription": "....", "occupationCode": "....", "kycAccountCode": "....", "kycAccountDescription": "....", "communicationAddressCode": "....", "communicationAddressType": "....", "applicationStatusCode": "....", "applicationStatusDescription": "....", "countryCode": "....", "mobileNumber": "....", "emailId": "....", "communicationAddress": "....", "pincode": "....", "motherName": "....", "nomineeTitle": "....", "nomineeName": "....a" }, "info": { "name": "....", "dob": "....", "emailId": "....", "phone": "....", "communicationAddress": "....", "permanentAddress": "...." } }, "formFilledData": { "identityProof": { "type": "....", "purpose": [ "POI" ], "name": "....", "idNo": "....", "dob": "....", "expiryDate": "....", "verify": "....", "address": "....", "state": "....", "issueDate": "....", "images": [ "...." ], "proofType": "....f" }, "addressProof": [{ "purpose": [ "POA" ], "name": "....", "idNo": "....", "dob": "....", "verify": "....", "address": "....", "expiryDate": "....", "state": "....", "issueDate": "....", "addressType": "....", "proofType": "....", "images": [ "...." ], "pincode": "....", "type": "....l" }], "bankAccount": { "type": "....n" }, "formFields": { "gender": "....", "maritalStatus": "....", "nomineeRelationShip": "....", "maidenTitle": "....", "panNumber": "....", "aadhaarNumber": "....", "motherTitle": "....", "occupationDescription": "....", "occupationCode": "....", "kycAccountCode": "....", "kycAccountDescription": "....", "communicationAddressCode": "....", "communicationAddressType": "....", "applicationStatusCode": "....", "applicationStatusDescription": "....", "countryCode": "....", "mobileNumber": "....", "emailId": "....", "communicationAddress": "....", "pincode": "....", "motherName": "....", "nomineeTitle": "....", "nomineeName": "....a" }, "fatca": { "pep": "....", "rpep": "....", "residentForTaxInIndia": "....", "relatedPerson": "....O" }, "signature": { "signatureImageUrl": "...." }, "photo": {}, "video": { "url": "....", "matchImage": "....", "signzyVerifiableString": "....", "seconds": [ "00:00:02", "00:00:04", "00:00:06", "00:00:08" ] }, "contract": {} }, "verificationResult": { "idCards": [{ "status": "....", "type": "....", "purpose": "....", "number": "....", "businessFlag": 0 }, { "status": "....", "type": "....", "purpose": "....", "number": "....", "businessFlag": 0 }], "bankAccount": "....", "video": "....", "amlStatus": "....", "overalStatus": "....y" } }] } ``` :::hint{type="info"} ### 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 [help@signzy.com](#). :::