API Reference›LMS API›Loan parties›List loan parties

List loan parties

GEThttps://sandbox.api.lendeasy.ai/v1/loans/{loanId}/parties Bearer token · READ_LMS_LOAN_PARTY

Lists co-borrower, guarantor, and authorized-party relationships for the loan. Removed parties are excluded unless requested by status.

Request

curl https://sandbox.api.lendeasy.ai/v1/loans/$LOAN_ID/parties \
  -H "Authorization: Bearer $TOKEN"

await fetch(`https://sandbox.api.lendeasy.ai/v1/loans/${loanId}/parties`, {
  method: "GET",
  headers: { Authorization: `Bearer ${token}` },
});

requests.get(
  f"https://sandbox.api.lendeasy.ai/v1/loans/{loan_id}/parties",
  headers={"Authorization": f"Bearer {token}"},
)

{
  "items": [
    {
      "partyId": 88,
      "loanRef": "7204",
      "partyOwnerType": "CUSTOMER",
      "partyOwnerRef": "412",
      "role": "AUTHORIZED_THIRD_PARTY",
      "authorityScope": {
        "mayReceiveInformation": true,
        "mayMakePayments": false,
        "maySignDocuments": false,
        "mayApproveActions": false,
        "mayReceiveNotices": true
      },
      "status": "ACTIVE",
      "effectiveFrom": "2027-05-01T00: 00:00Z",
      "evidenceRef": "doc_POA_4",
      "createdAt": "2027-05-01T16: 00:00Z",
      "lastModifiedAt": "2027-05-01T16: 00:00Z"
    }
  ]
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "400",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "validation.msg.validation.errors.exist",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "401",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authenticated",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "403",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authorized",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "404",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.resource.not.found",
  "errors": []
}

Path & query parameters

Field	Type	Description
LendEasy-Tenant required in header	string	Tenant selector: lowercase letters, digits, and hyphens, 1-64 characters. Exactly one instance; the only tenant selector honored.
loanId required in path	string	Stable opaque loan identifier.
status optional in query	string	Filter by party status; the default excludes REMOVED. One of `PENDING_VERIFICATION · ACTIVE · REMOVED`.
role optional in query	string	Filter by party role.
partyOwnerType optional in query	string	Filter by owner type. One of `CUSTOMER · EXTERNAL_PARTY`.
limit optional in query	integer	Maximum records to return.
offset optional in query	integer	Zero-based offset into the result set.

Request

curl https://sandbox.api.lendeasy.ai/v1/loans/$LOAN_ID/parties \
  -H "Authorization: Bearer $TOKEN"

await fetch(`https://sandbox.api.lendeasy.ai/v1/loans/${loanId}/parties`, {
  method: "GET",
  headers: { Authorization: `Bearer ${token}` },
});

requests.get(
  f"https://sandbox.api.lendeasy.ai/v1/loans/{loan_id}/parties",
  headers={"Authorization": f"Bearer {token}"},
)

{
  "items": [
    {
      "partyId": 88,
      "loanRef": "7204",
      "partyOwnerType": "CUSTOMER",
      "partyOwnerRef": "412",
      "role": "AUTHORIZED_THIRD_PARTY",
      "authorityScope": {
        "mayReceiveInformation": true,
        "mayMakePayments": false,
        "maySignDocuments": false,
        "mayApproveActions": false,
        "mayReceiveNotices": true
      },
      "status": "ACTIVE",
      "effectiveFrom": "2027-05-01T00: 00:00Z",
      "evidenceRef": "doc_POA_4",
      "createdAt": "2027-05-01T16: 00:00Z",
      "lastModifiedAt": "2027-05-01T16: 00:00Z"
    }
  ]
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "400",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "validation.msg.validation.errors.exist",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "401",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authenticated",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "403",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authorized",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "404",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.resource.not.found",
  "errors": []
}