API Reference›LMS API›Search›Search customers and loans

Search customers and loans

GEThttps://sandbox.api.lendeasy.ai/v1/portfolio/search Bearer token · READ_LMS_CUSTOMER | READ_LMS_LOAN_SUMMARY

Permission-aware exact and prefix search: name token-prefix, exact current email, canonical phone, and exact loan account number. Results are safe summaries; the query and matched contact values are never echoed, and the response is never cached.

Request

curl https://sandbox.api.lendeasy.ai/v1/portfolio/search?q=example \
  -H "Authorization: Bearer $TOKEN"

await fetch(`https://sandbox.api.lendeasy.ai/v1/portfolio/search?q=example`, {
  method: "GET",
  headers: { Authorization: `Bearer ${token}` },
});

requests.get(
  f"https://sandbox.api.lendeasy.ai/v1/portfolio/search?q=example",
  headers={"Authorization": f"Bearer {token}"},
)

{
  "items": [
    {
      "resultType": "CUSTOMER",
      "customerId": "412",
      "displayName": "Maya Chen",
      "customerType": "INDIVIDUAL",
      "status": "ACTIVE"
    },
    {
      "resultType": "LOAN",
      "loanId": "7204",
      "customerId": "412",
      "displayName": "Maya Chen",
      "loanAccountNumber": "000007204",
      "loanProductId": 3,
      "loanProductName": "Harbor 18-month personal loan",
      "status": "ACTIVE"
    }
  ],
  "nextCursor": 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": []
}

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.
q required in query	string	Search text, 2–320 characters after trimming.
type optional in query	string	Restrict to one result type; omit for both. One of `customer · loan`.
limit optional in query	integer	Maximum results to return.
cursor optional in query	string	Opaque cursor bound to the same query, type set, and caller scope.

Request

curl https://sandbox.api.lendeasy.ai/v1/portfolio/search?q=example \
  -H "Authorization: Bearer $TOKEN"

await fetch(`https://sandbox.api.lendeasy.ai/v1/portfolio/search?q=example`, {
  method: "GET",
  headers: { Authorization: `Bearer ${token}` },
});

requests.get(
  f"https://sandbox.api.lendeasy.ai/v1/portfolio/search?q=example",
  headers={"Authorization": f"Bearer {token}"},
)

{
  "items": [
    {
      "resultType": "CUSTOMER",
      "customerId": "412",
      "displayName": "Maya Chen",
      "customerType": "INDIVIDUAL",
      "status": "ACTIVE"
    },
    {
      "resultType": "LOAN",
      "loanId": "7204",
      "customerId": "412",
      "displayName": "Maya Chen",
      "loanAccountNumber": "000007204",
      "loanProductId": 3,
      "loanProductName": "Harbor 18-month personal loan",
      "status": "ACTIVE"
    }
  ],
  "nextCursor": 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": []
}