IntegrationVatValidationRequestDTO

Request payload for starting a VAT validation run.

records object[]required

Records to validate. Must contain at least one record.

Possible values: >= 1

Array [

vatIdstringnullable

VAT identifier.

companyNamestringnullable

Company name used for VAT matching.

citystringnullable

City used for VAT matching.

zipstringnullable

Postal code used for VAT matching.

streetstringnullable

Street used for VAT matching.

]

options objectrequired

Execution options that control verification behavior and output artifacts.

checkTypeValidationCheckTyperequired

Determines whether the validation uses standard or qualified verification.

Possible values: [Qualified, Standard]

sendNotificationEmailbooleanrequired

When true, the validation workflow may send its configured notification email.

createSnapshotbooleanrequired

When true, the validation stores a snapshot of the completed result.

pdf objectrequired

Controls PDF generation and PDF delivery options for the validation run.

createbooleanrequired

When true, the validation generates a PDF report.

signbooleanrequired

When true, the generated PDF is signed before delivery.

sendByEmailbooleanrequired

When true, the PDF is emailed through the validation workflow.

returnAsBase64booleanrequired

When true, the PDF is also embedded as a base64 string in the API response.

returnAsUrlbooleanrequired

When true, the PDF download URL is included in the API response.

retryDurationRetryDurationrequired

Retry window applied to transient validation issues.

Possible values: [None, OneHour, TwoHours, FourHours, EightHours, TwentyFourHours]

ownVatIdstringnullable

Optional VAT ID to use as the caller's own VAT identifier during validation. When omitted, the user's default VAT ID is used.

transliteratebooleannullable

Optional override for transliteration during validation. When omitted, the user's configured default is used.

includestring[]nullable

Additional VAT resolve fields to include in each completed validation record. Supported values are: addressStreetName, addressHouseNumber.

IntegrationVatValidationRequestDTO

{
  "records": [
    {
      "vatId": "string",
      "companyName": "string",
      "city": "string",
      "zip": "string",
      "street": "string"
    }
  ],
  "options": {
    "checkType": "Qualified",
    "sendNotificationEmail": true,
    "createSnapshot": true,
    "pdf": {
      "create": true,
      "sign": true,
      "sendByEmail": true,
      "returnAsBase64": true,
      "returnAsUrl": true
    },
    "retryDuration": "None",
    "ownVatId": "string",
    "transliterate": true,
    "include": [
      "string"
    ]
  }
}