API documentation

Import and link customer or vendor records

Preserve structured identities and explicit business references before screening or monitoring a portfolio.

Updated

Link
External reference

Names never automatically merge identities.

Intake
Up to 100 rows

Choose create, link, or create-or-link explicitly.

History
Cursor pagination

Expired evidence remains clearly labeled.

Choose how imported rows should be linked

Dashboard imports support screening only, creating saved records, linking existing records, or creating or linking by an explicit external reference. Names do not merge records automatically. Preview each row and resolve conflicting references before starting work.

POST /api/v1/counterparties/intake is a human reviewer operation, not an API-key endpoint. Send action as create_only, link_existing, or create_or_link and up to 100 rows containing externalId, subject, optional label and relationship, and optional expectedRevision. The idempotent receipt contains its ID and each externalId, counterpartyId, and revision. Conflicting identities and archived or changed saved records are rejected.

Keep useful identity details

Quick screening, counterparties, monitoring and bulk intake accept the supported subject fields: name, aliases, subject type, country, partial birth date and typed identifiers with optional issuers. Do not invent a day for an uncertain date. Vessel IMO numbers, organization LEIs and aircraft registrations have different formats and comparison rules.

Updating a saved subject does not rewrite historical evidence. Linked monitors pause so their saved request can be reconciled. Match the saved subject and current revision when linking future screens; inspect the original retained request when reviewing an earlier result.

Page through the full linked history

GET /api/v1/counterparties/{id}/history accepts kind=screenings, cases, or monitors, limit from 1 to 100, and a cursor returned by the preceding page. The response contains items, total and nextCursor. It accepts results:read and stays within the organization and environment.

Expired screening rows retain an explicit expired state without reconstructing deleted subject inputs or evidence. A saved relationship, an active monitor, and a completed screening are distinct records; none alone establishes current clearance.

KEEP BUILDING

Where to go next