Marketplace Settings - Vertex Validator

Suggest Edits

Vertex Validator is the name of the component that helps you to validate Tax IDs that are used for identifying Business-to-Business (B2B) transactions.

Marketplace

You can set tax number validation settings for an entire marketplace or for regions and countries.

You can set the following details for your marketplace:

Field	Description
`validation_request_timeout_ms`	The number of milliseconds before a request is timed out.
`cache_expiry_timeout_days`	This value specifies the amount time a Tax ID’s validation result is stored in the cache before the list is refreshed. For example, if an ID is validated in the last 24 hours and this setting is set to 1, when the ID is checked again, the service returns the stored result. The lower that you set this value, the more it can impact the performance of the service.

For example:

{
     "settings": [
          {
               "value": {
                    "tax_number_validation": {
                         "validation_request_timeout_ms": 10000,
                         "cache_expiry_timeout_days": 30
                    },
                    "block_transactions_before": "1989-01-01",
                    "timezone": "Etc/GMT"
               },
               "effective_from": "1990-01-10"
          }
     ],

Region

The following settings are available for regions:

Field	Description
`regions.<New_Key>.taxation.validation_request_timeout_ms`	The number of milliseconds before a request is timed out for this region.
`regions.<New_Key>.taxation.cache_expiry_timeout_days`	The number of days that a validated VAT number is stored in the cache for this region.
`regions.<New_Key>.taxation.validation_rule`	Determines how the tax number validation should be handled: `valid-when-syntax-ok`: A tax number is validated if it passes the syntax check. `valid-when-external-service-ok`: If the number passes the syntax check, an external validation service (for example VIES in the EU) will be used to determine tax number validity. `ignored`: tax number will be ignored - transaction will be processed as if the tax number was not provided at all. Defaults to valid-when-external-service-ok.

Field

Description

regions.<New_Key>.taxation.validation_request_timeout_ms

The number of milliseconds before a request is timed out for this region.

regions.<New_Key>.taxation.cache_expiry_timeout_days

The number of days that a validated VAT number is stored in the cache for this region.

regions.<New_Key>.taxation.validation_rule

Determines how the tax number validation should be handled:

valid-when-syntax-ok: A tax number is validated if it passes the syntax check.
valid-when-external-service-ok: If the number passes the syntax check, an external validation service (for example VIES in the EU) will be used to determine tax number validity.
ignored: tax number will be ignored - transaction will be processed as if the tax number was not provided at all.

Defaults to valid-when-external-service-ok.

For example:

{
     "settings": [
          {
               "value": {
                    "tax_number_validation": {
                         "validation_request_timeout_ms": 5000,
                         "cache_expiry_timeout_days": 30
                    },
                    "regions": {
                         "EU": {
                              "tax_number_validation": {
                                   "validation_request_timeout_ms": 10000,
                                   "cache_expiry_timeout_days": 60,
                                   "validation_rule": "valid-when-syntax-ok"
                              }
                         }
                    },
                    "block_transactions_before": "1989-01-01",
                    "timezone": "Etc/GMT"
               },
               "effective_from": "1990-01-10"
          }

Updated 3 months ago