API Description Document Requestor Requestor: [ Aditya Padwal ] Date: 11 – Aug – 16 Designation [ Manager] Department [ Technology - BSG] Approvals Executive Sponsor: [ Sujatha Mohan ] Date: dd – Mmm – yy Business Program Manager: [ Abhijeet Davane ] Date: dd – Mmm – yy Project Manager BSG: [ Aditya Padwal ] Date: dd – Mmm – yy Please add additional rows if you have additional stakeholders that need to approve this document. Comments:
Checker_ID Unique ID for request checker Checker_ID AN MaxLength=20 Unique ID for request checker NA Approver_ID Unique ID for request approver Approver_ID AN MaxLength=20 Unique ID for request approver NA Allow Consent This value take customers consent to generate score on his behalf. allowConsent N MaxLength=1 Value should always be “1” M Account number Customers Account number for charges accountNo N =16 Value should be a valid account number from CBS. M First Name A valid first name of customer firstName Allow only Alphabets and space <= 26 NA Y Middle Name A valid Middle Name of Customer middleName Allow only Alphabets and space <= 26 NA O Last Name A valid Last Name of Customer Surname Allow only Alphabets and space <= 26 NA Y Date Of Birth Customer Date of birth Dob DD-Mmm-YYYY =11 NA Y Gender Customers Gender Gender 1 - Male 2 -Female 3 – Transgender =1 NA Y Mobile No Customers Mobile No mobileNo NUMERIC. 1st Digit should be from 7,8,9. =10 NA Y (If Telephone No., Passport No., Pan No., VoterId No. is not Specified else N) Telephone No Customer contact number telephoneNo NUMERIC >=5 NA Y (If Mobile No., Passport No., Pan No., VoterId No. is not Specified else N) Telephone Type Contact Number Type telephoneType NUMERIC =2 Valid data is attached in section below. N (If not specified Home is considered as default Value) Email ID Customer Email ID Email Proper email format ex. Abc@test.in, abc@test.com, abc@test.co.in 255 NA Y Flat Plot House No A valid Flat and Plot details AddressLine1 AlphaNumeric Allows [],./\ Symbols <= 40 NA Y Building Society Name A valid Building or Society Name AddressLine2 AlphaNumeric Allows [],./\ Symbols <= 40 NA N Road Area Society A valid Road name or Landmark AddressLine3 AlphaNumeric Allows [],./\ Symbols <= 40 NA N City Customers residing city name City AlphaNumeric Allows [],./\ Symbols <= 40 NA Y State Customer residing State Name State Numeric NA Should be only from the List of States. in Y
"surname": "v", "dob": "15-Sep-1985", "gender": "1", "mobileNo": "9834523199", "telephoneNo": "9834523196", "telephoneType": "02", "email": "muralikrishna.sugandham@rblbank.com", "AddressLine1": "502apt", "AddressLine2": "43", "AddressLine3": "34", "city": "Mumbai", "state": "27", "pincode": "400107", "pan": "BUQPD9991A", "passport": "", "aadhaar": "453354553333", "voterId": "", "driverLicense": "", rationCardNo": "344" }, "Signature": { "Signature": "" } } } Response Parameters for Credit score API Business Parameter Name Description Parameter Name Parameter Type Parameter Constraints Comments Tran ID Transaction Id TranID AN MaxLength=16 Transaction ID generated by consumer which is unique M Corp ID Corporate Id Corp_ID AN MaxLength=20 Unique ID assigned to each enrolled Corporate M Maker ID Maker Id Maker_ID AN MaxLength=20 Unique ID for request creator NA Checker ID Checker Id Checker_ID AN MaxLength=20 Unique ID for request checker NA Approver ID Approver Id Approver_ID AN MaxLength=20 Unique ID for request approver NA Bureau Score A valid Score BureauScore N MaxLength=3 This element will be only M
received from Credit Bureau.. displayed in case of success scenario. Request Date Date when Request is made by Customer ReportDate N MaxLength=8 Credit Score Request Date M Request Time Time When request is made by customer ReportTime N MaxLength=6 Credit Score Request Time M ESB Return Code ESB Return code esbreturncode Numeric MaxLength=2 ESB error code, incase validations fails at ESB end. O ESB Return Description ESB Return Description esbreturndesc AN NA ESB error Description for Error Codes. O Signature Signature Signature AN No max length defined. Encrypted key for authenticating the request. Currently not required. NA Response Sample {"CreditScoreResponse": { "Header": { "TranID": " A1B2C3D4E5F6G7H8", "Corp_ID": "ZSA01", "Maker_ID": "", "Checker_ID": "", "Approver_ID": "" }, "Body": { "BureauScore": "344", "ReportDate": "20141014", "ReportTime": "104239" }, "Signature": {"Signature": ""} }} Appendix Request Format: