Skip to main content
POST
Create a lien

Authorizations

x-api-key
string
header
required

Org-issued integration API key (service account credential). The plaintext secret is shown once at creation.

Headers

X-Idempotency-Key
string
required

Stable caller-chosen key (max 200 chars) making the mutation safely retryable.

Maximum string length: 200

Path Parameters

caseId
string
required

Case id

Body

application/json
holderName
string
required
Required string length: 1 - 500
amountCents
integer
required
Required range: x <= 100000000000
startDate
string
required
holderContactId
string
Required string length: 1 - 200
interestRate
number
Required range: 0 <= x <= 1000
interestType
enum<string>
Available options:
Simple,
Compound
accrualFrequency
enum<string>
Available options:
Monthly,
Quarterly,
Annually
reductionCents
integer
Required range: 0 <= x <= 100000000000
reductionStatus
enum<string>
Available options:
Pending,
Approved,
Rejected
notes
string
Maximum string length: 5000

Response

{ success: true, lien }

success
boolean
required
{key}
any