Alfred API

API reference for authentication, users, institutions, reports, accounts, and XML generation.

Alfred API

Alfred is a FATCA and CRS reporting platform API.

This reference is based on the current OpenAPI spec.

Common response patterns

Validation errors

Most invalid requests return 422 Unprocessable Entity.

{
  "detail": [
    {
      "loc": ["body", "email"],
      "msg": "Field required",
      "type": "missing"
    }
  ]
}

Pagination

Paginated routes return:

{
  "items": [],
  "total": 0,
  "page": 1,
  "page_size": 50
}

Core workflow

1

Create or access an organisation

Register with POST /auth/register, or sign in with POST /auth/login.

2

Create a financial institution

Add the reporting entity with POST /financial-institutions.

3

Create a report

Create a FATCA, CRS, or CARF report with POST /reports.

4

Import account data

Preview the CSV, map columns, then import the data into the report.

5

Validate and generate XML

Run /validate, then call /generate when the report is ready.