Deployment Entitlement Unverified
URI: https://docs.ankatech.co/errors/deployment-entitlement-unverified
HTTP Status: 402 Payment Required
When you see this
The deployment you are calling is entitled through its AWS Marketplace subscription, and that entitlement is not verified right now. Until it is, the deployment is in cryptographic read-only mode: it still serves the data it already protected, and it refuses to protect anything new.
This is a deployment-wide condition, not a property of your tenant, your client or your token. Every caller of that deployment sees the same refusal on the same operations.
A deployment entitled through the AWS Marketplace has no licence file. Its entitlement is verified from the instance identity document AWS signs for the instance it runs on, and it is restored as soon as that verification succeeds again. Nothing has to be installed or renewed.
What still works, and what does not
Read-only mode is the same as for an expired deployment licence, and is defined by the operation, not by the caller.
Still served
decrypt,verify,decrypt-verify, and their streaming forms- key metadata reads, key listings, the supported-algorithm catalogue
- the rotation-admissibility preview
- key revoke
analyze-pkcs7and its streaming form- interoperability
verify - the licence status, monitoring and health reads
Refused with this problem
encrypt,sign,sign-encrypt,reencrypt,resign, and their streaming forms- interoperability
encrypt - key generation, key rotation, key import, keystore import and keystore analyze
convert-pkcs7-to-joseand its streaming form
The cause member
extensions.cause names one category, and nothing about the instance or its identity document:
cause | Meaning |
|---|---|
signature-invalid | The instance identity document did not verify against AWS's signing certificate for its Region |
region-unknown | The document names a Region this release carries no AWS signing certificate for |
product-code-mismatch | The document does not carry the product code of the ANKASecure AWS Marketplace listing: the instance was not launched from a subscribed ANKASecure AMI |
imds-unavailable | The instance identity could not be obtained from the instance metadata service, and no earlier verification is in effect |
recovery-window-exceeded | The instance identity could not be obtained for longer than the recovery window that follows the last successful verification |
The first three are refusals of the evidence and end the entitlement at once. The last two are about obtaining the evidence: while a verification succeeded recently, a failure to obtain it does not refuse anything.
Response Example
{
"type": "https://docs.ankatech.co/errors/deployment-entitlement-unverified",
"title": "Deployment Entitlement Unverified",
"status": 402,
"detail": "The deployment entitlement is not verified, so the installation is in cryptographic read-only mode. Contact your platform administrator; the cause member names the category.",
"instance": "/api/v3/crypto/encrypt",
"correlationId": "4b7e2c19-8d3a-4f61-9a05-1e6c3b8d2f74",
"timestamp": 1793284805,
"extensions": { "cause": "imds-unavailable" }
}
Content-Type: application/problem+json: the response follows RFC 9457 Problem Details. The detail is the same for every cause; branch on type, and read extensions.cause to tell an administrator which category applies.
Relayed by the Admin API
When the Admin API performs a key or cryptographic operation for the console and receives this refusal, it relays the type, title, detail, status and extensions.cause unchanged, and sets its own instance and extensions.requestId.
Not the same problem as an expired licence
Deployment License Expired also answers 402 in read-only mode, but its remedy is to install or renew a licence. This problem has no licence to install. Dispatch on type.
How to Resolve
There is nothing to change in your request, and retrying it immediately will not clear it.
- Contact your platform administrator and give them the
cause, theinstancepath and thecorrelationId. - Continue reading in the meantime. Decrypt, verify and metadata reads keep working.
- Retry the refused operation after the administrator confirms the entitlement is verified.
For the platform administrator, by cause:
imds-unavailableorrecovery-window-exceeded: on the instance, the instance metadata service must answer with IMDSv2 required and a hop limit of 1, and the licence evidence timer must be running. Run a verification at once withsudo systemctl start ankasecure-license-evidence@<environmentName>.service; the deployment picks up the result within about a minute.product-code-mismatch: run the deployment on an instance launched from the subscribed ANKASecure AWS Marketplace AMI.signature-invalidorregion-unknown: contact ANKATech support with thecorrelationId.
The console's License screen shows the same status and cause, and the command to run.
Do not treat this as a transport failure
A 402 is a decision, not an outage. It carries no Retry-After and should not be counted against a circuit breaker. If the deployment's licence service itself is unreachable, the platform answers 503 with a Retry-After instead.
Related
For full schema definitions, examples, and interactive testing, see the Developer Hub Reference.