compliance

Verify a JWS compliance receipt

Cryptographically verifies a compact JWS compliance receipt or settlement attestation. Checks signature, algorithm whitelist, canon_version registry, JCS re-canonicalisation, required fields, and optionally payment_hash binding.

post/v1/receipt/verify

Request

  • Base URL: https://api.algovoi.co.uk (the document declares no server; this is the origin it was published from)
  • URL: https://api.algovoi.co.uk/v1/receipt/verify
  • Auth: none declared

Request body

jwsstring required

Compact JWS string (header.payload.signature) as returned by /compliance/screen (compliance_receipt_jws field) or /verify (settlement_attestation_jws field).

expected_payment_hashstring nullable

If supplied, the receipt's payment_hash field must equal this value. Use to bind a receipt to a specific transaction. Format: 'sha256:<hex>'.

receipt_requiredboolean

If True, treat a missing JWS as a MISSING_ENVELOPE error rather than a format error.

jwksobject nullable

Optional external JWKS dict ({'keys': [...]}) for verifying receipts signed by a third-party provider. If omitted, AlgoVoi's own platform key is used.

Response

Successful Response

verifiedboolean required
error_codestring nullable
error_messagestring nullable
error_fieldstring nullable
screen_resultstring nullable
settlement_statusstring nullable
canon_versionstring nullable
algstring nullable
kidstring nullable
screen_provider_didstring nullable
payer_refstring nullable
payment_hashstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.