BusinessVerificationRuleProperties interface

Properties of a business verification rule. Verifies the billing account's business identity.

Sold-to fields (soldTo, registrationNumber, taxIds) reflect the billing account's information on file and cannot be supplied by end users.

Extends

Properties

externalId

Optional external-registry identifier (e.g. DUNS) used to disambiguate verification matches. Settable on PATCH while evaluationState is pending or actionRequired.

kind

The discriminator possible values: eduQualification, businessVerification

registrationNumber

Registration number context (allowed types and registration id). Populated from the billing account at the time the rule is created. Server-managed.

soldTo

Sold-to identity used for business verification. Populated from the billing account at the time the rule is created. Server-managed.

supplementalDocuments

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

taxIds

Tax ids associated with the sold-to identity. Populated from the billing account at the time the rule is created. Server-managed.

Inherited Properties

error

Error information when evaluationState is failed or actionRequired. Server-managed.

evaluationState

The evaluation state of the rule. Server-managed.

provisioningState

The provisioning state of the resource

Property Details

externalId

Optional external-registry identifier (e.g. DUNS) used to disambiguate verification matches. Settable on PATCH while evaluationState is pending or actionRequired.

externalId?: ExternalId

Property Value

kind

The discriminator possible values: eduQualification, businessVerification

kind: "businessVerification"

Property Value

"businessVerification"

registrationNumber

Registration number context (allowed types and registration id). Populated from the billing account at the time the rule is created. Server-managed.

registrationNumber?: RegistrationNumber

Property Value

soldTo

Sold-to identity used for business verification. Populated from the billing account at the time the rule is created. Server-managed.

soldTo?: SoldTo

Property Value

supplementalDocuments

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

supplementalDocuments?: string[]

Property Value

string[]

taxIds

Tax ids associated with the sold-to identity. Populated from the billing account at the time the rule is created. Server-managed.

taxIds?: TaxId[]

Property Value

TaxId[]

Inherited Property Details

error

Error information when evaluationState is failed or actionRequired. Server-managed.

error?: ErrorDetail

Property Value

Inherited From RuleProperties.error

evaluationState

The evaluation state of the rule. Server-managed.

evaluationState?: string

Property Value

string

Inherited From RuleProperties.evaluationState

provisioningState

The provisioning state of the resource

provisioningState?: string

Property Value

string

Inherited From RuleProperties.provisioningState