IntegrationVatLookupResponse

Response returned by the VAT lookup endpoint.

matchCountint32required

Number of VAT lookup results returned.

results object[]nullable

Verified VAT lookup results for the submitted company data, when matches are available.

Array [

vatIdstringrequired

VAT identifier found and checked for the submitted company data.

statusResolveStatusrequired

Final outcome for this VAT lookup result.

Possible values: [Valid, Invalid, Unavailable]

flagsVatResolveFlag[]nullable

Optional flags that add public context to this VAT lookup result.

Possible values: [VatSyntaxInvalid, Obfuscated]

resolvedData objectnullable

Normalized company and address data returned by VAT lookup, when available.

companyNamestringnullable

Normalized company name returned by VAT lookup.

streetstringnullable

Normalized street returned by VAT lookup.

citystringnullable

Normalized city returned by VAT lookup.

zipstringnullable

Normalized postal code returned by VAT lookup.

rawAddressstringnullable

Unparsed address string returned when the upstream source did not provide structured address fields.

similarityScoreint32required

Similarity score between submitted company data and the verified VAT result.

checkedAtdate-timerequired

Timestamp when this VAT ID was checked.

]

IntegrationVatLookupResponse

{
  "matchCount": 0,
  "results": [
    {
      "vatId": "string",
      "status": "Valid",
      "flags": [
        "VatSyntaxInvalid"
      ],
      "resolvedData": {
        "companyName": "string",
        "street": "string",
        "city": "string",
        "zip": "string",
        "rawAddress": "string"
      },
      "similarityScore": 0,
      "checkedAt": "2024-07-29T15:51:28.071Z"
    }
  ]
}