Reporting Tax Jurisdiction Query

Queries the CRS reportable tax-jurisdiction configuration, which maintains whether each country / region requires reporting and its initial reporting year.

Request parameters

Combine business filters through filters (available fields are described under the filters section below), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

The data is a list of reportable tax jurisdictions, filterable by tax jurisdiction, initial reporting year, and whether reporting is required.

Each record carries the tax jurisdiction (country / region code and its Chinese and English names), whether reporting is required, and the initial reporting year.

It is typically used to determine the jurisdiction coverage of CRS reporting and to guide reportable-account filtering and file generation.

Returns

On success, returns the matching record list together with pagination information. See the response definition for the meaning of each returned column.

POSThttps://b-api.lbkrs.com/v1/datasets/report_crs_tax_jurisdictions

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

filtersobject

Combines business filters. Omit a filter field to disable that filter.

Child attributes

tj_country_codestring

Filters results by Jurisdiction.

Values are dynamic. Call GET /v1/datasets/refs/crs_tax_jurisdiction to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

initial_reporting_yearstring

Filters results by Initial Reporting Year.

report_requirementstring

Filters results by Reporting Requirement.

Allowed values: 1 Y, 0 N

Values

1: Y
0: N

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Reporting Tax Jurisdiction Query records together with pagination metadata such as the page number, page size, and total record count.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

Returned value: List of list.

Child attributes

idstring

Record ID. Returned value: Record ID (row primary key); write operations on this record take it as their id.

tj_country_namestring

Returned value: Jurisdiction.

tj_country_codestring

Returned value: Jurisdiction Code.

report_requirementstring

Returned value: Reporting Requirement.

report_requirement_valstring

Raw value of report_requirement. The report_requirement field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

initial_reporting_yearstring

Returned value: Initial Reporting Year.

totalintegerrequired

Returned value: Total number of matching records, used for pagination.

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

Request

curl --request POST \
  --url 'https://b-api.lbkrs.com/v1/datasets/report_crs_tax_jurisdictions' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "123",
        "tj_country_name": "Antigua and Barbuda",
        "tj_country_code": "AG",
        "report_requirement": "N",
        "report_requirement_val": "0",
        "initial_reporting_year": "--"
      }
    ],
    "total": 240
  }
}

Export

The export endpoint uses the same filters as this Dataset query.

POSThttps://b-api.lbkrs.com/v1/datasets/report_crs_tax_jurisdictions/download

report.crs_data

Export options Export records Download result