GET
/
trn
/
validate
/
batch
/
{batchId}
Get the response of batch of tax registration numbers
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

Response of the batch of tax registration numbers validation.

Contains the required properties for response of batch request. 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

​
batchName
string

Name of the batch request.

​
completionPercentage
integer

Percentage of batch request processing.

​
externalId
string

The externalId passed in request.