GET/openapi.json
Retrieve this OpenAPI contract
Integration notes
- Public contract endpoint.
- Save the request ID from an error when contacting Pryzr support.
POST/integration/setup-codes/exchange
Exchange a short-lived one-time integration setup code
Send the dashboard-issued code once from a trusted server process. Keep the response in memory only, write the returned credential directly to the selected server-side secret manager, and discard both secret values. Responses are never cacheable.
Integration notes
- Requires the short-lived, one-time setup code issued in the authenticated dashboard.
- Save the request ID from an error when contacting Pryzr support.
- Send one unique Idempotency-Key for each new action.
POST/integration/certification
Submit evidence-backed integration acceptance checks
The credential environment selects the Sandbox or Production-isolated gate. The checks object must contain every named check for that environment with value true, and revision must be the exact 40-character lowercase hexadecimal Git commit. Sandbox checks: authentication, tenant_isolation, session_creation, status_mapping, webhook_signature, webhook_replay, synthetic_only. Production checks: certified_revision, isolated_configuration, authentication, synthetic_webhook, secret_redaction, rollback, no_real_applicants.
Integration notes
- Requires a server-side API credential with the listed permission.
- Save the request ID from an error when contacting Pryzr support.
- Send one unique Idempotency-Key for each new action.
POST/applicants
Create or resolve an applicant by player reference
Integration notes
- Requires a server-side API credential with the listed permission.
- Save the request ID from an error when contacting Pryzr support.
- Send one unique Idempotency-Key for each new action.
GET/applicants/{id}
Retrieve safe applicant metadata
Integration notes
- Requires a server-side API credential with the listed permission.
- Save the request ID from an error when contacting Pryzr support.
GET/verification-cases
List verification cases
Integration notes
- Requires a server-side API credential with the listed permission.
- Save the request ID from an error when contacting Pryzr support.
POST/verification-cases
Create a verification case
Integration notes
- Requires a server-side API credential with the listed permission.
- Save the request ID from an error when contacting Pryzr support.
- Send one unique Idempotency-Key for each new action.
GET/verification-cases/{id}
Check a verification case
Integration notes
- Requires a server-side API credential with the listed permission.
- Save the request ID from an error when contacting Pryzr support.
POST/verification-cases/{id}/resubmissions
Resume eligible correction steps or restart an expired or abandoned attempt
Integration notes
- Requires a server-side API credential with the listed permission.
- Save the request ID from an error when contacting Pryzr support.
- Send one unique Idempotency-Key for each new action.
POST/verification-cases/{id}/cancel
Cancel a non-final case
Integration notes
- Requires a server-side API credential with the listed permission.
- Save the request ID from an error when contacting Pryzr support.
- Send one unique Idempotency-Key for each new action.
GET/verification-cases/{id}/events
List verification case events
Integration notes
- Requires a server-side API credential with the listed permission.
- Save the request ID from an error when contacting Pryzr support.
POST/step-up-verifications
Request a consent-bound step-up verification
Requires `verification_cases:write`. Returns a single-use player consent URL; production provider access fails closed until approved configuration exists.
Integration notes
- Requires a server-side API credential with the listed permission.
- Save the request ID from an error when contacting Pryzr support.
- Send one unique Idempotency-Key for each new action.
POST/telemetry/browser-tokens
Create a short-lived, origin-bound PlayPrint browser grant
Call only from the operator server. The resulting token is safe to pass to the matching authenticated player session; the operator credential must never enter browser code.
Integration notes
- Requires a server-side API credential with the listed permission.
- Save the request ID from an error when contacting Pryzr support.
- Send one unique Idempotency-Key for each new action.
POST/telemetry/consents
Record a player PlayPrint consent receipt
Call from the operator server after an explicit player choice. Pryzr stores only tenant-scoped hashes of the player and receipt references.
Integration notes
- Requires a server-side API credential with the listed permission.
- Save the request ID from an error when contacting Pryzr support.
- Send one unique Idempotency-Key for each new action.
POST/telemetry/consents/withdraw
Withdraw a player PlayPrint consent receipt
Stops the receipt from authorizing telemetry and removes its derived player profile.
Integration notes
- Requires a server-side API credential with the listed permission.
- Save the request ID from an error when contacting Pryzr support.
- Send one unique Idempotency-Key for each new action.
POST/telemetry/browser
Ingest browser telemetry using a short-lived PlayPrint grant
Accepts CORS requests only when the HTTPS Origin, SDK configuration version, player, session, device and consent receipt match the signed browser grant.
Integration notes
- Requires a short-lived, origin-bound PlayPrint browser grant.
- Save the request ID from an error when contacting Pryzr support.
- Send one unique Idempotency-Key for each new action.
POST/telemetry
Submit a batch of consented PlayPrint signals
Accepts privacy-safe behavioral summaries. Raw coordinates, typed text, credentials, documents, payment data, message content, and unknown signal fields are rejected.
Integration notes
- Requires a server-side API credential with the listed permission.
- Save the request ID from an error when contacting Pryzr support.
- Send one unique Idempotency-Key for each new action.
POST/transaction-events
Submit one transaction event
Accepts provider-neutral transaction lifecycle data. Stable account, payment, device, session, and network references are irreversibly tenant-hashed before persistence.
Integration notes
- Requires a server-side API credential with the listed permission.
- Save the request ID from an error when contacting Pryzr support.
- Send one unique Idempotency-Key for each new action.
POST/webhook-endpoints
Register an outbound webhook endpoint
Requires `webhook_endpoints:write`. The signing secret is returned once; an idempotent replay returns `secret_omitted` instead.
Integration notes
- Requires a server-side API credential with the listed permission.
- Save the request ID from an error when contacting Pryzr support.
- Send one unique Idempotency-Key for each new action.
PATCH/webhook-endpoints/{id}
Update endpoint destination, status, or subscriptions
Requires `webhook_endpoints:write`. Changing the destination preserves the endpoint ID and active signing secrets.
Integration notes
- Requires a server-side API credential with the listed permission.
- Save the request ID from an error when contacting Pryzr support.
- Send one unique Idempotency-Key for each new action.
POST/webhook-endpoints/{id}/rotate-secret
Rotate an endpoint signing secret
Requires `webhook_endpoints:write`. The new secret is returned once; the previous secret remains valid only for the bounded overlap.
Integration notes
- Requires a server-side API credential with the listed permission.
- Save the request ID from an error when contacting Pryzr support.
- Send one unique Idempotency-Key for each new action.
POST/webhook-endpoints/{id}/test
Queue a signed synthetic test event
Requires `webhook_endpoints:write`.
Integration notes
- Requires a server-side API credential with the listed permission.
- Save the request ID from an error when contacting Pryzr support.
- Send one unique Idempotency-Key for each new action.
GET/webhook-deliveries
List outbound webhook delivery history
Requires `webhook_deliveries:read`. Unknown or repeated query parameters are rejected.
Integration notes
- Requires a server-side API credential with the listed permission.
- Save the request ID from an error when contacting Pryzr support.
POST/webhook-deliveries/{id}/redeliver
Queue an audited redelivery of a settled delivery
Requires `webhook_deliveries:write`.
Integration notes
- Requires a server-side API credential with the listed permission.
- Save the request ID from an error when contacting Pryzr support.
- Send one unique Idempotency-Key for each new action.