> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fawcos.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> From a test key to your first API call.

<Steps>
  <Step title="Turn on sandbox access and create a test key">
    An administrator of your organisation signs in to the FaWCOS enterprise dashboard, turns on
    sandbox access, and creates a key with the scopes you need. The key starts with `FWS_test_`
    and is shown **once**, so store it straight away. See [Authentication](/authentication).
  </Step>

  <Step title="Confirm your key works">
    `GET /v1/relying-party/me` tells you which organisation, environment and scopes a key has.

    <CodeGroup>
      ```bash cURL theme={null}
      curl https://api.fawcos.com/v1/relying-party/me \
        -H "x-api-key: $FAWCOS_API_KEY"
      ```

      ```javascript JavaScript theme={null}
      const res = await fetch('https://api.fawcos.com/v1/relying-party/me', {
        headers: { 'x-api-key': process.env.FAWCOS_API_KEY },
      });
      console.log(await res.json());
      ```

      ```python Python theme={null}
      import os, requests

      res = requests.get(
          "https://api.fawcos.com/v1/relying-party/me",
          headers={"x-api-key": os.environ["FAWCOS_API_KEY"]},
      )
      print(res.json())
      ```
    </CodeGroup>

    ```json Response theme={null}
    {
      "data": {
        "organization": { "id": "…", "name": "Example Bank", "type": "bank" },
        "environment": "test",
        "scopes": ["attestations:read"],
        "limits": { "per_minute": 60, "per_day": 1000 },
        "usage": { "today": 1 }
      }
    }
    ```

    An `environment` of `test` confirms you are in the sandbox. If you get `401 unauthorized`, see
    [Errors](/guides/errors).
  </Step>
</Steps>

## Next

Consent requests and attestations are the next endpoints to be released. Follow the
[Changelog](/changelog) for when they arrive.

<CardGroup cols={2}>
  <Card title="Permissions" icon="lock" href="/permissions">
    Which scopes your keys need.
  </Card>

  <Card title="Go live" icon="rocket" href="/go-live">
    Apply for live access.
  </Card>
</CardGroup>

<Note>The host `api.fawcos.com` is a placeholder until the production host is announced.</Note>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.