API Reference›Servicing Plane›Workforce›Create a servicing user

Create a servicing user

POSThttps://sandbox.api.lendeasy.ai/v1/servicing/usersImplementedBearer token ·CREATE_SERVICING_USER

Atomically creates the human login, HUMAN worker, presence, and queue/task eligibility profile.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/users \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "username": "maria.agent",
  "temporaryPassword": "<write-only>",
  "firstName": "Maria",
  "lastName": "Agent",
  "email": "maria@example.invalid",
  "officeId": 1,
  "roleIds": [
    7
  ],
  "workerProfile": {
    "queueCodes": [
      "COLLECTIONS"
    ],
    "taskTypeCodes": [
      "COLLECTIONS_OUTREACH"
    ],
    "skills": [
      "COLLECTIONS"
    ],
    "languages": [
      "en"
    ],
    "capacity": 8
  }
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/users`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "username": "maria.agent",
  "temporaryPassword": "<write-only>",
  "firstName": "Maria",
  "lastName": "Agent",
  "email": "maria@example.invalid",
  "officeId": 1,
  "roleIds": [
    7
  ],
  "workerProfile": {
    "queueCodes": [
      "COLLECTIONS"
    ],
    "taskTypeCodes": [
      "COLLECTIONS_OUTREACH"
    ],
    "skills": [
      "COLLECTIONS"
    ],
    "languages": [
      "en"
    ],
    "capacity": 8
  }
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/users",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  json={
  "username": "maria.agent",
  "temporaryPassword": "<write-only>",
  "firstName": "Maria",
  "lastName": "Agent",
  "email": "maria@example.invalid",
  "officeId": 1,
  "roleIds": [
    7
  ],
  "workerProfile": {
    "queueCodes": [
      "COLLECTIONS"
    ],
    "taskTypeCodes": [
      "COLLECTIONS_OUTREACH"
    ],
    "skills": [
      "COLLECTIONS"
    ],
    "languages": [
      "en"
    ],
    "capacity": 8
  }
},
)

{
  "userId": 4101,
  "username": "maria.agent",
  "displayName": "Maria Agent",
  "active": true,
  "resourceId": 4101
}

{
  "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
username required	string
temporaryPassword required	string
firstName required	string
lastName required	string
email required	string
officeId required	integer
roleIds required	array<integer>
workerProfile optional	object
queueCodes	array<string>
taskTypeCodes	array<string>
skills	array<string>
languages	array<string>
capacity	integer

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/users \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "username": "maria.agent",
  "temporaryPassword": "<write-only>",
  "firstName": "Maria",
  "lastName": "Agent",
  "email": "maria@example.invalid",
  "officeId": 1,
  "roleIds": [
    7
  ],
  "workerProfile": {
    "queueCodes": [
      "COLLECTIONS"
    ],
    "taskTypeCodes": [
      "COLLECTIONS_OUTREACH"
    ],
    "skills": [
      "COLLECTIONS"
    ],
    "languages": [
      "en"
    ],
    "capacity": 8
  }
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/users`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "username": "maria.agent",
  "temporaryPassword": "<write-only>",
  "firstName": "Maria",
  "lastName": "Agent",
  "email": "maria@example.invalid",
  "officeId": 1,
  "roleIds": [
    7
  ],
  "workerProfile": {
    "queueCodes": [
      "COLLECTIONS"
    ],
    "taskTypeCodes": [
      "COLLECTIONS_OUTREACH"
    ],
    "skills": [
      "COLLECTIONS"
    ],
    "languages": [
      "en"
    ],
    "capacity": 8
  }
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/users",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  json={
  "username": "maria.agent",
  "temporaryPassword": "<write-only>",
  "firstName": "Maria",
  "lastName": "Agent",
  "email": "maria@example.invalid",
  "officeId": 1,
  "roleIds": [
    7
  ],
  "workerProfile": {
    "queueCodes": [
      "COLLECTIONS"
    ],
    "taskTypeCodes": [
      "COLLECTIONS_OUTREACH"
    ],
    "skills": [
      "COLLECTIONS"
    ],
    "languages": [
      "en"
    ],
    "capacity": 8
  }
},
)

{
  "userId": 4101,
  "username": "maria.agent",
  "displayName": "Maria Agent",
  "active": true,
  "resourceId": 4101
}

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