Create a sandbox onboarding API key

Creates a sandbox-only API key after current terms acceptance and credential self-service gates are complete. External URL: /v1/onboarding/credentials/sandbox-key. Current Next.js implementation path: /api/platform/v1/onboarding/credentials/sandbox-key. This mutating route requires Idempotency-Key and credentials.write; live credential creation remains operator-controlled. The raw key is revealed only on the initial successful response; replay-safe idempotency storage omits raw key material.

post/onboarding/credentials/sandbox-key

Request

Base URL: https://platform-api.homejourney.sg/v1
URL: https://platform-api.homejourney.sg/v1/onboarding/credentials/sandbox-key
Auth: HTTP bearer

Headers

X-Correlation-Idstring

Optional partner-provided correlation ID echoed into request evidence.

Idempotency-Keystring required

Required for mutating platform routes. Accepted format: 8 to 128 ASCII characters matching [A-Za-z0-9._:-]+.

Request body

key_namestring required

Human-readable sandbox key name shown in credential inventory.

requested_scopesPlatformScope[]

Optional approved self-service scope subset. The API rejects scope expansion and recursive credential-management scopes.

expires_in_daysinteger

Optional sandbox key lifetime in days. Defaults to 30.

Response

Sandbox credential metadata, one-time raw key reveal, and refreshed readiness contract.

idempotency_key_hashstring required

livemodefalse required

request_idstring required

Changes

No recorded changes to this operation across all 1 revision of this API.