You are on page 1of 10

API Document

API Description Document

Requestor

Requestor: Date:
Pratik Phunguskar 03 – Jan – 2018

Designation Department
AssistantManager RBL-BSG

Approvals

Executive Sponsor: Date:

Business Program Manager: Date:

Project Manager BSG: Date:

Please add additional rows if you have additional stakeholders that need to approve this
document.
Comments:

RBL - Internal Page 1 21/08/20


API Document

Revision History
Document/Dept. BSG
Owner:
Created By: Pratik Phunguskar Date: 03 – Jan – 2018
Revised By Date Revised New Version #

Table of Contents

1. Scope and Business Case Overview............................................................................4


1.1 Project Overview.....................................................................................................4
1.2 Current process & opportunity................................................................................4
1.3 High-level business requirements............................................................................4
1.3.1 Functional Requirement...........................................................................................................4
1.3.2 Non- Functional Requirement..................................................................................................4
1.4 Business Benefit Case..............................................................................................4
1.4.1 Financial Benefit......................................................................................................................4
1.4.2 Non-Financial Benefit..............................................................................................................4
2. Acceptance Criteria & Project Plan.............................................................................5

Introduction
Project – DataPower in Rule Engine Integration
s.

List of API
To be filled
List down the APIs part of the projects:

Sr. No Name Description


PL Cibil Enquiry To make Cibil bureau enquiry of
applicant applying for RBL personal
loan to check his/her credit history
 1 and report

RBL - Internal Page 2 21/08/20


API Document

API Name
PL Cibil Enquiry

Description
To make Cibil bureau enquiry of applicant applying for RBL personal loan to check his/her credit history and report

Transport protocol (SOAP / REST)


REST – key value pair

API Request URLs

https://apideveloper.rblbank.com/test/sb/rbl/api/v1/pl-cibil/enquiry

Request Parameters

Business Parameter Name Description Parameter Type Parameter Constraints


EnvironmentType Environment Type String Length=1
MinLength=10
External Application
ExternalApplicationId String MaxLengthh=15
Id
Alphanumeric # ‘-‘
InquirySource Inquiry Source String Length=9

ProductCode Product Code String Length=2

ChannelType Channel Type String Length=3


MinLength=2
Title Title String
MaxLength=5
Application First MinLength=1
ApplicantFirstName String
Name MaxLengthh=15
Application Middle MinLength=1
ApplicantMiddleName String
Name MaxLengthh=15
Application Last MinLength=1
ApplicantLastName String
Name MaxLengthh=15
DateofBirth Date of Birth Date Length=10

Gender Gender String


String
PanNo Pan No Length=10
String
EmailID Email Id Length=
String MinLength=1
ResidenceAddress1 Residence Address1
MaxLengthh=15
String MinLength=1
ResidenceAddress2 Residence Address2
MaxLengthh=15
String MinLength=1
ResidenceAddress3 Residence Address3
MaxLengthh=15
ResidencePincode Residence Pincode Numeric Length=6

RBL - Internal Page 3 21/08/20


API Document
MinLength=1
ResidenceCity Residence City String
MaxLengthh=15
MinLength=1
ResidenceState Residence State String
MaxLengthh=15
Residence STD
ResidenceSTDCode Numeric Length=3
Code
ResidencePhone Residence Phone Numeric Length=12
Residence Mobile
ResidenceMobileNumber Numeric Length=13
Number
String MinLength=1
OfficeAddress1 Office Number1
MaxLengthh=15
String MinLength=1
OfficeAddress2 Office Address2
MaxLengthh=15
String MinLength=1
OfficeAddress3 Office Address3
MaxLengthh=15
OfficePincode Office Pincode Numeric Length=6
MinLength=1
OfficeCity Office City String
MaxLengthh=15
MinLength=1
OfficeState Office State String
MaxLengthh=15
OfficePhone Office Phone Numeric Length=12
Office Mobile
OfficefMobileNumber Numeric Length=13
Number
String
PassportNumber Passport Number Length=15
String
DLNo DL No Length=15
String
VoterId Voter Id Length=15
String
UId UId Length=15
String
RationCardNo Ratio Card No Length=15

MonthlyIncome Monthly Income Numeric Length=6

Residence_stability Residence Stability Date Length=10


Employment
Employment_stability Date Length=10
Stability
MinLength=4
Loan_Account_1 Loan Amount1 Numeric
MaxLengthh=10
MinLength=4
Loan_Account_2 Loan Amount2 Numeric
MaxLengthh=10
MinLength=4
Loan_Account_3 Loan Amount3 Numeric
MaxLengthh=10
MinLength=4
Loan_Account_4 Loan Amount4 Numeric
MaxLengthh=10
MinLength=4
Loan_Account_5 Loan Amount5 Numeric
MaxLengthh=10
Placeholder6 Place Holder6

Placeholder7 Place Holder7

Placeholder8 Place Holder8

Placeholder9 Place Holder9

RBL - Internal Page 4 21/08/20


API Document

Placeholder10 Place Holder10

Request Sample
<DCRequest>
<Authentication type="OnDemand">
<UserId>RBLPLSSUser</UserId>
<Password>Password@123</Password>
</Authentication>
<RequestInfo>
<SolutionSetId>731</SolutionSetId>
<SolutionSetVersion>49</SolutionSetVersion>
<ExecutionMode>NewWithContext</ExecutionMode>
</RequestInfo>
<UserData />
<Fields>
<Field key="EnvironmentType">P</Field>
<Field key="ExternalApplicationId">#PLED8D82N</Field>
<Field key="InquirySource">RP System</Field>
<Field key="ProductCode">PL</Field>
<Field key="ChannelType">DDE</Field>
<Field key="Title">Mr</Field>
<Field key="ApplicantFirstName">SELVARATHINAM</Field>
<Field key="ApplicantMiddleName"></Field>
<Field key="ApplicantLastName">D</Field>
<Field key="DateofBirth">10/05/1964</Field>
<Field key="Gender">Male</Field>
<Field key="PanNo">DPKPS8445K</Field>
<Field key="EmailID"></Field>
<Field key="ResidenceAddress1">NO 292 B 4TH CRS RALWAY COLONY</Field>
<Field key="ResidenceAddress2">KALLUKUZHI</Field>
<Field key="ResidenceAddress3"></Field>
<Field key="ResidencePincode">620010</Field>
<Field key="ResidenceCity">Trichy</Field>
<Field key="ResidenceState">Tamil Nadu</Field>
<Field key="ResidenceSTDCode"></Field>
<Field key="ResidencePhone"></Field>
<Field key="ResidenceMobileNumber">8883938126</Field>
<Field key="OfficeAddress1">SMR OFFICE TRICHY JUNCTION</Field>
<Field key="OfficeAddress2"></Field>
<Field key="OfficeAddress3"></Field>
<Field key="OfficePincode">620010</Field>
<Field key="OfficeCity"></Field>
<Field key="OfficeState"></Field>
<Field key="OfficePhone">8883938126</Field>
<Field key="OfficefMobileNumber"></Field>
<Field key="PassportNumber"></Field>
<Field key="DLNo"></Field>
<Field key="VoterId"></Field>
<Field key="UId"></Field>
<Field key="RationCardNo"></Field>
<Field key="MonthlyIncome">37500</Field>
<Field key="Residence_stability">2015-07-28</Field>
<Field key="Employment_stability">2006-07-28</Field>
<Field key="Loan_Account_1"></Field>
<Field key="Loan_Account_2"></Field>

RBL - Internal Page 5 21/08/20


API Document
<Field key="Loan_Account_3"></Field>
<Field key="Loan_Account_4"></Field>
<Field key="Loan_Account_5"></Field>
<Field key="Placeholder6"></Field>
<Field key="Placeholder7"></Field>
<Field key="Placeholder8"></Field>
<Field key="Placeholder9"></Field>
<Field key="Placeholder10"></Field>
</Fields>
</DCRequest>

Response Parameters
Paramete Parameter
Business Parameter Name Description r Type Constraints
Status Status String Length=7
Token Token No String Length=40
ApplicationId Application Id String Length=15
SolutionSetInstanceId Solution Id String Length=40
IsError Is Error String Length=5
ErrorMsg Error Msg String Length=100
DateofTUHit Date of TU Hit Date Length=10
TURF TURF String Length=
Placeholder1
Placeholder2
Placeholder3
Placeholder4
Placeholder5
Placeholder6
Placeholder7
Placeholder8
Placeholder9
Placeholder10

Response Sample
<DCResponse>
<Status>Success</Status>
<Authentication>
<Status>Success</Status>
<Token>60490934ec9311e7948b0a502d3f0000</Token>
</Authentication>
<ResponseInfo>
<ApplicationId>6E8E9D8AEC6411E</ApplicationId>
<SolutionSetInstanceId>60491e42ec9311e7948b0a502d3f0000</SolutionSetInstanceId>
<CurrentQueue></CurrentQueue>
</ResponseInfo>
<ContextData>
<Field key="IsError">True</Field>
<Field key="ErrorMsg">DOB must be in DD/MM/YYYY format</Field>
<Field key="DateofTUHit"></Field>
<Field key="TURF">TUEF126E8E9D8AEC6411E 0000BP03251004_UAT </Field>
<Field key="Placeholder1"></Field>

RBL - Internal Page 6 21/08/20


API Document
<Field key="Placeholder2"></Field>
<Field key="Placeholder3"></Field>
<Field key="Placeholder4"></Field>
<Field key="Placeholder5"></Field>
<Field key="Placeholder6"></Field>
<Field key="Placeholder7"></Field>
<Field key="Placeholder8"></Field>
<Field key="Placeholder9"></Field>
<Field key="Placeholder10"></Field>
</ContextData>
</DCResponse>
Response Codes

Response Stage Response Code Response Message


 SUCCESS     SUCCESS
FAILURE   FAILURE

Error Codes
Error Msg LTD # Message to display in RP
/Root/XMLNSC/CIBIL/output 426 Please Try Again Later. Unable to process your request due to System Issue.

A timeout occurred whilst performing a 384 Please Try Again Later. Unable to process your request due to System Issue.
socket operation

An error was found whilst parsing 1 Please Try Again Later. Unable to process your request due to System Issue.
HTTP header data. Multiple occurences
of a HTTP Header were found (or
folded !lc

CIBIL failed to respond,please try 4 Please Try Again Later. Unable to process your request due to System Issue.
again later

CIBIL service failed to respond please 53 Please Try Again Later. Unable to process your request due to System Issue.
try again later

CIBIL service failed to respond,please 4703 Please Try Again Later. Unable to process your request due to System Issue.
try again later

CIBIL service failed to respondplease 58 Please Try Again Later. Unable to process your request due to System Issue.
try again later

CIBIL System Error:Y 52 Please Try Again Later. Unable to process your request due to System Issue.

Connection refused 449 Please Try Again Later. Unable to process your request due to System Issue.

Connection time out. 9 Please Try Again Later. Unable to process your request due to System Issue.

RBL - Internal Page 7 21/08/20


API Document
DB Connection timeout exception 2 Please Try Again Later. Unable to process your request due to System Issue.

Error calling DA 7 Please Try Again Later. Unable to process your request due to System Issue.

HTTP/1.1 404 Not Found 1 Please Try Again Later. Unable to process your request due to System Issue.

Invalid Enquiry Data: Invalid Address 1 Incorrect Address , Please change and re submit the application.
Line1 in Address Segment 1| Invalid
Address Line2 in Address Segment 1|
Invalid Address Line3 in Address
Segment 1| Invalid State Code in
Address Segment 1| Invalid PIN Code
in Address Segment 1

Invalid Enquiry Data: Invalid Address 326 Incorrect Address, Please change and re submit the application.
Line1 in Address Segment 1| Invalid
Address Line2 in Address Segment 1|
Invalid State Code in Address Segment
1| Invalid PIN Code in Address
Segment 1
Invalid Enquiry Data: Invalid Address 275 Incorrect Address, Please change and re submit the application.
Line1 in Address Segment 1| Invalid
State Code in Address Segment 1|
Invalid PIN Code in Address Segment
1
Invalid Enquiry Data: Invalid 296 Issue with Firstname/ Middle Name/ Last Name : length cannot be greater
ConsumerName1 in Name Segment| than 26 characters, Please change and re submit the application
Invalid ConsumerName2 in Name
Segment| Invalid ConsumerName3 in
Name Segment
Invalid Enquiry Data: Invalid 120 Issue with Firstname/ Last Name : length cannot be greater than 26
ConsumerName1 in Name Segment| characters, Please change and re submit the application
Invalid ConsumerName3 in Name
Segment

Invalid Enquiry Data: Invalid 4 Incorrect DateofBirth, Please change and re submit the application
DateOfBirth in Name Segment

Invalid Enquiry Data: Invalid PIN 4 Invalid PinCode, Please change and re submit the application
Code in Address Segment 1

Invalid Enquiry Data: Invalid State 576 Pincode not matching with state, Please change and re submit the application
Code in Address Segment 1| Invalid
PIN Code in Address Segment 1
Invalid Enquiry Data:ANOTHER 31 Duplicate Application
ENQUIRY OF THE SAME IS STILL
BEING PROCESSED
Invalid Enquiry Member User 246 Please Try Again Later. Unable to process your request due to System Issue.
ID/Password:BP03257777
XXXXXXXXXXXXXXXXXXXXXX
XXXXXXXX
Invalid Field Length in Name 1 Issue with Firstname: length cannot be greater than 26 characters, Please
segment : Invalid field length 27 of change and re submit the application
ConsumerName1

RBL - Internal Page 8 21/08/20


API Document
Invalid Field Length in Name 15 Issue with Lastname: length cannot be greater than 26 characters, Please
segment : Invalid field length 27 of change and re submit the application
ConsumerName3
Invalid Field Length in Name 1 Issue with Firstname: length cannot be greater than 26 characters, Please
segment : Invalid field length 28 of change and re submit the application
ConsumerName1
Invalid Field Length in Name 11 Issue with Lastname: length cannot be greater than 26 characters, Please
segment : Invalid field length 28 of change and re submit the application
ConsumerName3
Invalid Field Length in Name 8 Issue with Lastname: length cannot be greater than 26 characters, Please
segment : Invalid field length 29 of change and re submit the application
ConsumerName3
Invalid Field Length in Name 1 Issue with Middlename: length cannot be greater than 26 characters, Please
segment : Invalid field length 31 of change and re submit the application
ConsumerName2
Invalid Field Length in Address 121 Incorrect Address Line 2, Please change and re submit the application
segment : Invalid Address Line2 in
Address Segment 1
Invalid TUEF file extension 6503 Please Try Again Later. Unable to process your request due to System Issue.

NO ACTION RETURN FROM RULE 1 Please Try Again Later. Unable to process your request due to System Issue.
ENGINE

No route to host 47 Please Try Again Later. Unable to process your request due to System Issue.

ParserException: 2 Please Try Again Later. Unable to process your request due to System Issue.
com.rbl.moneyTap.MoneyTapPC.Creat
ingReqForCCMasterPCcom.rbl.money
Tap.MoneyTapPC_Compute.Main
15.13 DECLARE ref REFERENCE
TO
Environment.Request.MT.XMLNSC.D
CRequest; Navigation error
com.rbl.moneyTap.MoneyTapPC_Com
pute.Main 15.38 XML Pars

ParserException: 4 Please Try Again Later. Unable to process your request due to System Issue.
com.rbl.rppc.RPPC_BatchProcessing.F
ile Input Exception whilst parsing Root
DFDL Stream Based Page Buffer
[0,721]
45787465726e616c4170706c69636174
696f6e49642c496e7175697279536f757
263652c4368616e6e656c547970652c4
36f75706f6e436f64652c5469746

RBL - Internal Page 9 21/08/20


API Document
ParserException: 1 Please Try Again Later. Unable to process your request due to System Issue.
com.rbl.rppc.RPPC_BatchProcessing.F
ile Input Exception whilst parsing Root
DFDL Stream Based Page Buffer
[0,722]
45787465726e616c4170706c69636174
696f6e49642c496e7175697279536f757
263652c4368616e6e656c547970652c4
36f75706f6e436f64652c5469746

RecoverableException: 2 Please Try Again Later. Unable to process your request due to System Issue.
com.rbl.moneyTap.MoneyTapPC.Creat
ingReqForCCMasterPCcom.rbl.money
Tap.MoneyTapPC_Compute.Main
13.10 CREATE LASTCHILD OF
Environment.Request.MT DOMAIN
'XMLNSC'
PARSE(Environment.Request.MoneyT
apKeyValue, 1208);
com.rbl.moneyTap.Money

RecoverableException: 1 Please Try Again Later. Unable to process your request due to System Issue.
com.rbl.rppc.RPPC_BatchProcessing.F
ile Input Retry processing failing
message File Input

RecoverableException: 1 Please Try Again Later. Unable to process your request due to System Issue.
com.rbl.rppc.RPPC_BatchProcessing.S
uccess Success
com.rbl.rppc.RPPC_BatchProcessing /
RPPC_BATCH_PROCESS/RPPCBatc
hUploadResponse _09_05_2017.csv

Request cannot proceed now please try 5 Please Try Again Later. Unable to process your request due to System Issue.
later.

RULE_RBL_CC_MAX_MOB class 3 Please Try Again Later. Unable to process your request due to System Issue.
java.lang.NullPointerException null

RULE_RBL_NoEnquiry6mnths class 2 Please Try Again Later. Unable to process your request due to System Issue.
java.lang.NullPointerExceptionnull,RU
LE_Enquiry_Month_Diff_PL_CC class
java.lang.NullPointerException null

Default   Please Try Again Later. Unable to process your request due to System Issue.

RBL - Internal Page 10 21/08/20

You might also like