Skip to main content
GET
List your organization's operator links

Authorizations

X-API-Key
string
header
required

Query Parameters

limit
integer
default:10

Maximum number of records to return in a single page. Must be between 1 and 1000.

Required range: 1 <= x <= 1000
offset
integer | null

Number of records to skip from the beginning. Use 0 for the first page. Cannot be used with cursor.

Required range: x >= 0
cursor
string | null

Opaque pagination cursor token that identifies the position in the result set. Use the cursor from the previous response to get the next page. Cannot be used with offset.

sort
enum<string> | null

created_at (when the link was recorded) or name (the person's name, then the business's, ignoring case; a person with no current name sorts last either way); ties break on created_at, then the link's id. Defaults to created_at desc. What the operator-links list sorts by.

Available options:
created_at,
name
sort_direction
enum<string> | null

asc or desc, for every key of the sort. Defaults to the field's own: created_at desc, name asc.

Available options:
asc,
desc
status
enum<string>[] | null

Only links in any of these statuses. Repeatable.

Your organization's status for the link between an individual and a business they operate.

VERIFIED is earned by the full evidence recipe (TIN provided + IRS-matched + KYB-verified) on one of your own sessions, or decided by your organization; UNDER_REVIEW is every automatic shortfall; REJECTED is your organization's refusal, which stands until you decide again. Another organization's evidence or decision never changes it.

Available options:
VERIFIED,
UNDER_REVIEW,
REJECTED
shortfall
enum<string>[] | null

Only links whose newest evaluation fell short on any of these. Repeatable.

Which leg of the operator-link evidence recipe a covering evaluation failed.

Reviewer-facing: a session whose evaluation reports any shortfall records an UNDER_REVIEW link, and these name what a reviewer would be overriding by verifying it anyway. An evaluation that reports none earns VERIFIED on its own.

Available options:
TIN_NOT_PROVIDED,
TIN_NOT_MATCHED,
KYB_NOT_VERIFIED
search
string | null

A prn_ or bus_ reference, matched exactly, or free text matched against the person's and the business's names.

Maximum string length: 200

Response

Paginated operator links in the requested order, scoped to the calling organization.

status
enum<string>
required

Your organization's current status for the link.

Available options:
VERIFIED,
UNDER_REVIEW,
REJECTED
created_at
string<date-time>
required

When the link was first recorded.

individual_ref
string
required

Pairwise reference to the linked individual.

business_ref
string
required

Pairwise reference to the linked business.

The linked business's current legal name.

shortfalls
enum<string>[]
required

What your newest evaluation of the pair fell short on, in recipe order: the reason a link is under review or flagged. Empty when it met the recipe.

Which leg of the operator-link evidence recipe a covering evaluation failed.

Reviewer-facing: a session whose evaluation reports any shortfall records an UNDER_REVIEW link, and these name what a reviewer would be overriding by verifying it anyway. An evaluation that reports none earns VERIFIED on its own.

Available options:
TIN_NOT_PROVIDED,
TIN_NOT_MATCHED,
KYB_NOT_VERIFIED
review_flagged_at
string<date-time> | null

When a later evaluation flagged this verified link for review; null when it never was.

decided_at
string<date-time> | null

When your organization last verified or rejected the link by hand; null while only the evidence has decided it.

decided_by
ActedBy (v1) · object | null

Who made that decision, as stamped when they made it; null when no one has.

decision_reason
string | null

The reason recorded with that decision, if any.

source_verification_id
string<uuid> | null

The verification that established the link; null when that verification no longer exists. A direct verification reads at GET /issuance/identities/verifications/{verification_id}; a hosted one is an onboarding session and reads at GET /onboarding/sessions/{session_id}.

individual_display_name
string | null

The individual's verified name from your organization's current verification; null when it has been superseded and not yet replaced.