API Reference›Servicing Plane›Workforce›Register an AI worker

Register an AI worker

POSThttps://sandbox.api.lendeasy.ai/v1/servicing/workersImplementedBearer token ·CREATE_SERVICING_WORKER

Registers an AI worker against a code-owned adapter contract and validates its eligibility and grants.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/workers \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "workerCode": "COLLECTIONS_VOICE_PRIMARY",
  "displayName": "Collections voice agent",
  "adapterCode": "OUTBOUND_VOICE_V1",
  "contractVersion": "1.0",
  "credentialRef": "voice-agent-client",
  "readinessEvidenceRef": "eval-2026-07-24",
  "queueCodes": [
    "COLLECTIONS"
  ],
  "taskTypeCodes": [
    "COLLECTIONS_OUTREACH"
  ],
  "skills": [
    "COLLECTIONS",
    "VOICE"
  ],
  "languages": [
    "en"
  ],
  "capacity": 20,
  "factGroupGrants": [
    "LOAN",
    "OVERDUE",
    "PAYMENT",
    "PAYMENT_INSTRUMENT",
    "CONTACT",
    "RESTRICTION"
  ],
  "toolGrants": [
    "CHECK_CONTACT_ELIGIBILITY",
    "SUBMIT_VOICE_DISPOSITION"
  ],
  "eligibleActionCodes": [
    "AR_002_CREATE_PROMISE_TO_PAY",
    "AR_007_PREPARE_BORROWER_AUTHORIZED_PAYMENT"
  ],
  "active": true
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/workers`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "workerCode": "COLLECTIONS_VOICE_PRIMARY",
  "displayName": "Collections voice agent",
  "adapterCode": "OUTBOUND_VOICE_V1",
  "contractVersion": "1.0",
  "credentialRef": "voice-agent-client",
  "readinessEvidenceRef": "eval-2026-07-24",
  "queueCodes": [
    "COLLECTIONS"
  ],
  "taskTypeCodes": [
    "COLLECTIONS_OUTREACH"
  ],
  "skills": [
    "COLLECTIONS",
    "VOICE"
  ],
  "languages": [
    "en"
  ],
  "capacity": 20,
  "factGroupGrants": [
    "LOAN",
    "OVERDUE",
    "PAYMENT",
    "PAYMENT_INSTRUMENT",
    "CONTACT",
    "RESTRICTION"
  ],
  "toolGrants": [
    "CHECK_CONTACT_ELIGIBILITY",
    "SUBMIT_VOICE_DISPOSITION"
  ],
  "eligibleActionCodes": [
    "AR_002_CREATE_PROMISE_TO_PAY",
    "AR_007_PREPARE_BORROWER_AUTHORIZED_PAYMENT"
  ],
  "active": true
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/workers",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  json={
  "workerCode": "COLLECTIONS_VOICE_PRIMARY",
  "displayName": "Collections voice agent",
  "adapterCode": "OUTBOUND_VOICE_V1",
  "contractVersion": "1.0",
  "credentialRef": "voice-agent-client",
  "readinessEvidenceRef": "eval-2026-07-24",
  "queueCodes": [
    "COLLECTIONS"
  ],
  "taskTypeCodes": [
    "COLLECTIONS_OUTREACH"
  ],
  "skills": [
    "COLLECTIONS",
    "VOICE"
  ],
  "languages": [
    "en"
  ],
  "capacity": 20,
  "factGroupGrants": [
    "LOAN",
    "OVERDUE",
    "PAYMENT",
    "PAYMENT_INSTRUMENT",
    "CONTACT",
    "RESTRICTION"
  ],
  "toolGrants": [
    "CHECK_CONTACT_ELIGIBILITY",
    "SUBMIT_VOICE_DISPOSITION"
  ],
  "eligibleActionCodes": [
    "AR_002_CREATE_PROMISE_TO_PAY",
    "AR_007_PREPARE_BORROWER_AUTHORIZED_PAYMENT"
  ],
  "active": true
},
)

{
  "workerId": 5101,
  "workerCode": "COLLECTIONS_VOICE_PRIMARY",
  "active": true,
  "resourceId": 5101
}

{
  "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
workerCode required	string
displayName required	string
adapterCode required	string
contractVersion required	string
credentialRef optional	string
readinessEvidenceRef optional	string
queueCodes required	array<string>
taskTypeCodes required	array<string>
skills required	array<string>
languages required	array<string>
capacity required	integer
factGroupGrants required	array<string>
toolGrants required	array<string>
eligibleActionCodes required	array<string>
active required	boolean

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/workers \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "workerCode": "COLLECTIONS_VOICE_PRIMARY",
  "displayName": "Collections voice agent",
  "adapterCode": "OUTBOUND_VOICE_V1",
  "contractVersion": "1.0",
  "credentialRef": "voice-agent-client",
  "readinessEvidenceRef": "eval-2026-07-24",
  "queueCodes": [
    "COLLECTIONS"
  ],
  "taskTypeCodes": [
    "COLLECTIONS_OUTREACH"
  ],
  "skills": [
    "COLLECTIONS",
    "VOICE"
  ],
  "languages": [
    "en"
  ],
  "capacity": 20,
  "factGroupGrants": [
    "LOAN",
    "OVERDUE",
    "PAYMENT",
    "PAYMENT_INSTRUMENT",
    "CONTACT",
    "RESTRICTION"
  ],
  "toolGrants": [
    "CHECK_CONTACT_ELIGIBILITY",
    "SUBMIT_VOICE_DISPOSITION"
  ],
  "eligibleActionCodes": [
    "AR_002_CREATE_PROMISE_TO_PAY",
    "AR_007_PREPARE_BORROWER_AUTHORIZED_PAYMENT"
  ],
  "active": true
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/workers`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "workerCode": "COLLECTIONS_VOICE_PRIMARY",
  "displayName": "Collections voice agent",
  "adapterCode": "OUTBOUND_VOICE_V1",
  "contractVersion": "1.0",
  "credentialRef": "voice-agent-client",
  "readinessEvidenceRef": "eval-2026-07-24",
  "queueCodes": [
    "COLLECTIONS"
  ],
  "taskTypeCodes": [
    "COLLECTIONS_OUTREACH"
  ],
  "skills": [
    "COLLECTIONS",
    "VOICE"
  ],
  "languages": [
    "en"
  ],
  "capacity": 20,
  "factGroupGrants": [
    "LOAN",
    "OVERDUE",
    "PAYMENT",
    "PAYMENT_INSTRUMENT",
    "CONTACT",
    "RESTRICTION"
  ],
  "toolGrants": [
    "CHECK_CONTACT_ELIGIBILITY",
    "SUBMIT_VOICE_DISPOSITION"
  ],
  "eligibleActionCodes": [
    "AR_002_CREATE_PROMISE_TO_PAY",
    "AR_007_PREPARE_BORROWER_AUTHORIZED_PAYMENT"
  ],
  "active": true
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/workers",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  json={
  "workerCode": "COLLECTIONS_VOICE_PRIMARY",
  "displayName": "Collections voice agent",
  "adapterCode": "OUTBOUND_VOICE_V1",
  "contractVersion": "1.0",
  "credentialRef": "voice-agent-client",
  "readinessEvidenceRef": "eval-2026-07-24",
  "queueCodes": [
    "COLLECTIONS"
  ],
  "taskTypeCodes": [
    "COLLECTIONS_OUTREACH"
  ],
  "skills": [
    "COLLECTIONS",
    "VOICE"
  ],
  "languages": [
    "en"
  ],
  "capacity": 20,
  "factGroupGrants": [
    "LOAN",
    "OVERDUE",
    "PAYMENT",
    "PAYMENT_INSTRUMENT",
    "CONTACT",
    "RESTRICTION"
  ],
  "toolGrants": [
    "CHECK_CONTACT_ELIGIBILITY",
    "SUBMIT_VOICE_DISPOSITION"
  ],
  "eligibleActionCodes": [
    "AR_002_CREATE_PROMISE_TO_PAY",
    "AR_007_PREPARE_BORROWER_AUTHORIZED_PAYMENT"
  ],
  "active": true
},
)

{
  "workerId": 5101,
  "workerCode": "COLLECTIONS_VOICE_PRIMARY",
  "active": true,
  "resourceId": 5101
}

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