Skip to content
Signkoi
Developer docs

Files API

Download the original PDF, the signed PDF and the certificate of completion.

On this page

Download the original PDF

GET/v1/envelopes/{id}/files/original

The PDF as uploaded (several files merged into one), named <title>.pdf.

Required scope:envelopes:read

Path parameters

  • idstring · uuidrequired

    Envelope id.

Response

200The PDF.

Binary PDF (application/pdf) with Content-Disposition: attachment.

Response headers: Content-Disposition, X-Request-Id, Signkoi-Version, X-RateLimit-Limit, X-RateLimit-Remaining.

Errors

  • 401Missing, invalid, expired or revoked API key (api_key_missing, invalid_api_key).
  • 403The key lacks a required scope (insufficient_scope) or the account is suspended (account_suspended).
  • 404No such resource, or it belongs to someone else (resource_missing, e.g. "No such envelope." / "No such recipient.").
  • 429Too many requests (rate_limited): your key's per-minute limit, or an endpoint's own limit. Wait for Retry-After seconds.
  • 500Something went wrong on our side (internal_error). Safe to retry with the same Idempotency-Key.

Every error uses the error object.

Example request

curl https://signkoi.com/api/v1/envelopes/9b2f4c1e-7a3d-4e8b-9c51-2d6f8a0b3e47/files/original \
  -H "Authorization: Bearer $SIGNKOI_API_KEY" \
  -o original.pdf

Download the signed PDF

GET/v1/envelopes/{id}/files/signed

The completed, digitally sealed PDF with every signature and value, named <title> (signed).pdf. 404 file_not_ready until the envelope is completed.

Required scope:envelopes:read

Path parameters

  • idstring · uuidrequired

    Envelope id.

Response

200The signed PDF.

Binary PDF (application/pdf) with Content-Disposition: attachment.

Response headers: Content-Disposition, X-Request-Id, Signkoi-Version, X-RateLimit-Limit, X-RateLimit-Remaining.

Errors

  • 401Missing, invalid, expired or revoked API key (api_key_missing, invalid_api_key).
  • 403The key lacks a required scope (insufficient_scope) or the account is suspended (account_suspended).
  • 404No such envelope (resource_missing), or it is not completed yet (file_not_ready).
  • 429Too many requests (rate_limited): your key's per-minute limit, or an endpoint's own limit. Wait for Retry-After seconds.
  • 500Something went wrong on our side (internal_error). Safe to retry with the same Idempotency-Key.

Every error uses the error object.

Example request

curl https://signkoi.com/api/v1/envelopes/9b2f4c1e-7a3d-4e8b-9c51-2d6f8a0b3e47/files/signed \
  -H "Authorization: Bearer $SIGNKOI_API_KEY" \
  -o signed.pdf

Download the certificate of completion

GET/v1/envelopes/{id}/files/certificate

The certificate of completion with the audit trail, named <title> (certificate).pdf. 404 file_not_ready until the envelope is completed.

Required scope:envelopes:read

Path parameters

  • idstring · uuidrequired

    Envelope id.

Response

200The certificate PDF.

Binary PDF (application/pdf) with Content-Disposition: attachment.

Response headers: Content-Disposition, X-Request-Id, Signkoi-Version, X-RateLimit-Limit, X-RateLimit-Remaining.

Errors

  • 401Missing, invalid, expired or revoked API key (api_key_missing, invalid_api_key).
  • 403The key lacks a required scope (insufficient_scope) or the account is suspended (account_suspended).
  • 404No such envelope (resource_missing), or it is not completed yet (file_not_ready).
  • 429Too many requests (rate_limited): your key's per-minute limit, or an endpoint's own limit. Wait for Retry-After seconds.
  • 500Something went wrong on our side (internal_error). Safe to retry with the same Idempotency-Key.

Every error uses the error object.

Example request

curl https://signkoi.com/api/v1/envelopes/9b2f4c1e-7a3d-4e8b-9c51-2d6f8a0b3e47/files/certificate \
  -H "Authorization: Bearer $SIGNKOI_API_KEY" \
  -o certificate.pdf