API Reference

List checks for a business-date window, or recall a single check by id

get
https://prod.api.nxapp.net/public/v1/checks

List mode requires scope checks:read. Supply exactly one of businessDate, businessDates, or businessDateStart+businessDateEnd; a window is required and may span at most 1 days (query day by day for longer spans). Recall mode (pass id) requires either checks:read or checks:write, and ignores the date window.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Recall a single check by id instead of listing.

string

A single business date, YYYY-MM-DD.

string

Comma-separated business dates, e.g. 2026-09-01,2026-09-03. Need not be contiguous.

string

Inclusive start of a business-date range. Must be sent with businessDateEnd. Max 1 days.

string

Inclusive end of a business-date range. Must be sent with businessDateStart. Max 1 days.

integer
≤ 500
Defaults to 100

Page size (default 100, max 500).

string

Opaque pagination cursor from a prior response's meta.cursor.

Responses

Updated 14 days ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 14 days ago

Did this page help you?