SignEnvoy docs
Sign in Start in the sandbox

API reference API keys

API reference

API keys

GET /v1/keys

List Keys

Responses

  • 200 array of KeyOut (application/json): Successful Response
  • 401 ProblemDetails (application/problem+json): /problems/unauthenticated
  • 402 ProblemDetails (application/problem+json): /problems/live-mode-unavailable
  • 403 ProblemDetails (application/problem+json): Workspace entitlement or access denied.
  • 429 ProblemDetails (application/problem+json): /problems/rate-limited; retry after Retry-After seconds.
  • 500 ProblemDetails (application/problem+json): /problems/engine-error
  • default ProblemDetails (application/problem+json): API error; type identifies the stable problem.

Problem types and recovery steps: error reference.

POST /v1/keys

Create Key

Request body (application/json, required)

MemberTypeNotes
mode string (pattern ^(live|test)$) Default "live".
name required string (min length 1, max length 120)

Responses

  • 201 KeyCreated (application/json): Successful Response
  • 401 ProblemDetails (application/problem+json): /problems/unauthenticated
  • 402 ProblemDetails (application/problem+json): /problems/live-mode-unavailable
  • 403 ProblemDetails (application/problem+json): Workspace entitlement or access denied.
  • 409 ProblemDetails (application/problem+json): Invalid state, conflict, or idempotency key conflict.
  • 422 ProblemDetails (application/problem+json): Request schema or semantic validation failed; inspect type and detail.
  • 429 ProblemDetails (application/problem+json): /problems/rate-limited; retry after Retry-After seconds.
  • 500 ProblemDetails (application/problem+json): /problems/engine-error
  • default ProblemDetails (application/problem+json): API error; type identifies the stable problem.

Problem types and recovery steps: error reference.

POST /v1/keys/{key_id}/revoke

Revoke Key

Path

  • key_id string (uuid)

Responses

  • 204 no body: Successful Response
  • 401 ProblemDetails (application/problem+json): /problems/unauthenticated
  • 402 ProblemDetails (application/problem+json): /problems/live-mode-unavailable
  • 403 ProblemDetails (application/problem+json): Workspace entitlement or access denied.
  • 404 ProblemDetails (application/problem+json): Resource not found or not accessible to this key.
  • 409 ProblemDetails (application/problem+json): Invalid state, conflict, or idempotency key conflict.
  • 422 ProblemDetails (application/problem+json): Request schema or semantic validation failed; inspect type and detail.
  • 429 ProblemDetails (application/problem+json): /problems/rate-limited; retry after Retry-After seconds.
  • 500 ProblemDetails (application/problem+json): /problems/engine-error
  • default ProblemDetails (application/problem+json): API error; type identifies the stable problem.

Problem types and recovery steps: error reference.