API Reference›Servicing Plane›Portal contracts›Accept an agreement

Accept an agreement

POSThttps://sandbox.api.lendeasy.ai/v1/servicing/portal-agreements/{agreementRef}/acceptanceImplementedBearer token ·RECORD_PORTAL_AGREEMENT_RESPONSE

Records the borrower signature after checking status, expiry, document digest, and signer, then starts execution of the bound reschedule. executionState is EXECUTING when execution is queued and INVALIDATED when the loan drifted since pricing; refusals return 409 codes such as offer.superseded, offer.expired, agreement.digest_mismatch, and offer.signer_mismatch.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/portal-agreements/$AGREEMENT_REF/acceptance \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "signerCustomerRef": "123",
  "documentDigest": "2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824",
  "evidenceRef": "portal-consent-9001-123"
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/portal-agreements/${agreementRef}/acceptance`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "signerCustomerRef": "123",
  "documentDigest": "2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824",
  "evidenceRef": "portal-consent-9001-123"
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/portal-agreements/{agreement_ref}/acceptance",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  json={
  "signerCustomerRef": "123",
  "documentDigest": "2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824",
  "evidenceRef": "portal-consent-9001-123"
},
)

{
  "acceptanceId": "LE-ACC-9001",
  "executionState": "EXECUTING",
  "invalidationReason": null
}

{
  "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	Opaque active LendEasy tenant-registry identifier. Supply exactly one instance; no alternate tenant selector is accepted.
agreementRef required in path	string	Stable opaque agreementRef identifier.
customerRef optional in query	string	Customer the agreement is addressed to.
Idempotency-Key optional in header	string	Optional replay key for this logical mutation. Omission creates a fresh server-owned key for this attempt; blank, repeated, or longer-than-50-character values are rejected.

Body parameters

Field	Type	Description
signerCustomerRef required	string
documentDigest required	string
evidenceRef required	string

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/portal-agreements/$AGREEMENT_REF/acceptance \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "signerCustomerRef": "123",
  "documentDigest": "2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824",
  "evidenceRef": "portal-consent-9001-123"
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/portal-agreements/${agreementRef}/acceptance`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "signerCustomerRef": "123",
  "documentDigest": "2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824",
  "evidenceRef": "portal-consent-9001-123"
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/portal-agreements/{agreement_ref}/acceptance",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  json={
  "signerCustomerRef": "123",
  "documentDigest": "2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824",
  "evidenceRef": "portal-consent-9001-123"
},
)

{
  "acceptanceId": "LE-ACC-9001",
  "executionState": "EXECUTING",
  "invalidationReason": null
}

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