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, individual-only lookup-backed borrower metadata, an optional inline primary address, and an optional embedded first payment instrument.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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, optional lookup-backed fields resolve against the same code-value lists used by the standard client template, 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.

legalFormType

string

enum

required

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

Allowed:

firstname

string

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

middlename

string

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

lastname

string

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

businessName

string

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

emailAddress

string

required

Primary email address for the client. It must be unique across clients and non-deleted app users.

mobileNo

string

required

Primary phone number. The facade passes this value through unchanged to the core client phone field.

clientType

string | null

Optional individual-only client-type label such as Military or Tribal. The facade resolves it case-insensitively against the ClientType code-value list and omits the internal ID when no matching option exists.

gender

string | null

enum

Optional individual-only public gender value. 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:

riskRating

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:

dateOfBirth

string | null

Optional date-only value using the effective dateFormat and locale. Explicit null is treated as absent before delegation to core.

externalId

string

Optional upstream identifier to persist on the created client record.

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.

officeId

integer

Defaults to 1

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

active

boolean

Defaults to true

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

activationDate

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.

submittedOnDate

string

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

dateFormat

string

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

locale

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

x-embarc-tenant-id

string

required

Defaults to default

Tenant routing identifier for Embarc.

Response

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Client created successfully.