Accounts

Preview, import, list, update, and delete report account data.

List Individual Accounts

get

List individual accounts for this report, paginated.

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

report_idstring · uuidRequired

Query parameters

pageinteger · min: 1OptionalDefault: 1

Responses

200

Successful Response

application/json

totalintegerRequired

pageintegerRequired

page_sizeintegerRequired

422

Validation Error

application/json

get

/reports/{report_id}/accounts/individual

HTTPcURLJavaScriptPython

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

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "account_number": "text",
      "account_type": "text",
      "account_status": "text",
      "balance_amount": "text",
      "balance_currency": "text",
      "first_name": "text",
      "last_name": "text",
      "middle_name": "text",
      "date_of_birth": "text",
      "birth_city": "text",
      "birth_country": "text",
      "countries_of_residence": [
        "text"
      ],
      "address_street": "text",
      "address_city": "text",
      "address_country": "text",
      "address_postal_code": "text",
      "address_state": "text",
      "tins": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "value": "text",
          "jurisdiction_code": "text"
        }
      ],
      "created_at": "2026-03-22T08:16:10.813Z"
    }
  ],
  "total": 1,
  "page": 1,
  "page_size": 1
}

List Entity Accounts

get

List entity accounts for this report, paginated.

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

report_idstring · uuidRequired

Query parameters

pageinteger · min: 1OptionalDefault: 1

Responses

200

Successful Response

application/json

totalintegerRequired

pageintegerRequired

page_sizeintegerRequired

422

Validation Error

application/json

get

/reports/{report_id}/accounts/entity

HTTPcURLJavaScriptPython

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

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "account_number": "text",
      "account_type": "text",
      "account_status": "text",
      "balance_amount": "text",
      "balance_currency": "text",
      "entity_name": "text",
      "country_of_incorporation": "text",
      "nfe_type": "text",
      "address_street": "text",
      "address_city": "text",
      "address_country": "text",
      "address_postal_code": "text",
      "address_state": "text",
      "tins": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "value": "text",
          "jurisdiction_code": "text"
        }
      ],
      "created_at": "2026-03-22T08:16:10.813Z"
    }
  ],
  "total": 1,
  "page": 1,
  "page_size": 1
}

List Controlling Persons

get

List controlling persons for this report, paginated.

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

report_idstring · uuidRequired

Query parameters

pageinteger · min: 1OptionalDefault: 1

Responses

200

Successful Response

application/json

totalintegerRequired

pageintegerRequired

page_sizeintegerRequired

422

Validation Error

application/json

get

/reports/{report_id}/accounts/controlling-persons

HTTPcURLJavaScriptPython

GET /reports/{report_id}/accounts/controlling-persons HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "entity_account_id": "123e4567-e89b-12d3-a456-426614174000",
      "first_name": "text",
      "last_name": "text",
      "middle_name": "text",
      "date_of_birth": "text",
      "country_of_residence": "text",
      "crs_type": "text",
      "fatca_type": "text",
      "address_street": "text",
      "address_city": "text",
      "address_country": "text",
      "address_postal_code": "text",
      "address_state": "text",
      "tins": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "value": "text",
          "jurisdiction_code": "text"
        }
      ],
      "created_at": "2026-03-22T08:16:10.813Z"
    }
  ],
  "total": 1,
  "page": 1,
  "page_size": 1
}

Delete Individual Account

delete

Delete a single individual account. Only allowed on DRAFT reports.

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

report_idstring · uuidRequired

account_idstring · uuidRequired

Responses

204

Successful Response

422

Validation Error

application/json

delete

/reports/{report_id}/accounts/individual/{account_id}

HTTPcURLJavaScriptPython

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

No content

Update Individual Account

patch

Update fields on a single individual account. Only allowed on DRAFT reports.

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

report_idstring · uuidRequired

account_idstring · uuidRequired

Body

application/json

account_typeany ofOptional

stringOptional

or

nullOptional

account_statusany ofOptional

stringOptional

or

nullOptional

balance_amountany ofOptional

numberOptional

or

stringOptionalPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

or

nullOptional

balance_currencyany ofOptional

stringOptional

or

nullOptional

first_nameany ofOptional

stringOptional

or

nullOptional

last_nameany ofOptional

stringOptional

or

nullOptional

middle_nameany ofOptional

stringOptional

or

nullOptional

date_of_birthany ofOptional

stringOptional

or

nullOptional

birth_cityany ofOptional

stringOptional

or

nullOptional

birth_countryany ofOptional

stringOptional

or

nullOptional

countries_of_residenceany ofOptional

string[]Optional

or

nullOptional

address_streetany ofOptional

stringOptional

or

nullOptional

address_cityany ofOptional

stringOptional

or

nullOptional

address_countryany ofOptional

stringOptional

or

nullOptional

address_postal_codeany ofOptional

stringOptional

or

nullOptional

address_stateany ofOptional

stringOptional

or

nullOptional

tinsany ofOptional

or

nullOptional

Responses

200

Successful Response

application/json

idstring · uuidRequired

account_numberstringRequired

account_typestringRequired

account_statusstringRequired

balance_amountstringRequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

balance_currencystringRequired

first_namestringRequired

last_namestringRequired

middle_nameany ofRequired

stringOptional

or

nullOptional

date_of_birthany ofRequired

stringOptional

or

nullOptional

birth_cityany ofRequired

stringOptional

or

nullOptional

birth_countryany ofRequired

stringOptional

or

nullOptional

countries_of_residencestring[]Required

address_streetany ofRequired

stringOptional

or

nullOptional

address_cityany ofRequired

stringOptional

or

nullOptional

address_countryany ofRequired

stringOptional

or

nullOptional

address_postal_codeany ofRequired

stringOptional

or

nullOptional

address_stateany ofRequired

stringOptional

or

nullOptional

created_atstring · date-timeRequired

422

Validation Error

application/json

patch

/reports/{report_id}/accounts/individual/{account_id}

HTTPcURLJavaScriptPython

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

{
  "account_type": "text",
  "account_status": "text",
  "balance_amount": 1,
  "balance_currency": "text",
  "first_name": "text",
  "last_name": "text",
  "middle_name": "text",
  "date_of_birth": "text",
  "birth_city": "text",
  "birth_country": "text",
  "countries_of_residence": [
    "text"
  ],
  "address_street": "text",
  "address_city": "text",
  "address_country": "text",
  "address_postal_code": "text",
  "address_state": "text",
  "tins": [
    {
      "value": "text",
      "jurisdiction_code": "text"
    }
  ]
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "account_number": "text",
  "account_type": "text",
  "account_status": "text",
  "balance_amount": "text",
  "balance_currency": "text",
  "first_name": "text",
  "last_name": "text",
  "middle_name": "text",
  "date_of_birth": "text",
  "birth_city": "text",
  "birth_country": "text",
  "countries_of_residence": [
    "text"
  ],
  "address_street": "text",
  "address_city": "text",
  "address_country": "text",
  "address_postal_code": "text",
  "address_state": "text",
  "tins": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "value": "text",
      "jurisdiction_code": "text"
    }
  ],
  "created_at": "2026-03-22T08:16:10.813Z"
}

Delete Entity Account

delete

Delete a single entity account (and its controlling persons). Only allowed on DRAFT reports.

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

report_idstring · uuidRequired

account_idstring · uuidRequired

Responses

204

Successful Response

422

Validation Error

application/json

delete

/reports/{report_id}/accounts/entity/{account_id}

HTTPcURLJavaScriptPython

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

No content

Update Entity Account

patch

Update fields on a single entity account. Only allowed on DRAFT reports.

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

report_idstring · uuidRequired

account_idstring · uuidRequired

Body

application/json

account_typeany ofOptional

stringOptional

or

nullOptional

account_statusany ofOptional

stringOptional

or

nullOptional

balance_amountany ofOptional

numberOptional

or

stringOptionalPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

or

nullOptional

balance_currencyany ofOptional

stringOptional

or

nullOptional

entity_nameany ofOptional

stringOptional

or

nullOptional

country_of_incorporationany ofOptional

stringOptional

or

nullOptional

nfe_typeany ofOptional

stringOptional

or

nullOptional

address_streetany ofOptional

stringOptional

or

nullOptional

address_cityany ofOptional

stringOptional

or

nullOptional

address_countryany ofOptional

stringOptional

or

nullOptional

address_postal_codeany ofOptional

stringOptional

or

nullOptional

address_stateany ofOptional

stringOptional

or

nullOptional

tinsany ofOptional

or

nullOptional

Responses

200

Successful Response

application/json

idstring · uuidRequired

account_numberstringRequired

account_typestringRequired

account_statusstringRequired

balance_amountstringRequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

balance_currencystringRequired

entity_namestringRequired

country_of_incorporationstringRequired

nfe_typeany ofRequired

stringOptional

or

nullOptional

address_streetany ofRequired

stringOptional

or

nullOptional

address_cityany ofRequired

stringOptional

or

nullOptional

address_countryany ofRequired

stringOptional

or

nullOptional

address_postal_codeany ofRequired

stringOptional

or

nullOptional

address_stateany ofRequired

stringOptional

or

nullOptional

created_atstring · date-timeRequired

422

Validation Error

application/json

patch

/reports/{report_id}/accounts/entity/{account_id}

HTTPcURLJavaScriptPython

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

{
  "account_type": "text",
  "account_status": "text",
  "balance_amount": 1,
  "balance_currency": "text",
  "entity_name": "text",
  "country_of_incorporation": "text",
  "nfe_type": "text",
  "address_street": "text",
  "address_city": "text",
  "address_country": "text",
  "address_postal_code": "text",
  "address_state": "text",
  "tins": [
    {
      "value": "text",
      "jurisdiction_code": "text"
    }
  ]
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "account_number": "text",
  "account_type": "text",
  "account_status": "text",
  "balance_amount": "text",
  "balance_currency": "text",
  "entity_name": "text",
  "country_of_incorporation": "text",
  "nfe_type": "text",
  "address_street": "text",
  "address_city": "text",
  "address_country": "text",
  "address_postal_code": "text",
  "address_state": "text",
  "tins": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "value": "text",
      "jurisdiction_code": "text"
    }
  ],
  "created_at": "2026-03-22T08:16:10.813Z"
}

Delete Controlling Person

delete

Delete a single controlling person. Only allowed on DRAFT reports.

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

report_idstring · uuidRequired

cp_idstring · uuidRequired

Responses

204

Successful Response

422

Validation Error

application/json

delete

/reports/{report_id}/accounts/controlling-persons/{cp_id}

HTTPcURLJavaScriptPython

DELETE /reports/{report_id}/accounts/controlling-persons/{cp_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update Controlling Person

patch

Update fields on a single controlling person. Only allowed on DRAFT reports.

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

report_idstring · uuidRequired

cp_idstring · uuidRequired

Body

application/json

first_nameany ofOptional

stringOptional

or

nullOptional

last_nameany ofOptional

stringOptional

or

nullOptional

middle_nameany ofOptional

stringOptional

or

nullOptional

date_of_birthany ofOptional

stringOptional

or

nullOptional

country_of_residenceany ofOptional

stringOptional

or

nullOptional

crs_typeany ofOptional

stringOptional

or

nullOptional

fatca_typeany ofOptional

stringOptional

or

nullOptional

address_streetany ofOptional

stringOptional

or

nullOptional

address_cityany ofOptional

stringOptional

or

nullOptional

address_countryany ofOptional

stringOptional

or

nullOptional

address_postal_codeany ofOptional

stringOptional

or

nullOptional

address_stateany ofOptional

stringOptional

or

nullOptional

tinsany ofOptional

or

nullOptional

Responses

200

Successful Response

application/json

idstring · uuidRequired

entity_account_idstring · uuidRequired

first_namestringRequired

last_namestringRequired

middle_nameany ofRequired

stringOptional

or

nullOptional

date_of_birthany ofRequired

stringOptional

or

nullOptional

country_of_residencestringRequired

crs_typeany ofRequired

stringOptional

or

nullOptional

fatca_typeany ofRequired

stringOptional

or

nullOptional

address_streetany ofRequired

stringOptional

or

nullOptional

address_cityany ofRequired

stringOptional

or

nullOptional

address_countryany ofRequired

stringOptional

or

nullOptional

address_postal_codeany ofRequired

stringOptional

or

nullOptional

address_stateany ofRequired

stringOptional

or

nullOptional

created_atstring · date-timeRequired

422

Validation Error

application/json

patch

/reports/{report_id}/accounts/controlling-persons/{cp_id}

HTTPcURLJavaScriptPython

PATCH /reports/{report_id}/accounts/controlling-persons/{cp_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 328

{
  "first_name": "text",
  "last_name": "text",
  "middle_name": "text",
  "date_of_birth": "text",
  "country_of_residence": "text",
  "crs_type": "text",
  "fatca_type": "text",
  "address_street": "text",
  "address_city": "text",
  "address_country": "text",
  "address_postal_code": "text",
  "address_state": "text",
  "tins": [
    {
      "value": "text",
      "jurisdiction_code": "text"
    }
  ]
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "entity_account_id": "123e4567-e89b-12d3-a456-426614174000",
  "first_name": "text",
  "last_name": "text",
  "middle_name": "text",
  "date_of_birth": "text",
  "country_of_residence": "text",
  "crs_type": "text",
  "fatca_type": "text",
  "address_street": "text",
  "address_city": "text",
  "address_country": "text",
  "address_postal_code": "text",
  "address_state": "text",
  "tins": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "value": "text",
      "jurisdiction_code": "text"
    }
  ],
  "created_at": "2026-03-22T08:16:10.813Z"
}