Validate IOSS eligibility by session ID

Use this request to check whether an ePAL transaction is eligible for IOSS or not.

Use a POST operation and the following URL to send this request:
{api_url}/
where {api_url} is the API's URL.
For example:
https://api.epalglobal.co/ioss-validation/by-session

Details

Table 1. Request Details
Detail Value
Operation POST
Endpoint
Fields

Body Parameters

Table 2.
Body Paramter Details Description
sessionId
  • Type: String
  • Status: Mandatory
  • Required Values: Session ID
Specify the Session ID. This is returned in the sessionId field of the Process Transaction request.

Response Parameters

Table 3.
Response Parameter Details Description
destinationCountry
  • Type: String
  • Status: Mandatory
The name of the country where the goods are sent.
details
  • Type: Array of strings
  • Status: Mandatory
Individual messages about the IOSS eligibility test.
exchangeRateUsed
  • Type: Number
  • Status: Optional
The exchange rate used for currency conversions.
hasAlcohol
  • Type: Boolean
  • Status: Mandatory
Indicates whether or not the goods contain alcohol.
iossThreshold
  • Type: Number
  • Status: Optional
The threshold value for IOSS. This can be used for comparisons.
isB2B
  • Type: Boolean
  • Status: Mandatory
Indicates whether the transaction qualifies as a B2B transaction or not.
isEUDestination
  • Type: Boolean
  • Status: Mandatory
Indidcates whether the destination is a European Union (EU) member state or not.
isIOSSCompliant
  • Type: Boolean
  • Status: Mandatory
Indicates whether the consigment is eligible for IOSS or not.
message
  • Type: String
  • Status: Mandatory
Details about why the consignment is or is not eligible for IOSS.
originalCurrency
  • Type: String
  • Status: Optional
If a currency conversion is applied, this is the original or source currency from which the target currency is converted.
originalTotalValue
  • Type: Number
  • Status: Optional
The total value before the currency conversion, in the source or original currency.
sourceCountry
  • Type: String
  • Status: Mandatory
The name of the source country.
totalIntrinsicValue
  • Type: Number
  • Status: Optional
The total intrinsic value of the goods, exclusing tax and shipping.
validatedAt
  • Type: String
  • Status: Mandatory
T he timestamp of whne the validation eligibility check occurred.

Request Example

The following is an example request body:
{
  "sessionId": "550e8400-e29b-41d4-a716-446655440000"
}

Response Example

The following is an example of a response to a successful request:
{
  "isIOSSCompliant": true,
  "message": "This consignment is eligible for IOSS because: The Ship From country is Netherlands, The Destination country is Germany, The consignment has been identified as B2C, ePAL did not identify any Excisable goods in the consignment(*), The total intrinsic value of the physical goods is €120.00 (excluding VAT and shipping)",
  "details": [
    "The Ship From country is Netherlands",
    "The Destination country is Germany",
    "The consignment has been identified as B2C",
    "ePAL did not identify any Excisable goods in the consignment(*)",
    "The total intrinsic value of the physical goods is €120.00 (excluding VAT and shipping)"
  ],
  "totalIntrinsicValue": 120,
  "iossThreshold": 150,
  "isEUDestination": true,
  "isB2B": false,
  "hasAlcohol": false,
  "sourceCountry": "Netherlands",
  "destinationCountry": "Germany",
  "validatedAt": "2025-10-15T12:00:00.000Z",
  "originalCurrency": "USD",
  "exchangeRateUsed": 0.92,
  "originalTotalValue": 130.43
}