API overview
Send proofs and verify certificates from your own tools, with an API key.
The Wipe API lets your tools do what a technician does in the portal: submit proofs and follow their processing. Certificate verification is public and needs no key.
This reference covers the routes you can call from your own tools. The other features of the portal (users, licenses, settings) are only available in the portal.
Base URL
https://app.wipe.exaion.com/api/v1Authentication
Send an organization API key in the X-Api-Key header. A client admin creates it in
Settings → API keys, with the scopes the tool needs:
| Scope | Routes |
|---|---|
proofs:write | POST /proofs, POST /proofs/bulk |
proofs:read | GET /proofs/{id}, GET /proofs/{id}/status |
See API keys. When your organization restricts access by IP address, keys only work from the allowed networks.
Idempotency
Every route under /proofs requires an Idempotency-Key header: a UUID v4 you generate for each
new request. If a request is sent again with the same key (after a timeout, for example), Wipe
returns the first answer instead of processing it twice, with an Idempotency-Replayed: true
header.
Submit a proof and follow it
# Submit
curl -X POST "https://app.wipe.exaion.com/api/v1/proofs" \
-H "X-Api-Key: $WIPE_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-F "file=@proof.der"
# Follow, with the proof id returned above
curl "https://app.wipe.exaion.com/api/v1/proofs/$PROOF_ID/status" \
-H "X-Api-Key: $WIPE_API_KEY" \
-H "Idempotency-Key: $(uuidgen)"The statuses are the ones of the portal: see Proof statuses. Rather than polling, a client admin can have Wipe call your system when a certificate is issued: see Notifications.
Limits and errors
| Limit | Value |
|---|---|
| One proof | 5 MB |
| One batch | 100 files or one ZIP archive, 500 MB |
| Single submissions | 100 per hour per key |
| Batch submissions | 500 per hour per key |
Above a rate limit, Wipe answers 429 with a Retry-After header. Errors come as JSON,
{"error": {"code": "...", "message": "...", "request_id": "..."}}: give the request_id to support
when you report a problem.
A rejected proof is not an API error: the submission succeeds, then the proof status becomes
REJECTED, with a stable rejection_code (see
Unblock a proof).