API Reference›LMS API›Customers›Create a customer

Create a customer

POSThttps://sandbox.api.lendeasy.ai/v1/customers Bearer token · CREATE_LMS_CUSTOMER

Creates a customer profile and, in the same request only, optional initial addresses, contact points, identifiers, and consents. The profile is a closed INDIVIDUAL or CORPORATE union; after creation the profile changes through PUT and each child collection changes through its own focused route.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/customers \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "profile": {
    "customerType": "INDIVIDUAL",
    "firstName": "Maya",
    "lastName": "Chen",
    "dateOfBirth": "1991-11-04",
    "externalId": "crm-person-81042"
  },
  "addresses": [
    {
      "addressType": "PRIMARY_RESIDENCE",
      "line1": "428 Alder Way",
      "city": "Sacramento",
      "stateCode": "US-CA",
      "postalCode": "95814",
      "country": "US",
      "isPrimary": true
    }
  ],
  "contactPoints": [
    {
      "contactType": "EMAIL",
      "value": "maya.chen@example.test",
      "isPrimary": true
    }
  ]
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/customers`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "profile": {
    "customerType": "INDIVIDUAL",
    "firstName": "Maya",
    "lastName": "Chen",
    "dateOfBirth": "1991-11-04",
    "externalId": "crm-person-81042"
  },
  "addresses": [
    {
      "addressType": "PRIMARY_RESIDENCE",
      "line1": "428 Alder Way",
      "city": "Sacramento",
      "stateCode": "US-CA",
      "postalCode": "95814",
      "country": "US",
      "isPrimary": true
    }
  ],
  "contactPoints": [
    {
      "contactType": "EMAIL",
      "value": "maya.chen@example.test",
      "isPrimary": true
    }
  ]
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/customers",
  headers={"Authorization": f"Bearer {token}", "Idempotency-Key": idempotency_key},
  json={
  "profile": {
    "customerType": "INDIVIDUAL",
    "firstName": "Maya",
    "lastName": "Chen",
    "dateOfBirth": "1991-11-04",
    "externalId": "crm-person-81042"
  },
  "addresses": [
    {
      "addressType": "PRIMARY_RESIDENCE",
      "line1": "428 Alder Way",
      "city": "Sacramento",
      "stateCode": "US-CA",
      "postalCode": "95814",
      "country": "US",
      "isPrimary": true
    }
  ],
  "contactPoints": [
    {
      "contactType": "EMAIL",
      "value": "maya.chen@example.test",
      "isPrimary": true
    }
  ]
},
)

{
  "resourceId": 412
}

{
  "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	Tenant selector: lowercase letters, digits, and hyphens, 1-64 characters. Exactly one instance; the only tenant selector honored.
Idempotency-Key optional in header	string	Optional stable key (1-50 chars) for this one logical mutation. Replays of a completed request return the original result with x-served-from-cache: true; an in-flight duplicate returns 409 with Retry-After. Omitted keys are server-generated per attempt.

Body parameters

Field	Type	Description
profile required	object
customerType	string
firstName	string
lastName	string
dateOfBirth	string
externalId	string	Caller-controlled identifier unique within the tenant and resource type.
addresses required	array<object>
addressType	string
line1	string
city	string
stateCode	string
postalCode	string
country	string
isPrimary	boolean
contactPoints required	array<object>
contactType	string
value	string
isPrimary	boolean

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/customers \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "profile": {
    "customerType": "INDIVIDUAL",
    "firstName": "Maya",
    "lastName": "Chen",
    "dateOfBirth": "1991-11-04",
    "externalId": "crm-person-81042"
  },
  "addresses": [
    {
      "addressType": "PRIMARY_RESIDENCE",
      "line1": "428 Alder Way",
      "city": "Sacramento",
      "stateCode": "US-CA",
      "postalCode": "95814",
      "country": "US",
      "isPrimary": true
    }
  ],
  "contactPoints": [
    {
      "contactType": "EMAIL",
      "value": "maya.chen@example.test",
      "isPrimary": true
    }
  ]
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/customers`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "profile": {
    "customerType": "INDIVIDUAL",
    "firstName": "Maya",
    "lastName": "Chen",
    "dateOfBirth": "1991-11-04",
    "externalId": "crm-person-81042"
  },
  "addresses": [
    {
      "addressType": "PRIMARY_RESIDENCE",
      "line1": "428 Alder Way",
      "city": "Sacramento",
      "stateCode": "US-CA",
      "postalCode": "95814",
      "country": "US",
      "isPrimary": true
    }
  ],
  "contactPoints": [
    {
      "contactType": "EMAIL",
      "value": "maya.chen@example.test",
      "isPrimary": true
    }
  ]
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/customers",
  headers={"Authorization": f"Bearer {token}", "Idempotency-Key": idempotency_key},
  json={
  "profile": {
    "customerType": "INDIVIDUAL",
    "firstName": "Maya",
    "lastName": "Chen",
    "dateOfBirth": "1991-11-04",
    "externalId": "crm-person-81042"
  },
  "addresses": [
    {
      "addressType": "PRIMARY_RESIDENCE",
      "line1": "428 Alder Way",
      "city": "Sacramento",
      "stateCode": "US-CA",
      "postalCode": "95814",
      "country": "US",
      "isPrimary": true
    }
  ],
  "contactPoints": [
    {
      "contactType": "EMAIL",
      "value": "maya.chen@example.test",
      "isPrimary": true
    }
  ]
},
)

{
  "resourceId": 412
}

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