Counterparties

Page through linked history including truthful expired evidence metadata

Required API key scope: results:read.

get/counterparties/{id}/history

Request

Base URL
https://www.sanctionskit.com/api/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/sanctionskit/apis/sanctionskit-api/docs/counterparties/:id/history/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring uuid required

Opaque resource identifier owned by the authenticated organization.

Query parameters

limitinteger

Maximum number of items to return. A response may contain fewer items; use its next cursor to decide whether another page exists.

cursorstring uuid

Pass nextCursor from the previous page; omit for the first page. Continue until the response cursor is null. Keep the same filters between pages.

kind'screenings' | 'cases' | 'monitors'

Select which linked resource history to return. The value determines the item response shape.

Response

Successful response. JSON object with the required data key. All properties marked required are present, including keys whose value may be null. Unmarked properties can be omitted; clients should tolerate additional response properties.

Changes

No recorded changes to this operation across all 1 revision of this API.