PUT api/Borrower/JoinCoBorrower?preApprovalID={preApprovalID}
Joins co-borrower to the loan and send invitation with token valid for 3 days
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| preApprovalID |
ID of PreApproval object |
string |
None. |
Body Parameters
BorrowerEntity| Name | Description | Type | Additional information |
|---|---|---|---|
| BorrowerID | string |
None. |
|
| IsVerified |
If Borrower passed identification through Banks, it returns true |
boolean |
None. |
| Firstname | string |
Required String length: inclusive between 0 and 128 |
|
| Lastname | string |
Required String length: inclusive between 0 and 128 |
|
| PersonalID | string |
String length: inclusive between 0 and 50 |
|
| PhoneNo | string |
Required String length: inclusive between 0 and 50 |
|
| PhoneNoCountryCode | string |
String length: inclusive between 0 and 5 |
|
| Residence | string |
String length: inclusive between 0 and 128 |
|
| string |
String length: inclusive between 0 and 128 |
||
| MaritalStatus |
OBSOLETE: Marital status: Unmarried='U', Married='M', Separated='S', Divorced='D', Widow='W', Engaged='E', Other='O' |
string |
String length: inclusive between 0 and 1 |
| RelationshipToMain |
Used only for Joining coborrowers. Spouse='S', Daughter/Son='D', Sister/Brother='B', Relative='R', Parent='P', Partner='N', Grandparent='G', Grandchild='C' |
string |
String length: inclusive between 0 and 1 |
| InvitationAccepted |
Invitation status |
boolean |
None. |
| Status |
Coborrower Status (use instead InvitationAccepted), InvitationAccepted = 1, Confirmation of Invitation is pending = 0, Denied invitation = -1 |
integer |
None. |
| IsPhoneNoVerified |
Returns true if Phone No of borrower was checked |
boolean |
None. |
| PersonalDocumentType |
Type of personal Personal Document |
string |
String length: inclusive between 0 and 50 |
| PersonalDocumentNumber |
Number of Personal ID Card/Document |
string |
String length: inclusive between 0 and 20 |
Request Formats
application/json, text/json
{
"BorrowerID": "sample string 1",
"IsVerified": true,
"Firstname": "sample string 3",
"Lastname": "sample string 4",
"PersonalID": "sample string 5",
"PhoneNo": "sample string 6",
"PhoneNoCountryCode": "sample string 7",
"Residence": "sample string 8",
"eMail": "sample string 9",
"MaritalStatus": "sample string 10",
"RelationshipToMain": "sample string 11",
"InvitationAccepted": true,
"Status": 13,
"IsPhoneNoVerified": true,
"PersonalDocumentType": "sample string 15",
"PersonalDocumentNumber": "sample string 16"
}
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
HttpResponseMessage
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |