Sign in

v1

latestOpenAPI 3.0.32026-07-13945127.2 KB
Traders

INT241 Excise Pre-Validation

post/customs/excise/traders/pre-validate

Headers

x-correlation-idstring uuid
Example:3e8dae97-b586-4cef-8511-68ac12da9028

Correlation Id for tracking transactions internally and externally

Content-Type'application/json' required

Type of message content to expect

Accept'application/json' required
Example:application/json

Type of message content to accept

Request body

exciseRegistrationNumberstring required
entityGroup'UK Record' | 'EU Trader' | 'EU Warehouse' | 'UK Temporary Authorisation' | 'EU Temporary Authorisation' required

Example request

{
  "entityGroup": "UK Record",
  "validateProductAuthorisationRequest": [
    {
      "product": {
        "exciseProductCode": "W200"
      }
    }
  ]
}

Response

Return Excise confirmation

validationTimestampstring required
exciseRegistrationNumberstring required
entityGroup'UK Record' | 'EU Trader' | 'EU Warehouse' | 'UK Temporary Authorisation' | 'EU Temporary Authorisation' required
validTraderboolean required
errorCode'1' | '2' | '3' | '4' | '5' | '6'

The 'errorCode' for an invalid trader i.e., when validTrader = "false".<br /> 1 = Pending<br /> 2 = Expired<br /> 3 = Withdrawn<br /> 4 = Cancelled<br /> 5 = Used<br /> 6 = Not Found

errorTextstring
traderType'1' | '2' | '3' | '4' | '5' | '6' | '7'

1 = Warehouse Keeper<br /> 2 = Tax Warehouse<br /> 3 = Registered Consignor<br /> 4 = Registered Consignee<br /> 5 = Temporary Registered Consignee<br /> 6 = Temporary Registered Authorisation<br /> 7 = Other

Example response

{
  "validationTimestamp": "2001-12-17T09:30:47-05:00",
  "entityGroup": "UK Record",
  "validateProductAuthorisationResponse": {
    "productError": [
      {
        "exciseProductCode": "W200"
      }
    ]
  }
}