kapi WorksDocs

A receipt's signed copy

GET/v1/signed-copy

The signed copy of one receipt of the company, as a PDF: the version as signed, the signature in place, and a signing record page with the document fingerprint and the receipt ID. Kapi draws it on each call and keeps no copy. Requires acknowledgements:read and people:read, because it names the person who signed. A receipt of another company, or of a person Kapi erased, answers not_found.

Authorization

bearerAuth acknowledgements:read, people:read
AuthorizationBearer <token>

A company API key, not an OAuth access token: kw_live_ in production, kw_test_ elsewhere. Send it only in the Authorization header. A key sent in a URL is revoked.

In: header

Scope: acknowledgements:read, people:read

Query Parameters

receipt*string

The receipt's receipt_id.

Formatuuid

Response Body

application/pdf

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

# Supply the key from your server's secret manager. Do not log it.# curl reads the header from stdin, keeping the key out of its arguments.printf 'header = "Authorization: Bearer %s"\n' "$KAPI_WORKS_API_KEY" |  curl --config - --silent --show-error --fail-with-body \  'https://example.com/v1/signed-copy?receipt=497f6eca-6276-4993-bfeb-53cbbbba6f08'
"string"