Reports

Create, filter, amend, and audit FATCA, CRS, and CARF reports.

List Reports

get

List reports for the organisation, with optional filters.

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

fi_idany ofOptional

string · uuidOptional

or

nullOptional

report_typeany ofOptional

string · enumOptionalPossible values:

or

nullOptional

jurisdictionany ofOptional

string · enumOptionalPossible values:

or

nullOptional

statusany ofOptional

string · enumOptionalPossible values:

or

nullOptional

period_yearany ofOptional

integerOptional

or

nullOptional

Responses

200

Successful Response

application/json

idstring · uuidRequired

fi_idstring · uuidRequired

report_typestring · enumRequiredPossible values:

jurisdictionstring · enumRequiredPossible values:

period_yearintegerRequired

statusstring · enumRequiredPossible values:

nil_declarationbooleanRequired

message_ref_idstringRequired

is_amendmentbooleanRequired

corrects_report_idany ofRequired

string · uuidOptional

or

nullOptional

corrects_message_ref_idany ofRequired

stringOptional

or

nullOptional

individual_account_countintegerRequired

entity_account_countintegerRequired

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

422

Validation Error

application/json

get

/reports

HTTPcURLJavaScriptPython

GET /reports HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "fi_id": "123e4567-e89b-12d3-a456-426614174000",
    "report_type": "FATCA",
    "jurisdiction": "UK",
    "period_year": 1,
    "status": "DRAFT",
    "nil_declaration": true,
    "message_ref_id": "text",
    "is_amendment": true,
    "corrects_report_id": "123e4567-e89b-12d3-a456-426614174000",
    "corrects_message_ref_id": "text",
    "individual_account_count": 1,
    "entity_account_count": 1,
    "created_at": "2026-03-22T08:16:10.434Z",
    "updated_at": "2026-03-22T08:16:10.434Z"
  }
]

Create Report

post

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

fi_idstring · uuidRequired

report_typestring · enumRequiredPossible values:

jurisdictionstring · enumRequiredPossible values:

period_yearintegerRequired

nil_declarationbooleanOptionalDefault: false

message_ref_idany ofOptional

stringOptional

or

nullOptional

Responses

201

Successful Response

application/json

422

Validation Error

application/json

post

/reports

HTTPcURLJavaScriptPython

POST /reports HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 154

{
  "fi_id": "123e4567-e89b-12d3-a456-426614174000",
  "report_type": "FATCA",
  "jurisdiction": "UK",
  "period_year": 1,
  "nil_declaration": false,
  "message_ref_id": "text"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "fi_id": "123e4567-e89b-12d3-a456-426614174000",
  "report_type": "FATCA",
  "jurisdiction": "UK",
  "period_year": 1,
  "status": "DRAFT",
  "nil_declaration": true,
  "message_ref_id": "text",
  "is_amendment": true,
  "corrects_report_id": "123e4567-e89b-12d3-a456-426614174000",
  "corrects_message_ref_id": "text",
  "individual_account_count": 1,
  "entity_account_count": 1,
  "created_at": "2026-03-22T08:16:10.434Z",
  "updated_at": "2026-03-22T08:16:10.434Z"
}

Get Report

get

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

report_idstring · uuidRequired

Responses

200

Successful Response

application/json

idstring · uuidRequired

fi_idstring · uuidRequired

report_typestring · enumRequiredPossible values:

jurisdictionstring · enumRequiredPossible values:

period_yearintegerRequired

statusstring · enumRequiredPossible values:

nil_declarationbooleanRequired

message_ref_idstringRequired

is_amendmentbooleanRequired

corrects_report_idany ofRequired

string · uuidOptional

or

nullOptional

corrects_message_ref_idany ofRequired

stringOptional

or

nullOptional

individual_account_countintegerRequired

entity_account_countintegerRequired

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

422

Validation Error

application/json

get

/reports/{report_id}

HTTPcURLJavaScriptPython

GET /reports/{report_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "fi_id": "123e4567-e89b-12d3-a456-426614174000",
  "report_type": "FATCA",
  "jurisdiction": "UK",
  "period_year": 1,
  "status": "DRAFT",
  "nil_declaration": true,
  "message_ref_id": "text",
  "is_amendment": true,
  "corrects_report_id": "123e4567-e89b-12d3-a456-426614174000",
  "corrects_message_ref_id": "text",
  "individual_account_count": 1,
  "entity_account_count": 1,
  "created_at": "2026-03-22T08:16:10.434Z",
  "updated_at": "2026-03-22T08:16:10.434Z"
}

Delete Report

delete

Delete a report. Only DRAFT reports can be deleted.

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

report_idstring · uuidRequired

Responses

204

Successful Response

422

Validation Error

application/json

delete

/reports/{report_id}

HTTPcURLJavaScriptPython

DELETE /reports/{report_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update Report

patch

Update nil_declaration or message_ref_id. Only allowed on DRAFT reports.

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

report_idstring · uuidRequired

Body

application/json

Only meaningful fields that can change on a DRAFT report.

nil_declarationany ofOptional

booleanOptional

or

nullOptional

message_ref_idany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

idstring · uuidRequired

fi_idstring · uuidRequired

report_typestring · enumRequiredPossible values:

jurisdictionstring · enumRequiredPossible values:

period_yearintegerRequired

statusstring · enumRequiredPossible values:

nil_declarationbooleanRequired

message_ref_idstringRequired

is_amendmentbooleanRequired

corrects_report_idany ofRequired

string · uuidOptional

or

nullOptional

corrects_message_ref_idany ofRequired

stringOptional

or

nullOptional

individual_account_countintegerRequired

entity_account_countintegerRequired

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

422

Validation Error

application/json

patch

/reports/{report_id}

HTTPcURLJavaScriptPython

PATCH /reports/{report_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "nil_declaration": true,
  "message_ref_id": "text"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "fi_id": "123e4567-e89b-12d3-a456-426614174000",
  "report_type": "FATCA",
  "jurisdiction": "UK",
  "period_year": 1,
  "status": "DRAFT",
  "nil_declaration": true,
  "message_ref_id": "text",
  "is_amendment": true,
  "corrects_report_id": "123e4567-e89b-12d3-a456-426614174000",
  "corrects_message_ref_id": "text",
  "individual_account_count": 1,
  "entity_account_count": 1,
  "created_at": "2026-03-22T08:16:10.434Z",
  "updated_at": "2026-03-22T08:16:10.434Z"
}

Create Amendment

post

Create an amendment report based on an existing GENERATED report.

The amendment starts as a DRAFT with is_amendment=True and references the original report's message_ref_id via corrects_message_ref_id. The XML generator will use CRS702 / FATCA2 and include .

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

report_idstring · uuidRequired

Responses

201

Successful Response

application/json

422

Validation Error

application/json

post

/reports/{report_id}/amend

HTTPcURLJavaScriptPython

POST /reports/{report_id}/amend HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "fi_id": "123e4567-e89b-12d3-a456-426614174000",
  "report_type": "FATCA",
  "jurisdiction": "UK",
  "period_year": 1,
  "status": "DRAFT",
  "nil_declaration": true,
  "message_ref_id": "text",
  "is_amendment": true,
  "corrects_report_id": "123e4567-e89b-12d3-a456-426614174000",
  "corrects_message_ref_id": "text",
  "individual_account_count": 1,
  "entity_account_count": 1,
  "created_at": "2026-03-22T08:16:10.434Z",
  "updated_at": "2026-03-22T08:16:10.434Z"
}