Create an API key

post

https://api.wingspan.app/v3/platform/api-keys

Creates a new ApiKey. Returns the secret value exactly once; clients MUST capture it on this response — it is never available on subsequent reads. Idempotent via Idempotency-Key. Because the secret is single-emission, replay after the original response was lost returns 409 ResourceConflict with the existing key Location; rotate that key to recover. If you call with a person's login session, this needs a recent MFA step-up (ApiKeyChange). A backend calling with an API key has no session to step up.

Requires a session with recent MFA step-up for ApiKeyChange. If step-up is missing or expired, this operation returns 403 StepUpMfaRequired; create and verify an MFA challenge at /v3/platform/mfa-challenges with requiredFor: "ApiKeyChange", then retry.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string

required

length between 1 and 200

ownerType

string

enum

Server-resolved from session when omitted. ServiceAccount keys require explicit ownerId.

Allowed:

ownerId

string

scopes

array of strings

Each value is a permission listed by GET /v3/platform/scopes with :read or :write appended, such as payments.payable:write. A camelCase name is stored hyphenated: payments.taxForm:write becomes payments.tax-form:write. A ServiceAccount-owned key's scopes must also remain a subset of the ServiceAccount's current effectiveScopes.

scopes

expiresAt

date-time

metadata

object

Free-form key-value pairs. Max 50 keys; key length at most 40 characters; value length at most 500 characters. Where a list endpoint declares metadata filtering, it uses the QueryQL namespace via filter[metadata.{key}][eq]=value or filter[metadata.{key}][in][]=value. Endpoints that do not declare the dynamic Metadata filter do not support Metadata filtering.

Headers

X-Wingspan-Account

string

^(?:[A-Za-z0-9_.]{22}|[a-f0-9]{24})$

Select the Account for an Account-scoped operation. A direct ServiceAccount API key MUST supply this header, and the target must be within the ServiceAccount owner's or Authorization grant's Account boundary. A Person bearer may select an Account on which it has an active Stakeholder, and an Account session may select its bound Account (or a descendant only when the session explicitly includes descendants).

Idempotency-Key

string

length between 1 and 255

^[\x21-\x7e]{1,255}$

Optional idempotency token for authenticated POST and PATCH requests. Reusing the same key and body returns the cached response for 24 hours, except credential operations that explicitly document a 409 because one-time secret material is never cached; reusing it with a different body returns 409 IdempotencyKeyConflict. Use 1-255 printable ASCII characters.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

201ApiKey created (secret shown once)

401Unauthenticated

403Forbidden or step-up MFA required

409Conflict

422Validation error