Create a Counterparty

post

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

Create a counterparty with contact metadata and an inline address. Business name must be unique; nonblank external ID and tax ID must also be unique, while null or blank external ID and tax ID values may be reused.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Create-counterparty payload. The current implementation requires address on create.

Request payload used to create a counterparty.

businessName

string

required

Counterparty business name. The service requires a nonblank value and enforces uniqueness after trimming, whitespace normalization, and case folding.

externalId

string

External system identifier for the counterparty. Nonblank values must be unique after trimming and case folding; null or blank values may be reused.

parentCounterpartyId

integer

Parent counterparty identifier when the counterparty participates in a hierarchy.

counterpartyType

string

enum

required

Supported counterparty category. MERCHANT is the only type treated as the lender/merchant on a loan link and is the only type that can carry payout-delay and tenant-fee fields on the link. INVESTOR and VENDOR are the other supported counterparty categories.

Allowed:

taxId

string

Tax identifier. Nonblank values must be unique after trimming and case folding; null or blank values may be reused.

officeId

integer

Defaults to the authenticated user's office. An explicit office must be within the user's hierarchy and is immutable after creation.

website

uri

length ≤ 2048

Absolute HTTP(S) URL.

contacts

array of objects

Optional explicit contacts created atomically. No contact is created when omitted.

contacts

contactName

string

Primary contact name.

contactEmail

string

Primary contact email address.

contactPhone

string

Primary contact phone number.

secondaryContactName

string

Secondary or backup contact name.

secondaryContactEmail

string

Secondary or backup contact email address.

secondaryContactPhone

string

Secondary or backup contact phone number.

isActive

boolean

Active flag for the new counterparty. Defaults to true when omitted.

address

object

required

Inline address payload used by counterparty create and update requests. The create flow requires this object, and the underlying address record requires addressLine1, city, zip, and ISO-2 country.

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

200Counterparty created successfully.