Skip to main content
GET
Get one operator link with its evidence

Authorizations

X-API-Key
string
header
required

Path Parameters

business_ref
string
required
individual_ref
string
required

Response

Response

One operator link with the evidence behind it.

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
evidence
OperatorLinkEvidenceResponse (v1) · object
required

The evaluation a credential minted now would assert, which can be older than the newest when a later session only lacked a check.

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.