Quickstart

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.

Confirm your key works

GET /v1/relying-party/me tells you which organisation, environment and scopes a key has.

curl https://api.fawcos.com/v1/relying-party/me \
  -H "x-api-key: $FAWCOS_API_KEY"

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());

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())

Response

{
  "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.

Consent requests and attestations are the next endpoints to be released. Follow the Changelog for when they arrive.

Permissions

Which scopes your keys need.

Go live

Apply for live access.

The host api.fawcos.com is a placeholder until the production host is announced.

Get started

Concepts

Next

Permissions

Go live

​Next

Permissions

Go live

Next