API Reference›Servicing Plane›Verification›Start a verification session

Start a verification session

POSThttps://sandbox.api.lendeasy.ai/v1/servicing/verification/sessionsImplementedBearer token ·CREATE_SERVICING_VERIFICATION

Starts a purpose-bound session and returns policy-selected prompts without exposing expected answers.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/verification/sessions \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "customerRef": "123",
  "interactionId": 3001,
  "caseId": 1001,
  "purpose": "ACCOUNT_DISCLOSURE"
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/verification/sessions`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "customerRef": "123",
  "interactionId": 3001,
  "caseId": 1001,
  "purpose": "ACCOUNT_DISCLOSURE"
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/verification/sessions",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  json={
  "customerRef": "123",
  "interactionId": 3001,
  "caseId": 1001,
  "purpose": "ACCOUNT_DISCLOSURE"
},
)

{
  "sessionId": 7401,
  "status": "PENDING",
  "attemptLimit": 3,
  "prompts": [
    {
      "questionCode": "RECENT_PAYMENT_AMOUNT",
      "prompt": "What was the amount of your most recent payment?"
    }
  ],
  "resourceId": 7401
}

{
  "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.
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
customerRef required	string
interactionId required	integer
caseId optional	integer	Stable opaque servicing case identifier.
purpose required	string

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/verification/sessions \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "customerRef": "123",
  "interactionId": 3001,
  "caseId": 1001,
  "purpose": "ACCOUNT_DISCLOSURE"
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/verification/sessions`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "customerRef": "123",
  "interactionId": 3001,
  "caseId": 1001,
  "purpose": "ACCOUNT_DISCLOSURE"
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/verification/sessions",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  json={
  "customerRef": "123",
  "interactionId": 3001,
  "caseId": 1001,
  "purpose": "ACCOUNT_DISCLOSURE"
},
)

{
  "sessionId": 7401,
  "status": "PENDING",
  "attemptLimit": 3,
  "prompts": [
    {
      "questionCode": "RECENT_PAYMENT_AMOUNT",
      "prompt": "What was the amount of your most recent payment?"
    }
  ],
  "resourceId": 7401
}

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