Get the response of batch of tax registration numbers

GET

trn

validate

batch

{batchId}

curl --request GET \
  --url https://rest.taxes.provider.com/api/v1/trn/validate/batch/{batchId} \
  --header 'Authorization: Bearer <token>'

{
  "batchId": "qwerty12345",
  "batchName": "x-trn-batch",
  "status": "COMPLETED",
  "limit": 100,
  "offset": 0,
  "completionPercentage": 100,
  "trns": [
    {
      "trn": 40303265045,
      "trnStatus": "VALID",
      "country": {
        "name": "France",
        "code": "FR"
      }
    },
    {
      "trn": 50303265045,
      "trnStatus": "VALID",
      "country": {
        "name": "The united kingdom",
        "code": "UK"
      }
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Path Parameters

batchId

string

required

The unique batch request identifier.

Query Parameters

offset

integer

default:0

required

The starting index of records to be returned.

limit

integer

default:100

required

The limit number of records to be returned.

Response

200

application/json

Response of the batch of tax registration numbers validation.

Contains the required properties for batch of tax registration numbers validation response

batchId

string

required

Id of the batch request.

status

enum<string>

required

This field indicates current status of the request at server side.

Available options:

COMPLETED,

FAILED,

RUNNING,

CANCELED

limit

integer

required

Use for the pagination for batch request, limit indicates the maximum number of records to be returned in the response.

offset

integer

required

Use for the pagination for batch request, offset indicates the starting point of records to be returned in the response.

trns

object[]

required

List of tax registration numbers

Contains the required properties for tax registration number validation response

trns.trn

string

required

Tax registration number

trns.country

object

required

Defines the required properties to hold information about Country

Example:

{ "code": "code", "name": "name" }

trns.requestId

string

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

trns.name

string

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

trns.address

string

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

trns.trnStatus

enum<string>

Indicates status of the tax registration number.

Available options:

VALID,

INVALID,

UNKNOWN

trns.isBusiness

boolean

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

trns.isRegistered

boolean

Indicates that tax registration number is registered or not

trns.businessStatus

enum<string>

Indicate the status of the business of tax registration number.

Available options:

ACTIVE,

INACTIVE,

UNKNOWN

trns.validationDataSource

string

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

trns.externalId

string

The externalId passed in the request

trns.message

string

Any message about tax registration number validation request

batchName

string

Name of the batch request.

completionPercentage

integer

Percentage of batch request processing.

externalId

string

The externalId passed in request.

Get the response of tax registration number validate request Delete the request of batch of tax registration numbers validation

curl --request GET \
  --url https://rest.taxes.provider.com/api/v1/trn/validate/batch/{batchId} \
  --header 'Authorization: Bearer <token>'

{
  "batchId": "qwerty12345",
  "batchName": "x-trn-batch",
  "status": "COMPLETED",
  "limit": 100,
  "offset": 0,
  "completionPercentage": 100,
  "trns": [
    {
      "trn": 40303265045,
      "trnStatus": "VALID",
      "country": {
        "name": "France",
        "code": "FR"
      }
    },
    {
      "trn": 50303265045,
      "trnStatus": "VALID",
      "country": {
        "name": "The united kingdom",
        "code": "UK"
      }
    }
  ]
}

API Reference

Authorizations

Path Parameters

Query Parameters

Response