IntegrationVatValidationResponseDTO
Current state and result payload for a VAT validation operation.
Unique identifier of the validation operation.
Current lifecycle state of the validation operation.
Possible values: [Running, Completed, Failed]
Timestamp when the validation operation was accepted.
Timestamp after which the validation result may no longer be retrievable.
Timestamp when the operation entered a terminal state.
Identifier of the generated snapshot, when one was created.
pdfDocument objectnullable
Generated PDF report metadata, when PDF output was requested.
Original file name of the generated PDF report.
Download URL for the generated PDF report. Present only when returnAsUrl was enabled.
Base64-encoded PDF document. Present only when returnAsBase64 was enabled.
records object[]nullable
Per-record validation results, when available. Omitted while the run is still in progress or when the run failed before producing results.
VAT identifier from the submitted record.
Final resolve status for the VAT identifier.
Possible values: [Valid, Invalid, Unavailable]
Additional flags that explain how the record was evaluated.
Possible values: [VatSyntaxInvalid, FullyVerified, HasInvalidFields, DeQualifiedVerification, DeQualifiedVerificationNotEligible, MissingRequiredData, NonEligibleCountry]
companyName objectnullable
Company name comparison result.
Original value supplied for the field.
Comparison result between the supplied value and the authoritative value.
Possible values: [Match, NoMatch, NotQueried, NotReturned]
Corrected value returned by the validator, when available.
city objectnullable
City comparison result.
Original value supplied for the field.
Comparison result between the supplied value and the authoritative value.
Possible values: [Match, NoMatch, NotQueried, NotReturned]
Corrected value returned by the validator, when available.
zip objectnullable
Postal code comparison result.
Original value supplied for the field.
Comparison result between the supplied value and the authoritative value.
Possible values: [Match, NoMatch, NotQueried, NotReturned]
Corrected value returned by the validator, when available.
street objectnullable
Street comparison result.
Original value supplied for the field.
Comparison result between the supplied value and the authoritative value.
Possible values: [Match, NoMatch, NotQueried, NotReturned]
Corrected value returned by the validator, when available.
customFields object[]nullable
Custom input fields preserved from the request.
Name of the custom column from the submitted record.
Original value supplied for the custom column.
included objectnullable
Additional requested fields keyed by include value.
Failure detail when the validation operation ends with status Failed.
{
"operationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "Running",
"submittedAt": "2024-07-29T15:51:28.071Z",
"expiresAt": "2024-07-29T15:51:28.071Z",
"completedAt": "2024-07-29T15:51:28.071Z",
"snapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"pdfDocument": {
"fileName": "string",
"url": "string",
"base64": "string"
},
"records": [
{
"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": {}
}
],
"error": "string"
}