API Keys

Create API key

Create a new API key. The full key value is only shown once in the response.

post/api/v1/me/api-keys

Request

  • Base URL: https://api.proof.holdings
  • URL: https://api.proof.holdings/api/v1/me/api-keys
  • Auth: API key in cookie auth_token

Request body

namestring
environment'production' | 'test'
scopesstring[]
profile_idstring

Bind the key to a sub-account (PublicProfile) owned by the caller. Immutable after creation.

Example request

{
  "name": "Production Key",
  "environment": "production",
  "scopes": [
    "verifications:create",
    "verifications:read"
  ],
  "profile_id": "507f1f77bcf86cd799439011"
}

Response

API key created (full key shown only once)

idstring required

MongoDB ObjectId

keystring required

The full API key. Returned only in this response; it cannot be read again.

namestring required
prefixstring required
environment'production' | 'test' required
scopesstring[] required
profile_idstring required

MongoDB ObjectId

created_atstring date-time required
warningstring required

Example response

{
  "id": "507f1f77bcf86cd799439011",
  "key": "pk_live_abc123...",
  "name": "Production Key",
  "prefix": "pk_live_",
  "environment": "production",
  "scopes": [
    "verifications:*"
  ],
  "profile_id": "507f1f77bcf86cd799439011",
  "warning": "Copy this key now. You will not be able to see it again."
}

Changes

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