POST
/
trn
/
validate
curl --request POST \
  --url https://rest.taxes.provider.com/api/v1/trn/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "trn": 40303265045,
  "country": {
    "code": "FR"
  }
}'
{
  "requestId": "qwerty12345",
  "trn": 40303265045,
  "country": {
    "name": "France",
    "code": "FR"
  },
  "trnStatus": "VALID"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Contains the required properties for tax registration number validation request

trn
string
required

Tax registration number

country
object
required

Defines the required properties to hold information about Country

Example:
{ "code": "code", "name": "name" }
trnType
enum<string>

Indicates the type of the tax registration number.

Available options:
INDIVIDUAL,
BUSINESS,
GST,
VAT,
ENTITY,
UNKNOWN
name
string

Name of the tag registration number owner

validOn
string

Validate tax registration number on given date

requesterTrn
string

Tax registration number of the entity or person who is requesting validation

taxOfficeCode
string

Code of the tax office, some country need it to validate tax registration number

externalId
string

Way to relate the request and response, if passed then the same value should be returned in response

Response

200
application/json
Request to validate the tax registration number submitted successfully.

Contains the required properties for tax registration number validation response

trn
string
required

Tax registration number

country
object
required

Defines the required properties to hold information about Country

Example:
{ "code": "code", "name": "name" }
requestId
string

Unique id of the request, this is to refer later to fetch the response.

name
string

Name of the entity(may be an individual or a business company) who owns the tax registration number

address
string

Address of the entity(may be an individual or a business company) who owns the tax registration number

trnStatus
enum<string>

Indicates status of the tax registration number.

Available options:
VALID,
INVALID,
UNKNOWN
isBusiness
boolean

Indicates that tax registration number belong to a business entity or not.

isRegistered
boolean

Indicates that tax registration number is registered or not

businessStatus
enum<string>

Indicate the status of the business of tax registration number.

Available options:
ACTIVE,
INACTIVE,
UNKNOWN
validationDataSource
string

Indicates name of the source of tax registration number validation (like database, vies)

externalId
string

The externalId passed in the request

message
string

Any message about tax registration number validation request