# IDFC Lending APIs
# Access token
These services are exposed with OAuth2 authentication. Please follow the below steps to send the request.
URL: https://muleuat.capitalfirst.com:1447/access-token
Method: GET
Headers
```
grant_type= client_credentials // This is hardcoded value as "client_credentials"
client_id = Will be shared separately
clientsecret = Will be shared separately
```
## Response
```
{
"access_token": ""eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaCIsImV4cCI6MTU4MzQ5MzYzMCwianRpIjoiZmVhZjc1ZTQxMTFkNDY4ZmE4YmQ3ZWRhYWZmODlmMmUiLCJ1c2VyX2lkIjozfQ.fo0wWkaiw4Jq9y09LAU0I4APfzspksMhZZRZ0vBgkUk",
"token_type": "bearer",
"expires_in": 8599
}
```
From the JSON response as obtained from the above step, get the “access_token” and send this value as a header parameter for request to Amazon service call. When the user sends with the correct access token and they will get success response back with http status code 200.
If the token gets expired or when they send request with wrong token it will return response with status 401 “Unauthorized”
Every API should have following headers
```
access_token: ""
Source: ""
```
# Dedupe
This RESTful API used to get match and CRN
URL: http://muleuat.capitalfirst.com:1447/ext/api/1.0/partner/dedupe
## Request
```
{
"SourceSystem": "Setu",
"SchemeId": 0,
"loanToBeForeClosed": "",
"LoanApplicationNo": "",
"PartnerAppNumber": "Setu12345 ",
"IsTopUp": "N",
"IntegrationType": "Posidex",
"FinnoneId": "",
"CustomersRequest": [
{
"TypeOfApplicant": "Applicant",
"OldPosidexRequestId": "",
"IsCopyCustomer": "false",
"EmailDetails": [
{
"EmailType": "",
"EmailId": "vsj@gmail.comxyz"
}
],
"Demographics": {
"VoterId": "ZHJ1736917",
"UdyogAadhar": "",
"TIN": "",
"SpouseName": "",
"PassportNo": "",
"Pan": "FRKPV3341Q",
"NREGA": "",
"Name": "VANRAJBHAI SURESHBHAI JOGADIYA",
"MotherMaidenName": "",
"Gender": "M",
"FatherName": "",
"DrvLicenceNo": "",
"Dob": "1996-12-26",
"DIN": "",
"CIN": "",
"BankAccno": "",
"Aadhar": "238492394829",
"AadhaarEnrolmentNo": ""
},
"CustomerIdentifier": "a2Z0k000002NAWTEA4",
"CustomerCategory": "Individual",
"CRNToBeAssign": "",
"CRN": "",
"ContactDetails": [
{
"PhoneNo": "9586575338",
"ContactType": "Applicant"
}
],
"Addresses": [
{
"State": "MAHARASHTRA",
"Pincode": "400070",
"Landmark": "",
"City": "MUMBAI",
"addresstype": "Residence Address",
"Address": "khdkjhdk kjdhfjkhkj"
}
]
}
],
"BusinessUnit": "TW",
"BusinessType": "Asset"
}
```
## Response
```
{
"IsSuccess": "true",
"ErrorCode": "",
"ErrorDescription": "",
"ESBRequestId": 3401327,
"CustomersResponse": [
{
"AssignedCRN": "5145332967",
"CustomerIdentifier": "a2P0I00000DQNwZUAX"
}
],
"LoanApplicationNo": 1000987,
"PartnerAppNumber": "Setu12345",
"LoanDecision": "APPROVE",
"LoanRejectReason": ""
}
```
# CKYC Search service
URL: https://muleuat.capitalfirst.com:1447/ext/api/1.0/proc/ckyc/search
This RESTful API helps on-boarding FI applications to consume and search for customers in CKYC Repository.
<table>
<tr>
<th>Field Name/XML Tag</th>
<th>Mandatory</th>
<th>Data Type</th>
<th>Length</th>
<th>Remarks</th>
</tr>
<tr>
<td>TransactionId</td>
<td>Yes</td>
<td>String</td>
<td>60</td>
<td>Needs to be unique within that request</td>
</tr>
<tr>
<td>RecordIdentifier</td>
<td>No</td>
<td>String</td>
<td>60</td>
<td></td>
</tr>
<tr>
<td>ApplicationFormNo</td>
<td>No</td>
<td>String</td>
<td>60</td>
<td></td>
</tr>
<tr>
<td>BranchCode</td>
<td>No</td>
<td>String</td>
<td>60</td>
<td></td>
</tr>
<tr>
<td>InputIdType</td>
<td>Yes</td>
<td>String</td>
<td>60</td>
<td>Value should be as per list (1.1)</td>
</tr>
<tr>
<td>InputIdNo</td>
<td>Yes</td>
<td>String</td>
<td>40</td>
<td></td>
</tr>
</table>
## List 1.1 ID Type Code–Possible Values
<table>
<tr>
<th>IDType</th>
<th>Description</th>
</tr>
<tr>
<td>A</td>
<td>Passport</td>
</tr>
<tr>
<td>B</td>
<td>Voter ID</td>
</tr>
<tr>
<td>C</td>
<td>PAN</td>
</tr>
<tr>
<td>D</td>
<td>Driving Licence</td>
</tr>
<tr>
<td>E</td>
<td>UID</td>
</tr>
<tr>
<td>F</td>
<td>NREGA Job Card</td>
</tr>
<tr>
<td>Z</td>
<td>CKY Identifier</td>
</tr>
</table>
## Request
```
{
"SearchCkycRequest": {
"RequestId": "ABCD12355",
"Source": "SFDC",
"Details": [
{
"TransactionId": "FFF12",
"RecordIdentifier": "QERT9635",
"ApplicationFormNo": "JIKL546",
"BranchCode": "BRANCH8",
"InputIdType": "E",
"InputIdNo": "123456789012"
}
]
}
}
```
## Response
```
{
"SearchCkycResponse": {
"RequestId": "ABCD12355",
"RequestStatus": "AcceptedbyTW",
"RequestRejectionDescription": "",
"Detail": [
{
"TransactionId": "FFF12",
"TransactionStatus": "CKYCSuccess",
"BranchCode": "BRANCH8",
"RecordIdentifier": "QERT9635",
"ApplicationFormNo": "JIKL546",
"CKYCAvailable": "Yes",
"CKYCAccType": "Normal",
"CKYCID": "10001752189640",
"CKYCName": "Miss Narayani Ganesh Shah",
"CKYCAge": "12",
"CKYCFatherName": "Mr Ganesh Shah",
"CKYCPhotoImageType": "jpg",
"CKYCGenDate": "31-Jan-2018",
"CKYCPhoto": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAkGBwgHBgkIBwgKCgkLDRYPDQwMDRsUF RAWIB0iIiAdHx8kKDQsJCYxJx8fLT0tMTU3Ojo6Iys/ RD84QzQ5OjcBCgoKDQwNGg8PGjclHyU3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nz c3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3N//AABEIAIMAqQMBIgACEQEDEQH/ xAAcAAACAQUBAAAAAAAAAAAAAAAAAQIDBAUGBwj/ xAA5EAABAwIDBQUFBgcBAAAAAAABAAIDBBEFITEGEhNBUQciYXGRFDJCgaEWIySxwdEV UmJykuHwM//EABkBAQEBAQEBAAAAAAAAAAAAAAABAwIEBf/ EACERAQACAgICAgMAAAAAAAAAAAABEQIDITESQSIyBBND/ 9oADAMBAAIRAxEAPwDr7WqVk7IWbQITQgSaSLoAqBek9ysMTxKjwulfVV9RHBCwXLnu tfw8UF7v55ID8lxzH+2GTiyx4HRMMPuxzVFw6/8ANb9PqtMn7RNrpZHOfjksd/ gjiYAPLupEObel9/ NTDgvLbtstopXb0uN17j4TFv5LI4V2gbS4fK1zMWqJmDWOotI0+ov9VaPJ6WvkhaTsRt9Rb QxNgqzHS4jpwrndk/ tJ5+Gq3QOuoqaEBCATSQgaEIRQhCFUIIKEKKSSaSAUXKSoVMzYYnyPcGtaCSToAgsMZxej wijkqa2UMYxpdYakf9+a4H2g7X/ amtjEVMYqeB3cLn3d8hoPzVz2i7SyY5i00UT7UcDrNH8xHM/ Ww8VpEweCDmb8khxMqLjY5JA/JMt3kt0hdIqRlwGVvRVQXgZtBHgqLARmb/ JXEd79eiCtTz8Nwc1+7Zdk7NNvzWSR4Pjcv4jSnqHn3/6XHr0PPTVcZa1riMrO5jqhpdEQAT uX7rh8JSSHrhpUlqXZxtH9otnIZpnh1ZT/ AHNTnq4aO+Yz9Vto0XLsITSQNCAhFCEIVCQUIKgiUJpIEVqXaTiQwzZx77j72Rsfe0Op+trLb StA7aWh2x7SRpVx+lnXRJcHc90kji472Zc89Te5P1VWhpZMRrWwR3vJa56BUH/ dsI5kWctl7Pqfi4k6Qi4aFM5rGzXj5ZxDK4hsXGMOZ7OLysH+Y6fstGqKUxSFrr3BI7wsRbqv QVNSsmjs4C1ui1PbPY51RG6ro22maM8sneaw17Z6l6NumO8XKGR2yI8lV4e5rex5qczZKe Z0E0bmSA6OCTLvaWWuCvTdvJXpTdZgzzB6JMkG/ Zxu0oJIb3hpldW57py15IOj9i2JGh2qfQvf3ayIxkE5OcwFzT523l3lq8xbDVAg2twadztwCqY xx6XNv1t816dCjqE0JJopJhJNAIQhFJCEIESkmkgR0Wl9rMIl2Kqri5jlieP8wPyJW6Fa3t/ Tmp2SxKMZnhX9M0SXmWV13u+eS3bY1s1PRukgiL5XvNgtLkYRU7viuwbJUHBwmGQNu 7duAOay3ZVi1/ HxvK1SkxPaCmvfDmyN8Dp5rK4ftW2d5psRopKR9snHNjvIrEYhVbSGKofQMZDwyNyIRhzp BfO18r2UsIhxepbE7F4Gl8xcQ3h2dEAcg/lcjosfVt65pb7VbMUmKNMsLQ2UZsc3K/ gSubYhQT4bVARkvBNrEZjwIXeIMPZ7M4b2gtZajtDh8jd91LSskqHNcWbzcjbl+yuvZMcGzX GUW5gIaidjtymJa/ MObmAVYyRPaSHtLSNQVvmHwYgyndVTUgiBkDTBwy1zss3bvn5XUdr8Fb7FJXRN3SA3ey W0bPlTCdPxtqWEuEdTG4m1pGknpYjNesLgk2zC8pYRRurq6CjYHE1EwjG7qPEL1VH7jfJaS xhVCaTU0UIQhAIQhFJCEIESkUEpIBWmIU7aqllp5BdkjCx3kVdqL23CDzDj2EOwzHp6OS/ cqCG/2l5t9F2nCKeOOkgZGBuNjaB6LC9qezbXt/ jcA70RaZxbUAjP0BWXwCYS4VSSA3Domm/ XJefd1DfR3LLila7O6OHHCMgAeZVWOUbt1Z4hIIwJJb8PUlY+nqiOVzBu8N9jqVFkUT27rm gjxWOocbp5IjuMewE6SRlrvQqvh1fFiDOJTskbYneEjd0ix6FRZiVw6giGdvFa/tlSx/ ZyvdYdyEu9M/0WyyT7osdVre3Et9mapgveYtiaAMyXOAVj7OM/ q5x2a0kkm3GB7zLx8SR56XbE4/ svRTVzDs7wJn8flrmh3Dw8GKO4yLnN3XfRo9V09q9r56o0pqIUlVCEIQCEkIgQhCKiQo2splJ EJBQhFWWIUsVXTSwTtDo5Glrgellp+E0MuGUYoJQfw5LGE/Ey/dPp+S3mXQrFYlG10LpCBdgvfwWWzG4d68qyYyN9tTkqb8Wo3gt9oh7ps4F4yKInXdloUV OFwzgPZEwPH9Oq8sPdjV8pQ1GHPDX8WIkcw1SGJUkIcY5obcwDYlY04RvSW/ hcR5lwAA9NFkKDCaeku/gRCQj4WgWVtpnjhXEqj3cbOxF1isWoajEsQw+hpgQ1j/ aJZDowt/8AO/ XO5+SyxFpPBZylYxsTHNAuW6rvVjc28u7L40jhWH0+F0bKWlbZjfU5WuVfNUAqjF63kSCkk mgEIQgEk0IhIQhFBUCpXSKIihCRKKhIcisXikMs9HI2AnfFngD4rG5b8wLLISG6iwZLmeXWP bTjKYncSMbzTyWRpa6OQBzXaajmFdV+CufO6oo3C783xO0J6g8j/ wBksFU0T2Sbrmvjl6HI/ wC148sZxl7sZxlnvbY7e+Fb1NdExuTxvHQcyteNJUueLyPt5rIUlGGuaN0ve7IDUlczk6pewh 8pBDS57jZrOpWw0kLqemiie7fc1ubupVLDqAUw4kucrhaw0aOgV7ZenVhOPMvNsny4IKo 0qmFILZ5/ GVUJqmCpgqoaEIQCEIRCRdCR1QCRKCVAooJUDc5BS8yEi7oFLdxjaBaLotllyTLch1UWOaH 7pyJUaREJDJRqIoJYj7Q1pY0XJfo3xvyVQrXduKatxPAqjDMOlEUtS3dkffRnMfPTyulLU+mk4 xt3RQVErcJpJquFriGyPka1rvEam3mjZztOoYK8DGcONNHJZvtLJeJw/ MWFm+S57UUlXhFe6gxKN0b/ AISRk4dQVk9itnjtLtE2me29LTjiVHiOQ+Z+gKka8Y5pl+zOZ8ZeiI5I5mNkie18bgC1zTcOB5g pnJYbDsMq8LZuU07X040gc3JvkeSycVQHd2Rro38w/wDdWGs410kLl5tyU+ale1/ FIBVyaN5PqogZElHNWqByaoG4OSqMJ5o5nFNF1ElK6rlJIoQgRUHaIQosdoN7wucypBJCjZ LkFGwuDbMHJCEEnaFWsLGlpkt33HN3MoQix0492xsb9pcKYQC3gONj13/9LN9ix/ E46LDuuhtlpk5CF1LD+jqXNRkY1zXbwBSQo2SaABkpBCEQne6mPdCEIIt95S5IQgZSQhGUv //Z",
"CKYCRequestId": "17",
"CKYCRequestDate": "28-Nov-2019",
"CKYCUpdatedDate": "31-Jan-2018",
"CKYCRemarks": "",
"CKYCIDDetails": [
{
"ID": [
{
"CKYCAvailableIDType": "E",
"CKYCAvailableIDTypeStatus": "01",
"CKYCIDRemarks": ""
}
]
}
],
"CKYCPhotoBytes": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAkGBwgHBgkIBwgKCgkLDRYPDQwMDRsUF RAWIB0iIiAdHx8kKDQsJCYxJx8fLT0tMTU3Ojo6Iys/ RD84QzQ5OjcBCgoKDQwNGg8PGjclHyU3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nz c3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3N//AABEIAIMAqQMBIgACEQEDEQH/ xAAcAAACAQUBAAAAAAAAAAAAAAAAAQIDBAUGBwj/ xAA5EAABAwIDBQUFBgcBAAAAAAABAAIDBBEFITEGEhNBUQciYXGRFDJCgaEWIySxwdEV UmJykuHwM//EABkBAQEBAQEBAAAAAAAAAAAAAAABAwIEBf/ EACERAQACAgICAgMAAAAAAAAAAAABEQIDITESQSIyBBND/ 9oADAMBAAIRAxEAPwDr7WqVk7IWbQITQgSaSLoAqBek9ysMTxKjwulfVV9RHBCwXLnu tfw8UF7v55ID8lxzH+2GTiyx4HRMMPuxzVFw6/8ANb9PqtMn7RNrpZHOfjksd/ gjiYAPLupEObel9/ NTDgvLbtstopXb0uN17j4TFv5LI4V2gbS4fK1zMWqJmDWOotI0+ov9VaPJ6WvkhaTsRt9Rb QxNgqzHS4jpwrndk/ tJ5+Gq3QOuoqaEBCATSQgaEIRQhCFUIIKEKKSSaSAUXKSoVMzYYnyPcGtaCSToAgsMZxej wijkqa2UMYxpdYakf9+a4H2g7X/ amtjEVMYqeB3cLn3d8hoPzVz2i7SyY5i00UT7UcDrNH8xHM/ Ww8VpEweCDmb8khxMqLjY5JA/JMt3kt0hdIqRlwGVvRVQXgZtBHgqLARmb/ JXEd79eiCtTz8Nwc1+7Zdk7NNvzWSR4Pjcv4jSnqHn3/6XHr0PPTVcZa1riMrO5jqhpdEQAT uX7rh8JSSHrhpUlqXZxtH9otnIZpnh1ZT/ AHNTnq4aO+Yz9Vto0XLsITSQNCAhFCEIVCQUIKgiUJpIEVqXaTiQwzZx77j72Rsfe0Op+trLb StA7aWh2x7SRpVx+lnXRJcHc90kji472Zc89Te5P1VWhpZMRrWwR3vJa56BUH/ dsI5kWctl7Pqfi4k6Qi4aFM5rGzXj5ZxDK4hsXGMOZ7OLysH+Y6fstGqKUxSFrr3BI7wsRbqv QVNSsmjs4C1ui1PbPY51RG6ro22maM8sneaw17Z6l6NumO8XKGR2yI8lV4e5rex5qczZKe Z0E0bmSA6OCTLvaWWuCvTdvJXpTdZgzzB6JMkG/ Zxu0oJIb3hpldW57py15IOj9i2JGh2qfQvf3ayIxkE5OcwFzT523l3lq8xbDVAg2twadztwCqYxx6XNv1t816dCjqE0JJopJhJNAIQhFJCEIESkmkgR0Wl9rMIl2Kqri5jlieP8wPyJW6Fa3t/ Tmp2SxKMZnhX9M0SXmWV13u+eS3bY1s1PRukgiL5XvNgtLkYRU7viuwbJUHBwmGQNu 7duAOay3ZVi1/ HxvK1SkxPaCmvfDmyN8Dp5rK4ftW2d5psRopKR9snHNjvIrEYhVbSGKofQMZDwyNyIRhzp BfO18r2UsIhxepbE7F4Gl8xcQ3h2dEAcg/lcjosfVt65pb7VbMUmKNMsLQ2UZsc3K/ gSubYhQT4bVARkvBNrEZjwIXeIMPZ7M4b2gtZajtDh8jd91LSskqHNcWbzcjbl+yuvZMcGzX GUW5gIaidjtymJa/ MObmAVYyRPaSHtLSNQVvmHwYgyndVTUgiBkDTBwy1zss3bvn5XUdr8Fb7FJXRN3SA3ey W0bPlTCdPxtqWEuEdTG4m1pGknpYjNesLgk2zC8pYRRurq6CjYHE1EwjG7qPEL1VH7jfJaS xhVCaTU0UIQhAIQhFJCEIESkUEpIBWmIU7aqllp5BdkjCx3kVdqL23CDzDj2EOwzHp6OS/ cqCG/2l5t9F2nCKeOOkgZGBuNjaB6LC9qezbXt/ jcA70RaZxbUAjP0BWXwCYS4VSSA3Domm/ XJefd1DfR3LLila7O6OHHCMgAeZVWOUbt1Z4hIIwJJb8PUlY+nqiOVzBu8N9jqVFkUT27rm gjxWOocbp5IjuMewE6SRlrvQqvh1fFiDOJTskbYneEjd0ix6FRZiVw6giGdvFa/tlSx/ ZyvdYdyEu9M/0WyyT7osdVre3Et9mapgveYtiaAMyXOAVj7OM/ q5x2a0kkm3GB7zLx8SR56XbE4/ svRTVzDs7wJn8flrmh3Dw8GKO4yLnN3XfRo9V09q9r56o0pqIUlVCEIQCEkIgQhCKiQo2splJ EJBQhFWWIUsVXTSwTtDo5Glrgellp+E0MuGUYoJQfw5LGE/Ey/ dPp+S3mXQrFYlG10LpCBdgvfwWWzG4d68qyYyN9tTkqb8Wo3gt9oh7ps4F4yKInXdloUV OFwzgPZEwPH9Oq8sPdjV8pQ1GHPDX8WIkcw1SGJUkIcY5obcwDYlY04RvSW/ hcR5lwAA9NFkKDCaeku/gRCQj4WgWVtpnjhXEqj3cbOxF1isWoajEsQw+hpgQ1j/ aJZDowt/8AO/ XO5+SyxFpPBZylYxsTHNAuW6rvVjc28u7L40jhWH0+F0bKWlbZjfU5WuVfNUAqjF63kSCkk mgEIQgEk0IhIQhFBUCpXSKIihCRKKhIcisXikMs9HI2AnfFngD4rG5b8wLLISG6iwZLmeXWP bTjKYncSMbzTyWRpa6OQBzXaajmFdV+CufO6oo3C783xO0J6g8j/ wBksFU0T2Sbrmvjl6HI/ wC148sZxl7sZxlnvbY7e+Fb1NdExuTxvHQcyteNJUueLyPt5rIUlGGuaN0ve7IDUlczk6pewh 8pBDS57jZrOpWw0kLqemiie7fc1ubupVLDqAUw4kucrhaw0aOgV7ZenVhOPMvNsny4IKo 0qmFILZ5/ GVUJqmCpgqoaEIQCEIRCRdCR1QCRKCVAooJUDc5BS8yEi7oFLdxjaBaLotllyTLch1UWOaH 7pyJUaREJDJRqIoJYj7Q1pY0XJfo3xvyVQrXduKatxPAqjDMOlEUtS3dkffRnMfPTyulLU+mk4 xt3RQVErcJpJquFriGyPka1rvEam3mjZztOoYK8DGcONNHJZvtLJeJw/ MWFm+S57UUlXhFe6gxKN0b/ AISRk4dQVk9itnjtLtE2me29LTjiVHiOQ+Z+gKka8Y5pl+zOZ8ZeiI5I5mNkie18bgC1zTcOB5g pnJYbDsMq8LZuU07X040gc3JvkeSycVQHd2Rro38w/wDdWGs410kLl5tyU+ale1/ FIBVyaN5PqogZElHNWqByaoG4OSqMJ5o5nFNF1ElK6rlJIoQgRUHaIQosdoN7wucypBJCjZ LkFGwuDbMHJCEEnaFWsLGlpkt33HN3MoQix0492xsb9pcKYQC3gONj13/9LN9ix/ E46LDuuhtlpk5CF1LD+jqXNRkY1zXbwBSQo2SaABkpBCEQne6mPdCEIIt95S5IQgZSQhGUv //Z"
}
]
}
}
```
# CKYC Download Service
URL: https://muleuat.capitalfirst.com:1447/ext/api/1.0/proc/ckyc/search
This RESTful API helps on-boarding FI applications to consume and download demographic details for customers from CKYC Repository
Request–Detail (can be multiple in one request)
<table>
<tr>
<th>Field Name/XML Tag</th>
<th>Mandatory</th>
<th>Data Type</th>
<th>Length</th>
<th>Remarks</th>
</tr>
<tr>
<td>TransactionId</td>
<td>Yes</td>
<td>String</td>
<td>60</td>
<td>Needs to be unique within that request</td>
</tr>
<tr>
<td>RecordIdentifier</td>
<td>No</td>
<td>String</td>
<td>60</td>
<td></td>
</tr>
<tr>
<td>ApplicationFormNo</td>
<td>No</td>
<td>String</td>
<td>60</td>
<td></td>
</tr>
<tr>
<td>BranchCode</td>
<td>No</td>
<td>String</td>
<td>60</td>
<td></td>
</tr>
<tr>
<td>CKYCNumber</td>
<td>No</td>
<td>String</td>
<td>60</td>
<td></td>
</tr>
<tr>
<td>DOB</td>
<td>Subjective</td>
<td>Date</td>
<td></td>
<td>Format of the date should be DD- MM-YYYY. Either one of the download authentication parameters is required from DOB, Mobile Number and Pin code + Birth Year.</td>
</tr>
<tr>
<td>MobileNumber</td>
<td>Subjective</td>
<td>String</td>
<td>10</td>
<td>Only numbers allowed.</td>
</tr>
<tr>
<td>Pincode</td>
<td>Subjective</td>
<td>String</td>
<td>6</td>
<td>Only numbers allowed. If pin code provided birth year is mandatory.</td>
</tr>
<tr>
<td>BirthYear</td>
<td>Subjective</td>
<td>String</td>
<td>4</td>
<td>Format should be YYYY. Only numbers allowed. If Birth Year provided pin code is mandatory.</td>
</tr>
</table>
## Request
```
{
"DownloadCkycRequest": {
"RequestId": "akxyzabcefghijkmopqrstuv",
"Source": "SFDC",
"Details": [
{
"TransactionId": "4565881",
"RecordIdentifier": "P5IUYY9635",
"ApplicationFormNo": "1",
"BranchCode": "11",
"CKYCNumber": "60000240829238",
"DOB": "1956-06-12",
"MobileNumber": "6088908888",
"Pincode": "400001",
"BirthYear": "1990"
}
]
}
}
```
## Response
```
{
"DownloadCkycResponse": {
"RequestId": "akxyzabcefghijkmopqrstuv",
"Details": {
"TransactionId": "tran1",
"TransactionStatus": "CKYCSuccess",
"CKYCPersonalDetail": [
{
"RecordIdentifier": "abcdefghijklmnopqrstuvwxyzabcdefghijklmnnopqrstuvwxyz",
"ApplicationFormNo": "abcdefghijklmnopqrstuvwxyzabcdefghijklm",
"BranchCode": "abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxy",
"CKYCConstiType": "01",
"CKYCAccType": "01",
"CKYCNumber": "10071234567847",
"CKYCNamePrefix": "Mr",
"CKYCFirstName": "Vikay",
"CKYCMiddleName": "",
"CKYCLastName": "Yadav",
"CKYCFullName": "MrVikay Yadav",
"CKYCMaidenNamePrefix": "",
"CKYCMaidenFirstName": "",
"CKYCMaidenMiddleName": "",
"CKYCMaidenLastName": "",
"CKYCMaidenFullName": "",
"CKYCFatherNamePrefix": "Mr",
"CKYCFatherFirstName": "Ram",
"CKYCFatherMiddleName": "",
"CKYCFatherLastName": "Yadav",
"CKYCFatherFullName": "MrRam Yadav",
"CKYCMotherNamePrefix": "Mrs",
"CKYCMotherFirstName": "Smita",
"CKYCMotherMiddletName": "",
"CKYCMotherLastName": "Yadav",
"CKYCMotherFullName": "MrsSmitaYadav",
"CKYCGender": "M",
"CKYCMaritalStatus": "01",
"CKYCNationality": "IN",
"CKYCOccupation": "B-01",
"CKYCDOB": "14-Mar-2005",
"CKYCResidentialStatus": "01",
"CKYCTaxResidencyOutsideIndia": "02",
"CKYCJurisdictionofRes": "",
"CKYCTIN": "",
"CKYCCountryOfBirth": "",
"CKYCPlaceOfBirth": "",
"CKYCPerAddType": "01",
"CKYCPerAdd1": "hjng",
"CKYCPerAdd2": "htg",
"CKYCPerAdd3": "ghtyj",
"CKYCPerAddCity": "Mumbai",
"CKYCPerAddDistrict": "Mumbai",
"CKYCPerAddState": "MH",
"CKYCPerAddCountry": "IN",
"CKYCPerAddPin": "400012",
"CKYCPerAddPOA": "VoterId",
"CKYCPerAddPOAOthers": "",
"CKYCPerAddSameasCorAdd": "N",
"CKYCCorAdd1": "jtyhjyj",
"CKYCCorAdd2": "jyu",
"CKYCCorAdd3": "rth",
"CKYCCorAddCity": "Mumbai",
"CKYCCorAddDistrict": "Mumbai",
"CKYCCorAddState": "MH",
"CKYCCorAddCountry": "IN",
"CKYCCorAddPin": "400012",
"CKYCPerAddSameAsJurAdd": "",
"CKYCJurAdd1": "",
"CKYCJurAdd2": "",
"CKYCJurAdd3": "",
"CKYCJurAddCity": "",
"CKYCJurAddState": "",
"CKYCJurAddCountry": "",
"CKYCJurAddPin": "",
"CKYCResTelSTD": "",
"CKYCResTelNumber": "",
"CKYCOffTelSTD": "",
"CKYCOffTelNumber": "",
"CKYCMobileISD": "",
"CKYCMobileNumber": "",
"CKYCFAXSTD": "0",
"CKYCFaxNumber": "",
"CKYCEmailAdd": "",
"CKYCRemarks": "",
"CKYCDateofDeclaration": "10-Dec-2018",
"CKYCPlaceofDeclaration": "Mumbai",
"CKYCKYCVerificationDate": "10-Dec-2018",
"CKYCTypeofDocSubmitted": "01",
"CKYCKYCVerificationName": "Harsad",
"CKYCKYCVerificationDesg": "Manager",
"CKYCKYCVerificationBranch": "Mumbai",
"CKYCKYCVerificationEmpcode": "1",
"CKYCNumberofIds": "1",
"CKYCNumberofRelatedPersons": "1",
"CKYCNumberofLocalAdds": "0",
"CKYCNumberofImages": "2",
"CKYCNameUpdated": "02",
"CKYCPersonalorEntityDetailsUpdated": "02",
"CKYCAddressDetailsUpdated": "02",
"CKYCContactDetailsUpdated": "02",
"CKYCRemarksUpdated": "02",
"CKYCKYCVerificationUpdated": "",
"CKYCIDDetailsUpdated": "02",
"CKYCRelatedPersonsUpdated": "02",
"CKYCImageDetailsUpdated": "02"
}
],
"CKYCIDDetails": [
{
"CKYCIdentity": {
"CKYCIDSequence": "1",
"CKYCIDType": "B",
"CKYCIDNumber": "M1000008",
"CKYCIDExpiryDate": "",
"CKYCIDProofSubmitted": "01",
"CKYCIDVerificationStatus": "02"
}
}
],
"CKYCRelatedPersonDetails": [
{
"CKYCRelatedPerson": {
"CKYCRPSequence": "1",
"CKYCRPRelation": "1",
"CKYCRPCKYCNumber": "",
"CKYCRPNamePrefix": "Mr",
"CKYCRPFirstName": "Yadav",
"CKYCRPMiddleName": "",
"CKYCRPLastName": "Yadav",
"CKYCRPPAN": "",
"CKYCRPAadhar": "",
"CKYCRPVoterId": "N1000008",
"CKYCRPNREGA": "",
"CKYCRPPassportNumber": "",
"CKYCRPPassportExpiryDate": "",
"CKYCRPDrivingLicenceNumber": "",
"CKYCRPDrivingLicenceExpiryDate": "",
"CKYCRPProofOfIdName": "",
"CKYCRPProofOfIdNumber": "",
"CKYCRPSimplifiedIDType": "",
"CKYCRPSimplifiedIDNumber": "",
"CKYCRPDateofDeclaration": "10-Dec-2018",
"CKYCRPPlaceofDeclaration": "Mumbai",
"CKYCRPKYCVerificationDate": "10-Dec-2018",
"CKYCRPTypeofDocSubmitted": "01",
"CKYCRPKYCVerificationName": "Harsad",
"CKYCRPKYCVerificationDesg": "Manager",
"CKYCRPKYCVerificationBranch": "Mumbai",
"CKYCRPKYCVerificationEmpcode": "1"
}
}
],
"CKYCImageDetails": [
{
"CKYCImageSequence": "1",
"CKYCImageExtension": "jpg",
"CKYCImageType": "Photograph",
"CKYCImageGlobalorLocal": "1",
"CKYCImageBranch": "",
"CKYCImageData": "/9j/4AAQSkZJRgABAQAAAQABA2N4MhuAe/b319ajpaY6Z8HIiEOBcm9muTY0WY5doA +PwHsHr96j7R1BAO8JI9JWDGnRT9Jx/9k="
},
{
"CKYCImageSequence": "2",
"CKYCImageExtension": "jpg",
"CKYCImageType": "VoterId",
"CKYCImageGlobalorLocal": "1",
"CKYCImageBranch": "",
"CKYCImageData": "/9j/4AAQSkZJRgABAQAAhuAY6Z8HIiEOBcm9muTY0WY5doA+PwHsHr96j7R1BAO8JI9JAQAB AA tLe+bhT9mLVH6N4T/FWtYH/9k="
}
]
}
}
}
```
# NSDL Request:
This RESTful API used to get the PAN details against PAN number.
URL: https://muleuat.capitalfirst.com:1447/jocata/nsdl_pan_verification
## Request
```
{
"panNumber": "DCFPA3715N"
}
```
## Response
```
{
"ResponseId": "5577865",
"Status": "Success",
"Response": {
"panNumber": "DCFPA3715N",
"firstName": "BASAVARAJU",
"middleName": "",
"lastName": "AKSHAY",
"panTitle": "Shri",
"panStatus": "Existing and Valid PAN",
"returnCode": "1",
"lastUpdatedDate": "31/12/2018",
"NamePrintedOnPANCard": "AKSHAY B",
"typeOfHolder": ""
}
}
```
# Create loan
URL: https://muleuat.capitalfirst.com:1447/ext/api/1.0/proc/createloan
## Request
```
{
"reqId": "4130",
"Sourcesystem": "VIRINCHI",
"Crnno": "2222555619",
"Loanid": "12345"
}
```
## Response
```
{
"Result": {
"Msg": "Successfully Received."
},
"reqId": "4130"
}
```
# FileNet - Get details
This REST API helps user to fetch the multiple documents based upon the Loan Number provided.
METHOD: GET
URL: https://muleuat.capitalfirst.com:8443/generic_api_gateway/v2/bpm_getDocuments
## Response
```
{
"getDocumentsResponse": {
"getDocumentsResponse": {
"return": {
"totalCount": "3",
"documentInfo": [
{
"@identifier": "1",
"pageInfo": [
{
"pageId": "{B080B46D-0000-CF14-B71A-BA252E041126}",
"pageNo": "2"
},
{
"pageId": "{E080B46D-0000-C418-BE23-7943909FB06B}",
"pageNo": "2"
},
{
"pageId": "{5081B46D-0000-CE16-8085-584EFE21D727}",
"pageNo": "2"
},
{
"pageId": "{402BB56D-0000-C318-8722-BB326B187406}",
"pageNo": "2"
},
{
"pageId": "{20C6B56D-0000-CF15-8992-8C95B340E14E}",
"pageNo": "2"
},
{
"pageId": "{40D2B56D-0000-C815-878F-2EF45EF4D09D}",
"pageNo": "2"
},
{
"pageId": "{20D5B56D-0000-CA16-9267-338CD4F2C06F}",
"pageNo": "2"
}
],
"property": [
{
"propertyName": "Id",
"propertyValue": "{9077B46D-0000-CC1B-B698-DD372DF79BFD}"
},
{
"propertyName": "CF_BPMLoanNumber",
"propertyValue": "6200062400"
},
{
"propertyName": "CF_BranchID",
"propertyValue": null
},
{
"propertyName": "CF_CaseID",
"propertyValue": null
},
{
"propertyName": "CF_CustomerName",
"propertyValue": null
},
{
"propertyName": "CF_CustomerRelationshipNumber",
"propertyValue": null
},
{
"propertyName": "CF_CustomerType",
"propertyValue": null
},
{
"propertyName": "CF_CustomerID",
"propertyValue": null
},
{
"propertyName": "CF_DocumentRemark",
"propertyValue": null
},
{
"propertyName": "CF_DocumentStatus",
"propertyValue": null
},
{
"propertyName": "DocumentTitle",
"propertyValue": "7QZX1563393828.xls"
},
{
"propertyName": "CF_DocumentTypeID",
"propertyValue": null
},
{
"propertyName": "CF_DocumentName",
"propertyValue": "Bank Statement Analysis Report"
},
{
"propertyName": "CF_DocumentExpiryDate",
"propertyValue": null
},
{
"propertyName": "CF_Mandatory",
"propertyValue": "N"
},
{
"propertyName": "CF_OriginalPhotocopy",
"propertyValue": "X"
},
{
"propertyName": "CF_DocumentTypeName",
"propertyValue": "Bank Statement Analysis Report"
},
{
"propertyName": "CF_FinnOneLoanNumber",
"propertyValue": null
},
{
"propertyName": "CF_Ingestion_Source",
"propertyValue": null
},
{
"propertyName": "CF_ProductID",
"propertyValue": null
},
{
"propertyName": "CF_SchemeID",
"propertyValue": null
},
{
"propertyName": "CF_SFDCLoanNumber",
"propertyValue": null
},
{
"propertyName": "CF_UploadDate",
"propertyValue": null
},
{
"propertyName": "CF_UploadedBy",
"propertyValue": "System"
},
{
"propertyName": "CF_DocumentUploadID",
"propertyValue": null
},
{
"propertyName": "Creator",
"propertyValue": "p8admin"
},
{
"propertyName": "DateCreated",
"propertyValue": "Thu Oct 10 12:30:01 IST 2019"
},
{
"propertyName": "CF_EncryptedPassword",
"propertyValue": null
},
{
"propertyName": "CF_ConnectorID",
"propertyValue": null
},
{
"propertyName": "CF_DealerOnboardingID",
"propertyValue": "0061546323"
},
{
"propertyName": "CF_CRMId",
"propertyValue": "10024523"
},
{
"propertyName": "CF_ApplicationId",
"propertyValue": "300001"
}
]
},
{
"@identifier": "2",
"property": [
{
"propertyName": "Id",
"propertyValue": "{90BAB56D-0000-C911-90F9-6F38C1C7DDA3}"
},
{
"propertyName": "CF_BPMLoanNumber",
"propertyValue": "6200062400"
},
{
"propertyName": "CF_BranchID",
"propertyValue": null
},
{
"propertyName": "CF_CaseID",
"propertyValue": null
},
{
"propertyName": "CF_CustomerName",
"propertyValue": null
},
{
"propertyName": "CF_CustomerRelationshipNumber",
"propertyValue": null
},
{
"propertyName": "CF_CustomerType",
"propertyValue": null
},
{
"propertyName": "CF_CustomerID",
"propertyValue": null
},
{
"propertyName": "CF_DocumentRemark",
"propertyValue": null
},
{
"propertyName": "CF_DocumentStatus",
"propertyValue": null
},
{
"propertyName": "DocumentTitle",
"propertyValue": "7QZX1563393828.xls"
},
{
"propertyName": "CF_DocumentTypeID",
"propertyValue": null
},
{
"propertyName": "CF_DocumentName",
"propertyValue": "Bank Statement Analysis Report"
},
{
"propertyName": "CF_DocumentExpiryDate",
"propertyValue": null
},
{
"propertyName": "CF_Mandatory",
"propertyValue": "N"
},
{
"propertyName": "CF_OriginalPhotocopy",
"propertyValue": "X"
},
{
"propertyName": "CF_DocumentTypeName",
"propertyValue": "Bank Statement Analysis Report"
},
{
"propertyName": "CF_FinnOneLoanNumber",
"propertyValue": null
},
{
"propertyName": "CF_Ingestion_Source",
"propertyValue": null
},
{
"propertyName": "CF_ProductID",
"propertyValue": null
},
{
"propertyName": "CF_SchemeID",
"propertyValue": null
},
{
"propertyName": "CF_SFDCLoanNumber",
"propertyValue": null
},
{
"propertyName": "CF_UploadDate",
"propertyValue": null
},
{
"propertyName": "CF_UploadedBy",
"propertyValue": "System"
},
{
"propertyName": "CF_DocumentUploadID",
"propertyValue": null
},
{
"propertyName": "Creator",
"propertyValue": "p8admin"
},
{
"propertyName": "DateCreated",
"propertyValue": "Thu Oct 10 18:22:50 IST 2019"
},
{
"propertyName": "CF_EncryptedPassword",
"propertyValue": null
},
{
"propertyName": "CF_ConnectorID",
"propertyValue": "0061656323"
},
{
"propertyName": "CF_DealerOnboardingID",
"propertyValue": "0061546323"
},
{
"propertyName": "CF_CRMId",
"propertyValue": "10024523"
},
{
"propertyName": "CF_ApplicationId",
"propertyValue": "300001"
}
]
},
{
"@identifier": "3",
"property": [
{
"propertyName": "Id",
"propertyValue": "{F0BAB56D-0000-C01E-A856-080E0D145F14}"
},
{
"propertyName": "CF_BPMLoanNumber",
"propertyValue": "6200062400"
},
{
"propertyName": "CF_BranchID",
"propertyValue": null
},
{
"propertyName": "CF_CaseID",
"propertyValue": null
},
{
"propertyName": "CF_CustomerName",
"propertyValue": null
},
{
"propertyName": "CF_CustomerRelationshipNumber",
"propertyValue": null
},
{
"propertyName": "CF_CustomerType",
"propertyValue": null
},
{
"propertyName": "CF_CustomerID",
"propertyValue": null
},
{
"propertyName": "CF_DocumentRemark",
"propertyValue": null
},
{
"propertyName": "CF_DocumentStatus",
"propertyValue": null
},
{
"propertyName": "DocumentTitle",
"propertyValue": "7QZX1563393828.xls"
},
{
"propertyName": "CF_DocumentTypeID",
"propertyValue": null
},
{
"propertyName": "CF_DocumentName",
"propertyValue": "Bank Statement Analysis Report"
},
{
"propertyName": "CF_DocumentExpiryDate",
"propertyValue": null
},
{
"propertyName": "CF_Mandatory",
"propertyValue": "N"
},
{
"propertyName": "CF_OriginalPhotocopy",
"propertyValue": "X"
},
{
"propertyName": "CF_DocumentTypeName",
"propertyValue": "Bank Statement Analysis Report"
},
{
"propertyName": "CF_FinnOneLoanNumber",
"propertyValue": null
},
{
"propertyName": "CF_Ingestion_Source",
"propertyValue": null
},
{
"propertyName": "CF_ProductID",
"propertyValue": null
},
{
"propertyName": "CF_SchemeID",
"propertyValue": null
},
{
"propertyName": "CF_SFDCLoanNumber",
"propertyValue": null
},
{
"propertyName": "CF_UploadDate",
"propertyValue": null
},
{
"propertyName": "CF_UploadedBy",
"propertyValue": "System"
},
{
"propertyName": "CF_DocumentUploadID",
"propertyValue": null
},
{
"propertyName": "Creator",
"propertyValue": "p8admin"
},
{
"propertyName": "DateCreated",
"propertyValue": "Thu Oct 10 18:23:12 IST 2019"
},
{
"propertyName": "CF_EncryptedPassword",
"propertyValue": null
},
{
"propertyName": "CF_ConnectorID",
"propertyValue": "0061656323"
},
{
"propertyName": "CF_DealerOnboardingID",
"propertyValue": "0061546323"
},
{
"propertyName": "CF_CRMId",
"propertyValue": "10024523"
},
{
"propertyName": "CF_ApplicationId",
"propertyValue": "300001"
}
]
}
]
}
},
"IsSucess": "true"
}
}
```
# Filenet upload
This RESTful API helps user to upload the documents to Filenet System.
URL:https://muleuat.capitalfirst.com:8443/generic_api_gateway/v2/bpm_uploadDocuments
## Response
```
{
"uploadDocuments": {
"docClass": "CF_LOANDOCUMENT",
"objectBean": [
{
"content": "dGVzdA==",
"fileLocation": "1071990_C.txt",
"property": [
{
"propertyName": "CF_DocumentName",
"propertyValue": "Bank Statement Analysis Report"
},
{
"propertyName": "DocumentTitle",
"propertyValue": "1071990_p.txt"
},
{
"propertyName": "CF_DocumentTypeName",
"propertyValue": "Bank Statement Analysis Report|{9077B46D-0000-CC1B-B698-DD372DF79BFD}"
},
{
"propertyName": "CF_UploadedBy",
"propertyValue": "System"
},
{
"propertyName": "CF_OriginalPhotocopy",
"propertyValue": "X"
},
{
"propertyName": "CF_Mandatory",
"propertyValue": "N"
},
{
"propertyName": "CF_DealerOnboardingID",
"propertyValue": "0061546323"
},
{
"propertyName": "CF_BPMLoanNumber",
"propertyValue": "6200062400"
},
{
"propertyName": "CF_pageNo",
"propertyValue": "2"
},
{
"propertyName": "CF_CRMId",
"propertyValue": "10024523"
},
{
"propertyName": "CF_ApplicationId",
"propertyValue": "300001"
}
]
}
],
"arg2": ""
},
"project": "Loan App",
"role": "View_Upload_All",
"documentType": "APPLICATION FORM"
}
```
# Filenet view document: Not described
URL: https://muleuat.capitalfirst.com:8443/generic_api_gateway/v2/bpm_view_document
# Drawdown
URL: https://muleuat.capitalfirst.com:1447/ext/api/1.0/proc/drawdown
## Request
```
{
"Application": {
"request": {
"reqId": "4130",
"sourcesystem": "FLPKRT",
"requesttype": "DR"
},
"disbursaldetails": {
"applicationid": "20023456",
"crnno": "2222555619",
"disbursalamt": "10000",
"bankaccno": "",
"micrcode": "",
"ifsccode": "",
"remarks": "Ok"
}
}
}
```
## Response
```
{
"Result": {"Msg": "Successfully Received."},
"reqId": "4130"
}
```
# Payment service
URL: https://muleuat.capitalfirst.com:1447/ext/api/1.0/proc/payment
## Request
```
{
"LoanId": "12345",
"TransactionDate": "",
"reqId": "IDF789421A8C49D19B9754412EEF1D70117",
"SourceName": "FLIPKART",
"POSAmount": "10000",
"LPPAmount": "500",
"TotalAmount": "10500",
"ChequeNo": "1123TR45",
"ReceiptNo": "1123TR45",
"TransactionType": "PMNT"
}
```
## Response
```
{
"reqId": "IDF789421A8C49D19B9754412EEF1D70111",
"SourceName": "FLIPKART",
"RespDesc": "LOAN NUMBER IS INACTIVE/INVALID.",
"RespCode": "000"
}
```
# Cancellation Service
URL: https://muleuat.capitalfirst.com:1447/ext/api/1.0/proc/cancelation
## Request
```
{
"LoanId": "12345",
"TransactionDate": "",
"reqId": "IDF789421A8C49D19B9754412EEF1D70117 ",
"SourceName": "FLIPKART",
"TotalAmount": "5000",
"ChequeNo": "1123TR45",
"ReceiptNo": "1123TR45",
"TransactionType": "CAN"
}
```
## Response
```
{
"reqId": "IDF789421A8C49D19B9754412EEF1D70117",
"SourceName": "MerchantValidateVPAResponse",
"ChequeId": "CK0001",
"RespDesc": "Duplicate TransactionId",
"RespCode": "154"
}
```
# Errors
<table>
<tr>
<th>Name</th>
<th>Description</th>
<th>Sample Value</th>
</tr>
<tr>
<td>Code</td>
<td>The code that corresponds to the type of error</td>
<td>401</td>
</tr>
<tr>
<td>message</td>
<td>A brief description of the error that corresponds to the error code</td>
<td>Upstream service did not authorize the request.</td>
</tr>
<tr>
<td>description</td>
<td>A more detailed description of the error that corresponds to the error code</td>
<td>Response code 401 mapped as failure</td>
</tr>
</table>
### Examples
```
{
"error": {
"code": "401",
"message": "Upstream service did not authorize the request.",
"description": "Response code 401 mapped as failure"
}
}
```
```
{
"code": 400,
"message": "Bad Request"
}
```
```
{
"code": "401",
"message": "Unauthorized"
}
```
Sign in with Wallet
Connect another wallet