Skip to content
Longport WhaleLongport Whale
CRS Data

Generate CRS Data

Generate CRS (Common Reporting Standard) reporting data for a given reporting year and AEOI entity.

Request parameters

  • Required: return_year (reporting year), aeoi_id (AEOI ID)
  • Optional: company_name, retain_has_asset (whether to keep records that have assets), account_state (account-status filter)
  • See each field's documentation for format, value ranges, and business meaning.

Business notes

Aggregates and produces reportable data by reporting year and AEOI entity. Optional parameters control whether accounts holding assets are retained and how records are filtered by account status.

Risk warning

This operation produces formal tax-reporting data. Confirm the reporting year and AEOI entity before calling.

Result

On success, CRS data generation is triggered; the response data carries no additional business fields.

POSThttps://b-api.lbkrs.com/crs/generate_crs_data

Authorization

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Permission

report.crs_data

The Broker ACCESS_TOKEN must be granted the permission above, or the call will be rejected.

Request body application/json

return_yearintegerrequired

Reporting year for the CRS data. This field is required.

aeoi_idstringrequired

AEOI (Automatic Exchange of Information) identifier. This field is required.

company_namestring

Name of the reporting entity company.

retain_has_assetboolean

Whether to retain only records that have assets.

account_statearray<string>

Filter by account state, submitted as a string array. Values come from a backend data dictionary (maintained dynamically), not a fixed enum; use the options the service actually returns.

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.
Standard response envelopecodemessagedata
dataobjectdata structure
idstring
HTTP 400Bad request. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 401The user is not authenticated, or the login session has expired.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 408The request timed out. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

Whale Docs