BusinessVerificationRulePatchProperties interface

Patch body for a businessVerification rule. Settable while evaluationState is pending or actionRequired. externalId lets the customer disambiguate an ambiguous verification match (e.g. via DUNS); supplementalDocuments carries references to documents uploaded via the assessment-scoped upload-token action.

Extends

Properties

externalId

Optional external-registry identifier (e.g. DUNS) used to disambiguate ambiguous verification matches.

kind

The discriminator possible values: eduQualification, businessVerification

supplementalDocuments

References to supplemental documents (businessVerification rules only; only settable while evaluationState is pending or actionRequired).

Property Details

externalId

Optional external-registry identifier (e.g. DUNS) used to disambiguate ambiguous verification matches.

externalId?: ExternalId

Property Value

kind

The discriminator possible values: eduQualification, businessVerification

kind: "businessVerification"

Property Value

"businessVerification"

supplementalDocuments

References to supplemental documents (businessVerification rules only; only settable while evaluationState is pending or actionRequired).

supplementalDocuments?: string[]

Property Value

string[]