Standalone Vertex Validator
Everything you need to integrate the standalone validation service right away.
Standalone Vertex Validator uses the dedicated Vertex Validator API Requests to automate business tax identification number validation during your checkout process, but outside of tax determination. The service supports two validation endpoints:
- Real-time validation—Validate a single tax number per request and return an immediate response.
- Bulk validation—Validate high volumes of tax numbers in a single request.
The service provides real-time business-to-business (B2B) validation that integrates with business workflows and supports scenarios in which tax treatment differs from that of business-to-consumer (B2C) transactions.
Real-time validation
Real-time validation enables you to integrate business tax number validation into your sales journey or onboarding management. Use this endpoint for the following scenarios:
- ERP integration—Integrate validation at the point in your ERP process where it adds the most business value.
- Checkout—Perform validation before tax determination to reduce latency.
- Customer or vendor onboarding—Perform validation as part of your existing onboarding processes.
For more information, see Real-Time Validation.
Bulk validation
Bulk validation enables high-volume validation of business tax numbers. Use this endpoint to clean up existing validation data or periodically revalidate data to help maintain accuracy.
For more information, see Bulk Validation.
Considerations
Note the following considerations:
- The service doesn't support single sign-on (SSO).
- You can't block countries or regions.
- You can't validate multiple tax numbers in a single request; send a single tax number per request.
Prerequisites
Ensure that you meet the following requirements:
- You must use Vertex O Series Cloud with the O Series Cloud REST API.
- You must have an active account and a valid license for Vertex O Series Cloud and Vertex Validator.
- You must complete the onboarding process.
- You need to review the Validate Tax Number and Bulk Validate Tax Number requests.
API authentication
Use one of the following credentials:
- Validator Test—For the sandbox environment.
- Validator—For the production environment.
Obtain a credential as described in Authentication and Access. Include the credential in your standard O Series Cloud authentication setup. For more information, see Authenticate O Series Cloud.
API integration
Use the following base URLs:
| Environment | URL |
|---|---|
| Sandbox | https://oseries-plus-api.sandbox.marketplace.taxamo.com |
| Production | https://oseries-plus-api.marketplace.taxamo.com |
You can use the Validate Tax Number and Bulk Validate Tax Number requests to integrate the service.
Download OAS files
Download the Open API Specification (OAS) files in JSON format from the O Series Cloud REST API Reference.
API-based settings
Configure the following settings in the Validate Tax Number request:
| Setting | Description |
|---|---|
cache_expiry_timeout_days | The service can cache validation results. Control how long the service stores and reuses validation results. Set to 30 to cache results for 30 days. Set to 0 to disable caching and validate each request using real-time validation. |
on_error | Controls how the service responds to errors when the external service is unresponsive or returns an error. Set to proceed, which marks the tax number as invalid. Set to syntax_check, which validates only the format. If the format is valid, the service marks the tax number as valid and returns: buyer_tax_number_validation_info: "tax-number-syntax-considered-valid-but-not-verified" |
Message processing
For more information, see Message Processing.
Examples
For more information, see Examples.