Dashboard

Issue a test (sandbox) key

Issues a faro_test_* key for the caller's email. Test keys return deterministic fixtures (no external checks, no cost) and never write to the reputation graph — see the test-mode fixture table in the docs.

post/v1/me/keys/test

Request

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

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.