Skip to main content

IntegrationVatValidationRecordDTO

Validation result for a single submitted VAT record.

vatIdstringrequired

VAT identifier from the submitted record.

statusResolveStatusrequired

Final resolve status for the VAT identifier.

Possible values: [Valid, Invalid, Unavailable]

flagsIntegrationVatValidationFlag[]nullable

Additional flags that explain how the record was evaluated.

Possible values: [VatSyntaxInvalid, FullyVerified, HasInvalidFields, DeQualifiedVerification, DeQualifiedVerificationNotEligible, MissingRequiredData, NonEligibleCountry]

companyName objectnullable

Company name comparison result.

valuestringnullable

Original value supplied for the field.

matchStatusMatchStatusnullable

Comparison result between the supplied value and the authoritative value.

Possible values: [Match, NoMatch, NotQueried, NotReturned]

correctionValuestringnullable

Corrected value returned by the validator, when available.

city objectnullable

City comparison result.

valuestringnullable

Original value supplied for the field.

matchStatusMatchStatusnullable

Comparison result between the supplied value and the authoritative value.

Possible values: [Match, NoMatch, NotQueried, NotReturned]

correctionValuestringnullable

Corrected value returned by the validator, when available.

zip objectnullable

Postal code comparison result.

valuestringnullable

Original value supplied for the field.

matchStatusMatchStatusnullable

Comparison result between the supplied value and the authoritative value.

Possible values: [Match, NoMatch, NotQueried, NotReturned]

correctionValuestringnullable

Corrected value returned by the validator, when available.

street objectnullable

Street comparison result.

valuestringnullable

Original value supplied for the field.

matchStatusMatchStatusnullable

Comparison result between the supplied value and the authoritative value.

Possible values: [Match, NoMatch, NotQueried, NotReturned]

correctionValuestringnullable

Corrected value returned by the validator, when available.

customFields object[]nullable

Custom input fields preserved from the request.

  • Array [
  • columnNamestringnullable

    Name of the custom column from the submitted record.

    valuestringnullable

    Original value supplied for the custom column.

  • ]
  • included objectnullable

    Additional requested fields keyed by include value.

    property name*stringnullable
    IntegrationVatValidationRecordDTO
    {
    "vatId": "string",
    "status": "Valid",
    "flags": [
    "VatSyntaxInvalid"
    ],
    "companyName": {
    "value": "string",
    "matchStatus": "Match",
    "correctionValue": "string"
    },
    "city": {
    "value": "string",
    "matchStatus": "Match",
    "correctionValue": "string"
    },
    "zip": {
    "value": "string",
    "matchStatus": "Match",
    "correctionValue": "string"
    },
    "street": {
    "value": "string",
    "matchStatus": "Match",
    "correctionValue": "string"
    },
    "customFields": [
    {
    "columnName": "string",
    "value": "string"
    }
    ],
    "included": {}
    }