API Reference›LMS API›Forms›Create a form definition

Create a form definition

POSThttps://sandbox.api.lendeasy.ai/v1/form-definitions Bearer token · ADMIN_LMS_FORM_DEFINITION

Creates a draft definition for a CUSTOMER or LOAN target with SINGLE or MULTIPLE entry mode and a typed field schema. Creation atomically registers the form’s derived read, write, and delete permissions from its immutable key.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/form-definitions \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "formKey": "consumer_income",
  "targetType": "CUSTOMER",
  "entryMode": "SINGLE",
  "name": "Consumer income",
  "schema": {
    "sections": [
      {
        "fields": [
          {
            "fieldKey": "employment_status",
            "dataType": "SINGLE_SELECT",
            "required": true,
            "options": [
              {
                "code": "EMPLOYED",
                "label": "Employed"
              },
              {
                "code": "SELF_EMPLOYED",
                "label": "Self-employed"
              },
              {
                "code": "RETIRED",
                "label": "Retired"
              }
            ]
          },
          {
            "fieldKey": "gross_monthly_income",
            "dataType": "DECIMAL",
            "required": true
          }
        ]
      }
    ]
  }
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/form-definitions`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "formKey": "consumer_income",
  "targetType": "CUSTOMER",
  "entryMode": "SINGLE",
  "name": "Consumer income",
  "schema": {
    "sections": [
      {
        "fields": [
          {
            "fieldKey": "employment_status",
            "dataType": "SINGLE_SELECT",
            "required": true,
            "options": [
              {
                "code": "EMPLOYED",
                "label": "Employed"
              },
              {
                "code": "SELF_EMPLOYED",
                "label": "Self-employed"
              },
              {
                "code": "RETIRED",
                "label": "Retired"
              }
            ]
          },
          {
            "fieldKey": "gross_monthly_income",
            "dataType": "DECIMAL",
            "required": true
          }
        ]
      }
    ]
  }
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/form-definitions",
  headers={"Authorization": f"Bearer {token}", "Idempotency-Key": idempotency_key},
  json={
  "formKey": "consumer_income",
  "targetType": "CUSTOMER",
  "entryMode": "SINGLE",
  "name": "Consumer income",
  "schema": {
    "sections": [
      {
        "fields": [
          {
            "fieldKey": "employment_status",
            "dataType": "SINGLE_SELECT",
            "required": true,
            "options": [
              {
                "code": "EMPLOYED",
                "label": "Employed"
              },
              {
                "code": "SELF_EMPLOYED",
                "label": "Self-employed"
              },
              {
                "code": "RETIRED",
                "label": "Retired"
              }
            ]
          },
          {
            "fieldKey": "gross_monthly_income",
            "dataType": "DECIMAL",
            "required": true
          }
        ]
      }
    ]
  }
},
)

{
  "resourceId": 12
}

{
  "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
formKey required	string
targetType required	string
entryMode required	string
name required	string
schema required	object
sections	array<object>

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/form-definitions \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "formKey": "consumer_income",
  "targetType": "CUSTOMER",
  "entryMode": "SINGLE",
  "name": "Consumer income",
  "schema": {
    "sections": [
      {
        "fields": [
          {
            "fieldKey": "employment_status",
            "dataType": "SINGLE_SELECT",
            "required": true,
            "options": [
              {
                "code": "EMPLOYED",
                "label": "Employed"
              },
              {
                "code": "SELF_EMPLOYED",
                "label": "Self-employed"
              },
              {
                "code": "RETIRED",
                "label": "Retired"
              }
            ]
          },
          {
            "fieldKey": "gross_monthly_income",
            "dataType": "DECIMAL",
            "required": true
          }
        ]
      }
    ]
  }
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/form-definitions`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "formKey": "consumer_income",
  "targetType": "CUSTOMER",
  "entryMode": "SINGLE",
  "name": "Consumer income",
  "schema": {
    "sections": [
      {
        "fields": [
          {
            "fieldKey": "employment_status",
            "dataType": "SINGLE_SELECT",
            "required": true,
            "options": [
              {
                "code": "EMPLOYED",
                "label": "Employed"
              },
              {
                "code": "SELF_EMPLOYED",
                "label": "Self-employed"
              },
              {
                "code": "RETIRED",
                "label": "Retired"
              }
            ]
          },
          {
            "fieldKey": "gross_monthly_income",
            "dataType": "DECIMAL",
            "required": true
          }
        ]
      }
    ]
  }
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/form-definitions",
  headers={"Authorization": f"Bearer {token}", "Idempotency-Key": idempotency_key},
  json={
  "formKey": "consumer_income",
  "targetType": "CUSTOMER",
  "entryMode": "SINGLE",
  "name": "Consumer income",
  "schema": {
    "sections": [
      {
        "fields": [
          {
            "fieldKey": "employment_status",
            "dataType": "SINGLE_SELECT",
            "required": true,
            "options": [
              {
                "code": "EMPLOYED",
                "label": "Employed"
              },
              {
                "code": "SELF_EMPLOYED",
                "label": "Self-employed"
              },
              {
                "code": "RETIRED",
                "label": "Retired"
              }
            ]
          },
          {
            "fieldKey": "gross_monthly_income",
            "dataType": "DECIMAL",
            "required": true
          }
        ]
      }
    ]
  }
},
)

{
  "resourceId": 12
}

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