API Reference

Create an Embarc Client

post
https://embarc-api-qa.lendapi.com/embarc-core/api/v1/embarc/clients

Create a standard Fineract client through a Clarifi-owned facade that accepts legalFormType, configurable identity and contact fields, individual-only lookup-backed borrower metadata, an optional inline primary address, and an optional embedded first payment instrument.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Simplified Embarc client-create payload. Unsupported parameters are rejected, omitted operational fields such as officeId, dateFormat, locale, and active are defaulted by the facade, lookup-backed fields resolve against the same code-value lists used by the standard client template, configurable required fields are governed by embarc-client-require-* configuration, and embedded paymentInstrument creates the first payment instrument for the new client when supplied.

Simplified request payload used to create a standard client through the Embarc facade. Optional embedded paymentInstrument allows the first bank account or card to be created for the new client in the same request.

string
enum
required

Determines whether the request uses individual-name fields or a business name and maps to the internal legal form.

Allowed:
string

Given name for an individual client. Required when legalFormType is INDIVIDUAL.

string

Middle name for an individual client. Allowed only when legalFormType is INDIVIDUAL.

string

Family name for an individual client. Required when legalFormType is INDIVIDUAL.

string

Business display name. Required when legalFormType is BUSINESS and mapped to the core client fullname field.

string | null

Primary email address for the client. Required when embarc-client-require-email-address is enabled. When supplied with a non-blank value, it must be one valid mailbox address, is trimmed and lowercased before storage, and must be unique across clients and non-deleted app users. Display-name and multi-recipient formats are rejected.

string | null

Primary phone number. Required when embarc-client-require-mobile-no is enabled. When supplied with a non-blank value, it must parse as a possible phone number and is normalized to E.164 before storage. Values without an explicit country code are parsed with default region US; international values with explicit country codes are accepted when possible.

string | null

Individual-only client-type label such as Military or Tribal. Required for individual clients when embarc-client-require-client-type is enabled. The facade resolves it case-insensitively against the ClientType code-value list and omits the internal ID when no matching option exists. Frontend labels should display this field as Customer Type.

string | null
enum

Individual-only public gender value. Required for individual clients when embarc-client-require-gender is enabled. The facade validates it case-insensitively and resolves it against the Gender code-value list. If the matching option is missing, the request still succeeds and the internal gender ID is omitted.

Allowed:
string | null
enum

Optional individual-only public risk-rating value. The facade validates it case-insensitively and resolves it against the ClientClassification code-value list. If the matching option is missing, the request still succeeds and the internal classification ID is omitted.

Allowed:
string | null

Date-only value using the effective dateFormat and locale. Required when embarc-client-require-date-of-birth is enabled. Explicit null is treated as absent before delegation to core.

string

Optional upstream identifier to persist on the created client record.

string | null

Optional SSN convenience field. Accepted forms are 123456789 or 123-45-6789; accepted values are normalized to 123-45-6789 before creating the active client identifier.

address
object | null

Optional inline address object. When present, the facade creates a PRIMARY client address using the Clarifi client-address validation rules.

paymentInstrument

Optional embedded first payment instrument for the new client. This object reuses the standalone payment-instrument create field names, does not accept clientId, and is rejected when the effective client would be inactive.

integer
Defaults to 1

Office identifier used for client ownership and access checks. Defaults to 1 when omitted.

boolean
Defaults to true

Whether the client should be created active immediately. Defaults to true when omitted.

string

Activation date using the effective dateFormat and locale. The facade defaults it to the current tenant business date when the effective active value is true.

string

Submission date using the effective dateFormat and locale. Defaults to the current tenant business date when omitted.

string

Date format applied to date-only request fields when they are supplied.

string

Locale applied to date parsing when date fields are supplied.

datatables
array of objects

Optional datatable payload forwarded to the delegated core client-create flow.

datatables
Headers
string
required
Defaults to default

Tenant routing identifier for Embarc.

Response

Updated about 1 month ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago

Did this page help you?