Push Onboarding to KRA
Introduction
Once the application is created the data has to be pushed on Signzy's platform for further validation and operations to be performed.
The Push Onboarding JSON Consists Below Objects with Input Variables:
- KYC data: Contains personal and financial information such as gender, marital status, nominee relationship, PAN number, Aadhaar number, residential status, occupation details, annual income, and contact details.
- Identity proof: Contains details about the identity proof provided by the customer, such as type of proof, name, father's name, PAN number, date of birth, and file URL.
- Address proof: Contains details about the address proof provided by the customer, such as type of proof, name, expiry date, issue date, date of birth, address, pincode, state, district, city, and file URL.
- Correspondence address proof: Contains details about the correspondence address proof provided by the customer, such as type of proof, name, number, address, pincode, date of birth, state, district, city, expiry date, file URL, country, and whether the address is the same as a permanent address.
- Bank account: Contains file URL for the bank account details.
- Video: Contains file URL for the video submitted by the customer.
- FATCA data: Contains information related to the customer's compliance with FATCA regulations, such as PEP status, RPEP status, residence for tax in India, and related person status. It also includes details about the customer's place of birth, country of birth, and tax identification number.
API Endpoint - Push onboarding
Preproduction:Â
ďťżhttps://backops-investor-onboarding-preproduction.signzy.tech/kra-handler/api/onboardings/pushďťż
Production:
Sample Request
curl --location 'https://backops-investor-onboarding-preproduction.signzy.tech/kra-handler/api/onboardings/push' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: <authorization token>' \
--data '{
"onboardingData": {
"kycData": {
"gender": "",
"emailId": "",
"countryCode": "",
"panNumber": "",
"maidenName": "",
"fatherName": "",
"fatherTitle": "",
"maidenTitle": "",
"motherTitle": "",
"motherName": "",
"mobileNumber": "",
"annualIncome": "",
"aadhaarNumber": "",
"maritalStatus": "",
"kycAccountCode": "",
"occupationCode": "",
"occupationOther": "",
"residentialStatus": "",
"citizenshipCountry": "",
"nomineeRelationShip": "",
"permanentAddressType": "",
"permanentAddressCode": "",
"occupationDescription": "",
"kycAccountDescription": "",
"applicationStatusCode": "",
"citizenshipCountryCode": "",
"communicationAddressCode": "",
"communicationAddressType": "",
"applicationStatusDescription": "",
"annualIncomeRange": "",
"placeOfBirth": ""
},
"identityProof": {
"name": "",
"fatherName": "",
"dateOfBirth": "",
"type": "",
"number": "",
"fileUrl": []
},
"addressProof": {
"expiryDate": "",
"issueDate": "",
"address": "",
"pincode": "",
"city": "",
"state": "",
"district": "",
"country": "",
"name": "",
"dateOfBirth": "",
"type": "",
"number": "",
"fileUrl": []
},
"corrAddressProof": {
"expiryDate": "",
"issueDate": "",
"address": "",
"pincode": "",
"city": "",
"state": "",
"district": "",
"country": "",
"name": "",
"dateOfBirth": "",
"type": "",
"number": "",
"fileUrl": [],
"sameAsPermanent": ""
},
"bankAccount": {
"fileUrl": []
},
"video": {
"fileUrl": []
},
"fatcaData": {
"pep": "NO",
"rpep": "NO",
"residentForTaxOtherThanIndia": "YES",
"placeOfBirth": "",
"networth": "",
"countryCodeOfBirth": "IN",
"relatedPerson": "NO",
"fatcaDeclarationDate": "28/06/2024",
"fatcaAdditionalDetails": [
{
"countryCodeJurisdictionResidence": "India",
"taxExempt": "YES",
"tinExemptReason": "01",
"taxIdentificationNumber": "123123"
}
],
"relatedPersonData": {
"type": "Assignee",
"title": "Mrs.",
"name": " ",
"kycNumber": "",
"relatedPersonIdentityProof": {
"type": "",
"number": "",
"expiryDate": "11/01/2052",
"fileUrl": [
""
]
}
},
"address": {
"pinCode": "",
"city": "",
"district": "",
"state": "",
"country": "",
"address": ""
}
},
"signature": {
"signatureImageUrl": ""
},
"userForensics": {
"userData": {
"geoData": {
"city": ""
}
}
},
"userPhoto": "",
"esign": {
"signedPdf": ""
},
"empDetails": {
"name": "",
"designation": "",
"branch": "",
"code": ""
}
},
"callbackUrl": ""
}'Request Field Description
Object Name | Key | Data Type | Required/Optional | Description |
|---|---|---|---|---|
ďťż | Header | ďťż | ďťż | ďťż |
ďťż | Content-Type | string | Required | application/json |
ďťż | Authorization | string | Required | Access token from login |
ďťż | Body | ďťż | ďťż | ďťż |
kycData | gender | string | Required | investorâs Gender values: âFemaleâ / âMaleâ / âTransgenderâ |
ďťż | maritalStatus | string | Required | investorâs marital status, values: âMARRIEDâ / âUNMARRIEDâ / âOTHERSâ |
ďťż | nomineeRelationShip | string | Required | Pass either âFATHERâ or âSPOUSEâ, accordingly pass the name in âfatherNameâ |
ďťż | fatherTitle | string | Required | Pass the title of Father or Spouse, possible values âMr.â / âMrs.â |
ďťż | maidenTitle | string | Required (allow empty) | title for maiden name, values: âMrs.â / âMs.â / âMx.â |
ďťż | maidenName | string | Required (allow empty) | maiden name of investor provided investor is a Female |
ďťż | panNumber | string | Required | Investors PAN number or incase of PAN EXEMPT pass PANEXEMPT |
ďťż | aadhaarNumber | string | Required (allow empty) | Investor Aadhaar number |
ďťż | motherTitle | string | Required | Investor mother Title, values: âMrs.â / âMs.â / âMx.â |
ďťż | residentialStatus | string | Required | Investorâs residential status, values: âResident Individualâ / âForeign Nationalâ / âPerson of Indian Originâ |
ďťż | occupationDescription | string | Required (allow empty) | Occupation Description (Refer Table 1.3) |
ďťż | occupationCode | string | Required | Occupation Code (Refer Table 1.3) |
ďťż | kycAccountCode | string | Required | KYC account code, Pass 01 or 02 (Refer Table 1.4) |
ďťż | kycAccountDescription | string | Required | KYC account Description, New or Modify with documents(Refer Table 1.4) |
ďťż | communicationAddressCode | string | Required | Communication Address code (Refer Table 1.6) |
ďťż | communicationAddressType | string | Required (allow empty) | Communication Address Type (Refer Table 1.6) |
ďťż | permanentAddressCode | string | Required | Permanent Address code (Refer Table 1.6) |
ďťż | permanentAddressType | string | Required | Permanent Address Type (Refer Table 1.6) |
ďťż | citizenshipCountryCode | string | Required | Citizenship country code (Refer Table 1.1) |
ďťż | citizenshipCountry | string | Required | Citizenship country (Refer Table 1.1) |
ďťż | applicationStatusCode | string | Required | Application status code, (Refer Table 1.5) |
ďťż | applicationStatusDescription | string | Required | Application status description, (Refer Table 1.5) |
ďťż | fatherName | string | Required | Pass the Father or Spouse name |
ďťż | mobileNumber | String(Required), valid 10 digit mobile number | Required | Mobile number |
ďťż | countryCode | number | Required | Country code of mobile number |
ďťż | emailId | string | Required | Email Id of Investor |
ďťż | motherName | String (Required), string of min length of 2 consisting of any character | Required | Investor mother name |
ďťż | annualIncome | string | Required (allow empty) | Annual Income code (Refer Table 1.8) |
ďťż | annualIncomeRange | Enum String, valid as per code in table 1.8 | Required (allow empty "") | Annual Income Description (Refer Table 1.8) |
ďťż | placeOfBirth | string, string of min length of 2 consisting of any character | Required (allow empty) | Place of Brith |
ďťż | occupationOther | string | Required in case of CVL KRA if Occupation Code is 99 | String of 50 characters |
identityProof | type | Enum String | Required | âindividualPanâ / âaadhaarâ / âpassportâ / âdrivingLicenceâ / âvoteridâ/"panDigilocker"/"aadhaarDigiLocker"/dlDigiLocker/"aadhaarXml" |
ďťż | name | String ,string of min length of 2 consisting of any character | Required | Name on POI document |
ďťż | fatherName | string | Optional | Father's name on POI document |
ďťż | number | string | Required | PAN number on POI document |
ďťż | dateOfBirth | string | Required | DOB on POI document in DD/MM/YYYY or DD-MM-YYYY format |
ďťż | address ďťż ďťż ďťż | string | Required except for Individual PAN | Address as on POI document for âaadhaarâ / âpassportâ / âdrivingLicenceâ / âvoteridâ/"aadhaarDigiLocker"/dlDigiLocker/"aadhaarXml" |
ďťż | pincode | string | Required except for Individual PAN | Pincode as on POI document for âaadhaarâ / âpassportâ / âdrivingLicenceâ / âvoteridâ/"aadhaarDigiLocker"/dlDigiLocker/"aadhaarXml" |
ďťż | state | string | Required except for Individual PAN | State as on POI document for âaadhaarâ / âpassportâ / âdrivingLicenceâ / âvoteridâ/"aadhaarDigiLocker"/dlDigiLocker/"aadhaarXml" |
ďťż | district | string | Required except for Individual PAN | District as on POI document for âaadhaarâ / âpassportâ / âdrivingLicenceâ / âvoteridâ/"aadhaarDigiLocker"/dlDigiLocker/"aadhaarXml" |
ďťż | city | string | Required except for Individual PAN | City as on POI document for âaadhaarâ / âpassportâ / âdrivingLicenceâ / âvoteridâ/"aadhaarDigiLocker"/dlDigiLocker/"aadhaarXml" |
ďťż | expiryDate | string | Required except for Individual PAN | Expiry Date as on POI document for âaadhaarâ / âpassportâ / âdrivingLicenceâ / âvoteridâ/"aadhaarDigiLocker"/dlDigiLocker/"aadhaarXml" |
ďťż | issueDate | string | Required except for Individual PAN | Issue Date as on POI document for âaadhaarâ / âpassportâ / âdrivingLicenceâ / âvoteridâ/"aadhaarDigiLocker"/dlDigiLocker/"aadhaarXml" |
ďťż | fileUrl | array of URLs | Required | An array of image URLs of the ID card, front and back in order. In case of PAN, pass URL of front Image and in case of Driving License pass URLs of either front or both sides of images. |
addressProof | type | string | Required | âaadhaarâ / âpassportâ / âdrivingLicenceâ / âvoteridâ/"aadhaarDigiLocker"/dlDigiLocker/"aadhaarXml" |
ďťż | name | string | Required | Name on POA document |
ďťż | expiryDate | string | Required,allow empty | Expiry date on the document |
ďťż | issueDate | string | Required, allow empty | Issue date on the document |
ďťż | dateOfBirth | string | Required | DOB on POA document |
ďťż | number | string | Required | Document number on POA Document |
ďťż | address | string | Required | Address as on POA document |
ďťż | pincode | string | Required | Pincode as on POA document |
ďťż | state | string | Required | State as on POA document |
ďťż | district | string | Required | District as on POA document |
ďťż | city | string | Required | City as on POA document |
ďťż | fileUrl | array | Required | An array of image URLs of the ID card, front and back in order. In case of PAN, pass URL of front Image and in case of Driving License pass URLs of either front or both sides of images. |
ďťż | country | string | Required | Country as on POA Document |
corrAddressProof | type | string | Required | âaadhaarâ / âpassportâ / âdrivingLicenceâ / âvoteridâ/"aadhaarDigiLocker"/dlDigiLocker/"aadhaarXml" |
ďťż | name | string | Required | Name on CPOA document |
ďťż | number | string | Required | Expiry date on the CPOA document |
ďťż | address | string | Required | Issue date on the CPOA document |
ďťż | pincode | string | Required | DOB on CPOA document |
ďťż | dateOfBirth | string | Required | Document number on CPOA Document |
ďťż | state | string | Required | Address as on CPOA document |
ďťż | district | string | Required | Pincode as on CPOA document |
ďťż | city | string | Required | State as on CPOA document |
ďťż | expiryDate | string | Required, allow empty | District as on CPOA document |
ďťż | issueDate | string | Required, allow empty | ďťż |
bankAccount | fileUrl | array | Optional | City as on POA document |
video | fileUrl | string | Optional | An array of image URLs of the ID card, front and back in order. In case of PAN, pass URL of front Image and in case of Driving License pass URLs of either front or both sides of images. |
fatcaData | sameAsPermanent | string | ďťż | IF CPOA same as POA |
ďťż | pep | string | Required | Politically Exposed Person: "YES" / "NO" |
ďťż | rpep | string | Required | Related to a Politically Exposed Person: "YES" / "NO" |
ďťż | residentForTaxOtherThanIndia | string | Required | Whether resident for tax outside India: "YES" / "NO" |
ďťż | placeOfBirth | string | Required but can be empty | Place of Birth |
ďťż | fatcaData.networth | Numeric value | Conditionally required | Required if residentForTaxOtherThanIndia is 'YES'. Need to enter the kra code for networth |
ďťż | relatedPerson | string | Required | Whether there is a related person: "YES" / "NO" |
ďťż | fatcaDeclarationDate | string | Required | FATCA Declaration Date |
fatcaAdditionalDetails | ďťż | ďťż | ďťż | DD/MM/YYYY |
ďťż | fatcaAdditionalDetails.countryCodeJurisdictionResidence | string | Required but can be empty | Country of Jurisdiction of Residence |
ďťż | fatcaAdditionalDetails.taxExempt | string | Required but can be empty | Whether tax exempt: "YES" / "NO" |
ďťż | fatcaAdditionalDetails.tinExemptReason | string | Required but can be empty | if tax exempt is YES only then required Refere the kra sheet for code |
ďťż | fatcaAdditionalDetails.taxIdentificationNumber | string | Required but can be empty | Tax Identification Number, to be provided given âresidentForTaxInIndiaâ is âYESâ also if tax exempt is NO is required |
relatedPersonData | ďťż | ďťż | ďťż | ďťż |
ďťż | relatedPersonData.type | string | Optional | Type of related person: "Assignee", "Guardian of Minor", etc. |
ďťż | relatedPersonData.title | string | Optional | Title of related person: "Mr.", "Mrs.", etc. |
ďťż | relatedPersonData.name | string | Optional | Name of related person |
ďťż | relatedPersonData.kycNumber | string | Optional | KYC Number of related person |
ďťż | relatedPersonIdentityProof | string | Optional | Object containing related person's identity proof details |
ďťż | relatedPersonIdentityProof.type | string | Optional | Type of related personâs ID proof: "drivingLicence", etc. |
ďťż | relatedPersonIdentityProof.number | string | Optional | ID proof number of related person |
ďťż | relatedPersonIdentityProof.expiryDate | string | Optional | Expiry date of the ID proof |
ďťż | relatedPersonIdentityProof.fileUrl | string | Optional | Array of file URLs (front and back of the ID) |
fatcaData.address | pinCode | string | Optional | Fatca address Pincode, to be provided given âresidentForTaxInIndiaâ is âYESâ |
ďťż | city | string | Optional | Fatca address city, to be provided given âresidentForTaxInIndiaâ is âYESâ |
ďťż | district | string | Optional | Fatca address district, to be provided given âresidentForTaxInIndiaâ is âYESâ |
ďťż | state | string | Optional | Fatca address state code (Refer Table 1.2), to be provided given âresidentForTaxInIndiaâ is âYESâ |
ďťż | country | string | Optional | Fatca address country (Refer Table 1.1), to be provided given âresidentForTaxInIndiaâ is âYES" |
ďťż | address | string | Optional | Fatca address, to be provided given âresidentForTaxInIndiaâ is âYESâ |
signature | signatureImageUrl | string | Required | Signature Image URL |
userForensics | userData.geoData.city | string | Required | Geo Location City of user |
userPhoto | userPhoto | string | Required | User Photo URL |
esign | signedPdf | string | Required | Signed form URL combined of all the data and documents |
empDetails | name | string | Required but can be empty | EIPV Details : name of Employee |
ďťż | designation | string | Required but can be empty | EIPV Details : designation of Employee |
ďťż | branch | string | Required but can be empty | EIPV Details : brand of Employee |
ďťż | code | string | Required but can be empty | EIPV Details : Employee code |
callbackUrl | callbackUrl | string | Optional | Callback URL to receive the response on KRA push |
Sample Responses
While using invalid endpoint
{
"error": {
"statusCode": 404,
"name": "Error",
"message": "There is no method to handle GET /6451198320bf270e75ce7618/onboardings/6464ad5eb4f191002445b509"
}
}Response Field Description
Key | Data type | Description |
|---|---|---|
customerId | String | The id of the customer for onboarding |
requsetId | String | The application id for the onboarding journey |
callbackUrl | String | The URL where the complete data of the customer will be posted once the onboarding process is completed |
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].