List background checks

get

https://api.wingspan.app/v3/compliance/background-checks

Returns a paginated list of BackgroundChecks visible to the calling account's org branch — every check it ordered, plus every check run against it as a payee. Filterable by status, payeeAccountId and externalId, and narrowable with filter[accountIds][anyOf][].

A payee sees a redacted resource: the vendor's report URLs and the vendor status detail are withheld, matching what the V1 API has always given them.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

object

Pagination query parameters. Serializes as page[size] and page[token].

filter

object

Filters use deep-object query parameters. Every filter is IN-style: filter[field][anyOf][]=value, repeated to match any of several values. filter[field][eq]=value is the single-value spelling of the same inclusion filter.

Headers

X-Wingspan-Account

string

^(?:[A-Za-z0-9_.]{22}|[a-f0-9]{24})$

Select the Account for an Account-scoped operation. A direct ServiceAccount API key MUST supply this header, and the target must be within the ServiceAccount owner's or Authorization grant's Account boundary. A Person bearer may select an Account on which it has an active Stakeholder, and an Account session may select its bound Account (or a descendant only when the session explicitly includes descendants).

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200Paginated list of background checks

401Unauthenticated

403Forbidden