API Reference

Get a background check

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

Retrieve a single BackgroundCheck by ID. Readable by every party to it — the payer that ordered it, the payee it was run against, and the fulfilling vendor — and REDACTED per party:

The payer sees the vendor status detail and both hosted report URLs. The payee sees the application URL and the status, but never a report URL or the status detail. The vendor sees its own package identifier.

Pass/fail detail is reviewed by the payer through the report; this API does not adjudicate.

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

Unique identifier of a BackgroundCheck.

Headers
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

Updated 4 months 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
application/problem+json

Updated 4 months ago

Did this page help you?