Check runtime readiness for invoice validation

GET

/health/readiness

Returns a lightweight readiness report for validation prerequisites such as
XSD/XSL artifacts, Saxon jars, Java, ZIP support, temp directory access,
and local storage access.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

Responses

🟢200

application/json

Runtime is ready for invoice validation

Body

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.xinvoice.net/v1/health/readiness' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>'

Response Example

200 - ready

{
    "status": "ready",
    "checks": {
        "xsd": true,
        "saxon_jar": true,
        "xmlresolver_jar": true,
        "xmlresolver_data_jar": true,
        "temp_dir_writable": true,
        "storage_writable": true,
        "java_binary_configured": true,
        "java_binary_available": true,
        "zip_extension_loaded": true,
        "verapdf_base_dir_writable": true
    }
}

Modified at 2026-04-16 14:43:55

List stored invoices for the current API key