Skip to main content

CreateMultipleGuarantorInformationCommand

Overview​

Adds multiple guarantors to a loan application in a single request. Each guarantor entry is validated and persisted independently.

Command Structure​

{
"cmd": "CreateMultipleGuarantorInformationCommand",
"data": "{\"loanQuoteId\":110,\"guarantors\":[{\"name\":\"Bola Tinubu\",\"emailAddress\":\"bola@example.com\",\"mobileNumber\":\"08098765432\",\"relationship\":\"Friend\",\"address\":\"12 Marina, Lagos\",\"homeAddress\":\"12 Marina, Lagos\",\"officeAddress\":\"Tower 1, VI, Lagos\",\"designation\":\"Director\",\"verificationDetails\":{\"verificationStatus\":\"Pending\",\"verificationComment\":\"\"}},{\"name\":\"Ngozi Obi\",\"emailAddress\":\"ngozi@example.com\",\"mobileNumber\":\"08011112222\",\"relationship\":\"Colleague\",\"address\":\"5 Awolowo Rd, Ikoyi\",\"homeAddress\":\"5 Awolowo Rd, Ikoyi\",\"officeAddress\":\"Plot 23 Adeola Odeku, VI\",\"designation\":\"Senior Analyst\",\"verificationDetails\":{\"verificationStatus\":\"Pending\",\"verificationComment\":\"\"}}]}"
}

Parameters​

ParameterTypeRequiredDescription
loanQuoteIdlongYesLoan application ID
guarantorsarrayYesArray of guarantor objects (see below)

Guarantor Object​

FieldTypeRequiredDescription
namestringYesFull name of guarantor
emailAddressstringYesEmail address
mobileNumberstringYesPhone number
relationshipstringYesRelationship to applicant
addressstringYesResidential address
homeAddressstringNoGuarantor's home address
officeAddressstringNoGuarantor's office/work address
designationstringNoGuarantor's job title or designation
verificationDetails.verificationStatusstringYesInitial status — typically "Pending"
verificationDetails.verificationCommentstringYesComment (can be empty)

Process​

  1. Validates loan quote exists
  2. Iterates through each guarantor object
  3. Creates a GuarantorInformation record for each, linked to the loan
  4. Sets verification status to Pending (0) by default
  5. Persists all records

Response​

{
"ok": true,
"statusCode": "00",
"message": "Guarantors added successfully.",
"outData": {
"Guarantors": [
{ "GuarantorId": 21, "Name": "Bola Tinubu" },
{ "GuarantorId": 22, "Name": "Ngozi Obi" }
]
}
}