Skip to main content
GET
Get verification linkage
Requires scope: manage:parties — see Required scopes. Returns the party’s verification linkage: the linkage status plus the durable ivCaseReference you can quote to support when investigating a stuck verification.
This endpoint reports the plumbing, not the verdict. For the actual KYC/KYB outcome, read kycStatus/kybStatus from Get a party.
ivCaseReference is populated once the platform returns a reference and is never cleared afterwards — including on FAILED after a decline. Read the field directly rather than inferring it from status. This always returns 200 for an existing party, and reflects party-level linkage only — never your company’s tenant provisioning state.

Authorizations

Headers

x-tenant-id
string<uuid>

Which tenant the request is scoped to, among those your token grants. Omit it when the token grants exactly one tenant; it is required when the token grants more than one. A supplied value must exactly match a tenant the token grants.

Absent when required, blank, malformed, or naming a tenant the token does not grant — each gets the same generic 403 forbidden, which reveals neither whether a tenant exists nor which ones you may use. Send the header once: a repeated header is rejected the same way.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

Path Parameters

partyId
string<uuid>
required

Unique party identifier

Response

The party's verification linkage

success
boolean

Indicates whether the request was successful

result
object

A party's identity-verification linkage: the current linkage status plus the durable case reference. ivCaseReference is populated once the platform has returned a reference and is never cleared afterwards — including on FAILED after a declined verdict. Read it directly rather than inferring it from status.