API-based Settings

This topic describes the API-based settings that are available for Vertex Validator.

Integrated Vertex Validator users can use the API settings. Standalone users can send the settings as part of the Validate Tax Number request.

Integrated

Integrated users can create settings for the Marketplaces and Sellers.

Marketplace Settings

Some settings can be made for the Marketplace as described in the Marketplace Settings - Vertex Validator topic.

Seller Settings

Some settings can be made for the Marketplace as described in the Seller Settings - Vertex Validator topic.

Standalone

The following settings are available and can be set in the Validate Tax Number request's query parameters:

SettingDescription
cache_expiry_timeout_daysValidation results can be cached. This setting controls how recent the cached result that is returned is. For example, if it is set to 0, the service will validate the ID against the authority's database in real-time. If it is set to 30, the service will use results cached over the last 30 days.
on_errorControls how the service behaves when the external service returns an error due to unavailability or other reasons. If you specify proceed, the Tax ID will be marked as invalid. If you specify syntax_check, the syntax is checked, the ID is marked as valid (if correct) and the following is returned in the API response: buyer-tax_number-validation-info: "tax-number-syntax-considered-valid-but-not-verified".