List persistent customer and vendor records
Required API key scope: results:read.
Request
- Base URLhttps://www.sanctionskit.com/api/v1
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
Maximum number of items to return. A response may contain fewer items; use its next cursor to decide whether another page exists.
Pass nextCursor from the previous page; omit for the first page. Continue until the response cursor is null. Keep the same filters between pages.
Case-insensitive substring search across counterparty label, subject name, external reference and tags.
Filter active or archived identities; omission includes both.
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.