Tax File Number Validation
The Tax File Number (TFN) validation endpoint provides comprehensive validation of Australian Tax File Numbers according to Australian Taxation Office (ATO) standards. This service validates the structure and format of TFNs, ensuring they meet the required mathematical validation rules and checksums. The validation includes checking for valid number lengths and performing weighted sum calculations to verify the number's authenticity.
TFN validation helps ensure data quality by confirming the structural validity of tax file numbers before they are used in financial and taxation systems. The service supports both 8 and 9 digit TFN formats, making it suitable for validating both older and newer TFN formats.
IMPORTANT
This validation performs ONLY mathematical pattern conformity checks against ATO-defined formats and does not verify the actual registration or status of the TFN with the Australian Taxation Office. A successful validation only confirms that the TFN follows the correct structure and passes the checksum algorithm.
A "valid" result should NOT be interpreted as confirmation that the TFN is currently registered, active, or assigned to any individual or entity. For systems requiring guaranteed TFN validity, additional verification steps through official ATO channels must be implemented separately.
Model
Specific structure of the data that represents the entity within the API. It defines the attributes and their data types associated with the entity.
It's important to note that you'll need to retrieve the complete identifier for an entity each time you require its complete model. This can be achieved by utilizing the find endpoint to locate the entity and then using the retrieved identifier to call the retrieve endpoint for complete model.
- Name
number- Type
- string
- Name
isValid- Type
- boolean
Validate
This endpoint analyzes a Tax File Number to verify its validity according to ATO standards. It performs checks including:
- Valid length (8 or 9 digits)
- Correct weighted sum calculation
- Proper checksum validation
- Structural compliance with TFN format rules
Mandatory headers
- Name
x-api-key- Type
- string
- Description
- A valid API key obtained through active subscription must be included in the header in order for the endpoint to work.
Required parameters
- Name
number- Type
- string
- Description
- The Tax File Number to validate.
Request
curl "https://api.vigil.sh/validate/tax-file-number/?number=123456782" \
-H 'x-api-key: {api-key}'
Response
{
"result": {
"number": "123456782",
"isValid": true
}
}