API Reference›LMS API›Loan parties›Add a loan party

Add a loan party

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

Creates a role-scoped relationship for a customer or external party with an explicit authority scope. Parties start PENDING_VERIFICATION unless created ACTIVE with evidence; an all-false authority scope is valid only for INFORMATIONAL_PARTY.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/loans/$LOAN_ID/parties \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "partyOwnerType": "CUSTOMER",
  "partyOwnerRef": "412",
  "role": "AUTHORIZED_THIRD_PARTY",
  "authorityScope": {
    "mayReceiveInformation": true,
    "mayMakePayments": false,
    "maySignDocuments": false,
    "mayApproveActions": false,
    "mayReceiveNotices": true
  },
  "effectiveFrom": "2027-05-01T00: 00:00Z",
  "evidenceRef": "doc_POA_4"
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/loans/${loanId}/parties`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "partyOwnerType": "CUSTOMER",
  "partyOwnerRef": "412",
  "role": "AUTHORIZED_THIRD_PARTY",
  "authorityScope": {
    "mayReceiveInformation": true,
    "mayMakePayments": false,
    "maySignDocuments": false,
    "mayApproveActions": false,
    "mayReceiveNotices": true
  },
  "effectiveFrom": "2027-05-01T00: 00:00Z",
  "evidenceRef": "doc_POA_4"
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/loans/{loan_id}/parties",
  headers={"Authorization": f"Bearer {token}", "Idempotency-Key": idempotency_key},
  json={
  "partyOwnerType": "CUSTOMER",
  "partyOwnerRef": "412",
  "role": "AUTHORIZED_THIRD_PARTY",
  "authorityScope": {
    "mayReceiveInformation": true,
    "mayMakePayments": false,
    "maySignDocuments": false,
    "mayApproveActions": false,
    "mayReceiveNotices": true
  },
  "effectiveFrom": "2027-05-01T00: 00:00Z",
  "evidenceRef": "doc_POA_4"
},
)

{
  "resourceId": 88
}

{
  "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": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "409",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "idempotency.request.in.flight",
  "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.
Idempotency-Key optional in header	string	Optional stable key (1-50 chars) for this one logical mutation. Replays of a completed request return the original result with x-served-from-cache: true; an in-flight duplicate returns 409 with Retry-After. Omitted keys are server-generated per attempt.

Body parameters

Field	Type	Description
partyOwnerType required	string
partyOwnerRef required	string
role required	string
authorityScope required	object
mayReceiveInformation	boolean
mayMakePayments	boolean
maySignDocuments	boolean
mayApproveActions	boolean
mayReceiveNotices	boolean
effectiveFrom required	string
evidenceRef required	string

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/loans/$LOAN_ID/parties \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "partyOwnerType": "CUSTOMER",
  "partyOwnerRef": "412",
  "role": "AUTHORIZED_THIRD_PARTY",
  "authorityScope": {
    "mayReceiveInformation": true,
    "mayMakePayments": false,
    "maySignDocuments": false,
    "mayApproveActions": false,
    "mayReceiveNotices": true
  },
  "effectiveFrom": "2027-05-01T00: 00:00Z",
  "evidenceRef": "doc_POA_4"
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/loans/${loanId}/parties`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "partyOwnerType": "CUSTOMER",
  "partyOwnerRef": "412",
  "role": "AUTHORIZED_THIRD_PARTY",
  "authorityScope": {
    "mayReceiveInformation": true,
    "mayMakePayments": false,
    "maySignDocuments": false,
    "mayApproveActions": false,
    "mayReceiveNotices": true
  },
  "effectiveFrom": "2027-05-01T00: 00:00Z",
  "evidenceRef": "doc_POA_4"
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/loans/{loan_id}/parties",
  headers={"Authorization": f"Bearer {token}", "Idempotency-Key": idempotency_key},
  json={
  "partyOwnerType": "CUSTOMER",
  "partyOwnerRef": "412",
  "role": "AUTHORIZED_THIRD_PARTY",
  "authorityScope": {
    "mayReceiveInformation": true,
    "mayMakePayments": false,
    "maySignDocuments": false,
    "mayApproveActions": false,
    "mayReceiveNotices": true
  },
  "effectiveFrom": "2027-05-01T00: 00:00Z",
  "evidenceRef": "doc_POA_4"
},
)

{
  "resourceId": 88
}

{
  "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": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "409",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "idempotency.request.in.flight",
  "errors": []
}