Complete this checklist in a non-production environment before you enable production traffic. QueryTek validates integrator releases on staging and local Compose; your team may use staging, a dedicated test tenant, or your own pre-production API base URL.
- Optional first pass: use the public integrator sandbox workbench (
/developer/accountsignup → JWT in browser only) before wiring production credentials - Obtain Keycloak client credentials / user JWT for the target tenant (
client_adminorplatform_adminas required) - Confirm API base URL and TLS
-
GET /v1/healthandGET /v1/readyzsucceed -
POST /v1/intake/submitreturns201with submission id - Retry
POST /v1/intake/submitwith the sameIdempotency-Keyand body returns the same201(no second submission) - Same
Idempotency-Keywith a different body returns409IDEMPOTENCY_KEY_MISMATCH - Retry
POST /v1/documentsandPOST /v1/batcheswith the sameIdempotency-Keyand file digest returns the same201(no second document or batch) - Retry
POST /v1/documents/{id}/payandPOST /v1/batches/{id}/paywith the sameIdempotency-Keyreturns the same200checkout payload - Retry
POST /v1/documents/{id}/withdrawandPOST /v1/batches/{id}/withdrawwith the sameIdempotency-Keyreturns the same200(no second purge) - Retry
POST /v1/documents/{id}/payment/confirmandPOST /v1/batches/{id}/payment/confirmwith the sameIdempotency-Keyandtransaction_idreturns the same200(no second paid transition) - Retry
POST /v1/documents/{id}/payment/syncandPOST /v1/batches/{id}/payment/syncwith the sameIdempotency-Keyreturns the same200 - Retry
POST /v1/pay/invite/redeemwith the sameIdempotency-Keyand token returns the same200(no second redeem) -
GET /v1/intake/submissions/{id}returns the submission -
POST /v1/webhooks/subscriptionswith HTTPS FQDN returns201and a one-timesecret - Persist
secretoffline; confirmGET /v1/webhooks/subscriptionsdoes not return secrets - Implement signature verification (see the webhooks guide sample)
- Confirm 422 on
http://webhook URL and private IP targets - Confirm 401 without Bearer token
- Confirm 429 behavior under load (optional soak)
- Your client is generated from the current OpenAPI integrator subset
- Confirm a test event reaches your webhook endpoint and appears as
deliveredinGET /v1/webhooks/deliveries
Production API must not require /docs — distribute integrator-openapi.json + these guides.