Settings

Update settings

Update user settings: branding, the outbound webhook endpoint and its event subscriptions, and the default proof lifetime. Setting the first endpoint mints the signing secret and returns it in this response; webhook.rotate_secret replaces it and returns the new value.

patch/api/v1/me/settings

Request

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

Request body

brandingunknown
proof_expiry_daysinteger

Default proof-token lifetime in days for newly issued proofs.

Example request

{
  "webhook": {
    "url": "https://yourapp.com/webhooks/proof",
    "events": [
      "verification_request.completed",
      "proof.*"
    ]
  },
  "proof_expiry_days": 365
}

Response

Settings updated. The body carries the stored settings back, including webhook.secret when this request created or rotated it — the generic success envelope it used to declare omitted a credential the response can carry.

successboolean required
proof_expiry_daysinteger nullable required

Default proof-token lifetime in days, or null when the account has never set one.

Example response

{
  "success": true,
  "webhook": {
    "url": "https://yourapp.com/webhooks/proof",
    "events": [
      "proof.*"
    ],
    "secret": "whsec_1f2e…"
  },
  "proof_expiry_days": 365
}

Changes

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