Keys

Confirm the magic link and receive the key

Exchanges a valid magic-link token for a new API key. The key is returned once — store it now; only its hash is kept server-side.

post/v1/keys/confirm

Request

  • Base URL: https://api.farofinance.app
  • URL: https://api.farofinance.app/v1/keys/confirm
  • Auth: none declared

Request body

tokenstring required

The signed token from the emailed link.

Response

Successful Response

api_keystring required

The full API key. Store it now; shown only once.

key_prefixstring required

A non-secret prefix for identifying the key later.

emailstring required

The verified email the key was issued to.

Example response

{
  "api_key": "faro_live_3pZ8...",
  "key_prefix": "faro_live_3pZ8Qa"
}

Changes

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