customer links reference

This reference follows the current server implementation. Use the SDK for customer flows; it manages identity proof and retries. Authentication and errors apply to every endpoint. Types below describe JSON: dates are ISO strings, ? means optional, and null differs from an omitted field. Responses may include additional fields. Schemas also enforce constraints that TypeScript cannot express; download the request JSON Schemas. Named response types are defined in the data model reference.

POST /v1/customer-links/tokens

Authentication: Public or secret app API key; customer/session proof is still required wherever the operation acts on an identity.

Request

Send JSON with Content-Type: application/json. Where multiple shapes are shown, the handler selects the applicable operation or validates nested input.

{ ttlSeconds?: number | undefined;
  }

Validation schemas: createWorkspaceCustomerLinkTokenRequestSchema in the downloadable schema registry.

Response

JSON response shape

{ token: string;
  expiresAt: string;
  workspaceCustomerId: string;
  }

Errors: validation/authentication failures use the common error envelope. A missing or inaccessible target returns an error; never interpret it as an empty successful result.

Implementation · Handler: createWorkspaceCustomerLinkToken.

POST /v1/customer-links/redeem

Authentication: Public or secret app API key; customer/session proof is still required wherever the operation acts on an identity.

Request

Send JSON with Content-Type: application/json. Where multiple shapes are shown, the handler selects the applicable operation or validates nested input.

{ token: string;
  }

Validation schemas: redeemWorkspaceCustomerLinkTokenRequestSchema in the downloadable schema registry.

Response

JSON response shape

{ workspaceCustomerId: string;
  workspaceCustomerToken: string;
  environment: IdEnvironment;
  customerId: string;
  }

Errors: validation/authentication failures use the common error envelope. A missing or inaccessible target returns an error; never interpret it as an empty successful result.

Implementation · Handler: redeemWorkspaceCustomerLinkToken.

POST /v1/customer-links/credential

Authentication: Public or secret app API key; customer/session proof is still required wherever the operation acts on an identity.

Request

No JSON body is required.

Response

JSON response shape

{ workspaceCustomerId: string;
  workspaceCustomerToken: string;
  environment: IdEnvironment;
  }

Errors: validation/authentication failures use the common error envelope. A missing or inaccessible target returns an error; never interpret it as an empty successful result.

Implementation · Handler: createWorkspaceCustomerCredential.