Skip to main content
POST
cURL
Required scope: liens:search Run a lien search with explicit jurisdiction and debtor scope. Required scope: liens:search. Adapter resolves provider business/person context; no filing or perfection action. Once account cancellation is submitted, processing and usage deductions stop immediately. Reject new operational commands with 409 invalid_state; pending work is cancelled without another debit. Read-only reporting remains available until workspace deletion. This is a stage of an authorized Insights or Signal workflow. processing_context is required; unrelated, completed, unpaid, cancelled or unentitled contexts return 409 invalid_state. It creates no separate AMLOK charge. The orchestrator deduplicates equivalent stage work within the parent. Accepted commands have a durable request receipt. Full response replay lasts 24 hours; afterward the same key and target return 409 idempotency_result_expired without re-execution. Different payloads return 409 idempotency_conflict. Use GET /v1/request-receipts/lookup to find the original resource. The fingerprint includes the resolved target path and intended payload; a key used on another target is rejected rather than replayed onto it. Pre-execution validation or insufficient-credit rejection creates no accepted receipt. Product scope · Processing lifecycle · Errors

Authorizations

Authorization
string
header
required

Server-to-server API key bound to exactly one workspace, institution tenant and environment. No caller-supplied workspace override is accepted. Do not use in public browser code.

Headers

X-Request-ID
string

Optional caller correlation ID; the response includes AMLOK request_id.

Idempotency-Key
string
required

Reuse for retries of the same intended command and identical payload. Retention: 24 hours.

Body

application/json
processing_context
object
required

Parent must belong to this workspace. Same-subject stages need no association. Only person KYC may target a different subject: supply an active subject_association_id linking that person to the parent business. Insights requires an unfinished authorized root run; Signal requires an active paid period. Stage scope, consent, association and workload are checked on every attempt. The parent business remains the billing and workload subject. No standalone service or extra charge.

subject_id
string
required

Debtor context.

Minimum string length: 1
debtor_name
string
required

Exact legal search name.

Minimum string length: 1
debtor_type
enum<string>
required

Business or person.

Available options:
business,
person
search_type
enum<string>
required

Enabled name, identifier, VIN or serial search mode.

Available options:
name,
identifier,
vin,
serial
jurisdictions
string[]
required

Explicit requested search jurisdictions.

Minimum array length: 1
identifier
string

Required for identifier, VIN or serial search modes.

Minimum string length: 1

Response

Run a lien search with explicit jurisdiction and debtor scope. Accepted work is not yet complete.

data
lien_search · object
required

A search request with explicit debtor, jurisdiction and coverage. Population depends on source and tenant entitlement.

meta
object
required