List Businesses
List businesses Didit assembles from KYB sessions sharing the same vendor_data (free-form string, NOT a UUID), plus businesses created via the API. Paginated, ordered by last_session_at desc. This endpoint does not support filtering or search parameters — fetch pages and filter client-side.
Overview
Returns a paginated list of Business entities for the authenticated application.When to use it
- Sync your business table to an external BI or warehouse.
- Analyst queues — filter by
status=FLAGGEDto drive a review inbox. - Search by
display_name,legal_name,registration_number, orvendor_data.
Filters and pagination
Notes
vendor_datamay benullif the originating session or transaction did not provide one.- Cursor-based pagination — persist the
nextcursor between calls. - See the Business data model for every field.
Permissions
Role must grantlist:businesses.
Related
Authorizations
Query Parameters
Page size. Defaults to 50 when omitted. There is no enforced maximum, but keep pages small for latency.
x >= 1Zero-based offset of the first record to return. Prefer following the next URL from the previous page over computing this by hand.
x >= 0Response
Paginated list of businesses with status, session counts, and feature breakdown.
Number of matching rows — exact up to 100, capped at 100 beyond that for performance. Do not use it to detect the last page; rely on next being null instead.
Absolute URL of the next page, or null on the last page.
Absolute URL of the previous page, or null on the first page.