CRS Data Query · Whale Docs

POSThttps://b-api.longbridge.xyz/v1/datasets/report_crs_records

Dataset endpoints are available on the Test host only (https://b-api.longbridge.xyz); the Production host returns 404.

Authorization

AuthorizationstringheaderRequired

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

Permission

report.crs_data

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

Request body application/json

filtersobject

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

Child attributes

return_yearstring

Filters results by Return Year.

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

message_typestring

Filters results by Message Type.

CRS701 · New [CRS701]CRS702 · Corrections[CRS702]

aeoi_idstring

Filters results by Aeoi Id.

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

account_nostring

Filters results by Account Number.

batchstring

Filters results by Batch.

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

client_typestring

Filters results by Client Type.

P · PersonO · Organization

doc_typestring

Filters results by Doc Type.

OECD1 · New Data [OECD1]OECD2 · Corrected Data [OECD2]OECD3 · Deletion of Data [OECD3]

messagestring

Filters results by Message Number.

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

account_statestring

Filters results by Account Status.

Multiple values are supported. Join them with commas (,). Omit the field to disable this filter.

-1 · Closed0 · Unactive1 · Active99 · Suspend4 · Suspended5 · Dormant

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated CRS Data 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

Returned value: Unique identifier of the current record.

return_yearstring

Returned value: Return Year.

batchstring

Returned value: Batch.

doc_typestring

Returned value: Doc Type.

doc_type_valstring

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

aeoi_idstring

Returned value: Aeoi Id.

messagestring

Returned value: Message Number.

message_typestring

Returned value: Message Type.

message_type_valstring

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

account_batchstring

Returned value: Account Batch.

account_nostring

Returned value: Account Number.

client_typestring

Returned value: Client Type.

client_type_valstring

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

entity_typestring

Returned value: Entity Type.

entity_type_valstring

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

tax_idstring

Returned value: TAX ID.

tax_countrystring

Returned value: Tax Country.

last_namestring

Returned value: Last Name.

first_namestring

Returned value: First Name.

regionstring

Returned value: Country Code.

addressstring

Returned value: Address.

birth_datestring

Returned value: Birth Date. The date or time format follows the value returned by the API.

total_assetstring

Returned value: Total Asset.

currencystring

Returned value: Currency.

account_statestring

Returned value: Account Status.

account_state_valstring

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

payment_type1string

Returned value: Payment Type1.

payment_amount1string

Returned value: Payment Amount1.

payment_type2string

Returned value: Payment Type2.

payment_amount2string

Returned value: Payment Amount2.

payment_type3string

Returned value: Payment Type3.

payment_amount3string

Returned value: Payment Amount3.

payment_type4string

Returned value: Payment Type4.

payment_amount4string

Returned value: Payment Amount4.

statusstring

Returned value: Status.

status_valstring

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

lockstring

Returned value: Lock Status.

lock_valstring

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

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.longbridge.xyz/v1/datasets/report_crs_records' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "41435209",
        "return_year": "2025",
        "batch": "7",
        "doc_type": "New Data [OECD1]",
        "doc_type_val": "OECD1",
        "aeoi_id": "TT60994",
        "message": "2025TT609942026062608421307",
        "message_type": "New [CRS701]",
        "message_type_val": "CRS701",
        "account_batch": "1",
        "account_no": "****0000",
        "client_type": "Person",
        "client_type_val": "P",
        "entity_type": "Reportable Person",
        "entity_type_val": "person_reportable",
        "tax_id": "123456789",
        "tax_country": "CN",
        "last_name": "NFN",
        "first_name": "",
        "region": "HK",
        "address": "示例地址 Example Address",
        "birth_date": "1959-07-19",
        "total_asset": "0.00",
        "currency": "HKD",
        "account_state": "Suspend",
        "account_state_val": "99",
        "payment_type1": "CRS501",
        "payment_amount1": "0.00",
        "payment_type2": "CRS502",
        "payment_amount2": "0.00",
        "payment_type3": "CRS503",
        "payment_amount3": "0.00",
        "payment_type4": "CRS504",
        "payment_amount4": "0.00",
        "status": "Data Generation",
        "status_val": "1",
        "lock": "Unlocked",
        "lock_val": "0"
      }
    ],
    "total": 4952985
  }
}

Export

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

POSThttps://b-api.longbridge.xyz/v1/datasets/report_crs_records/download

report.crs_data

Export options Export records Download result