CRS Data Query · Whale Docs

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

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

filtersobject

Filters

Child attributes

filters.return_yearstring

Return Year. Values are dynamically queried from report_crs_return_year (not fixed); fetch them live via GET /v1/datasets/refs/crs_return_year.

filters.message_typestring

Message Type. Options: CRS701 = New [CRS701]; CRS702 = Corrections[CRS702]

CRS701CRS702

filters.aeoi_idstring

Aeoi Id. Values are dynamically queried from report_crs_aeoi_id (not fixed); fetch them live via GET /v1/datasets/refs/crs_aeoi_id.

filters.account_nostring

Account Number

filters.batchstring

Batch. Values are dynamically queried from report_crs_batch (not fixed); fetch them live via GET /v1/datasets/refs/crs_batch.

filters.client_typestring

Client Type. Options: P = Person; O = Organization

PO

filters.doc_typestring

Doc Type. Options: OECD1 = New Data [OECD1]; OECD2 = Corrected Data [OECD2]; OECD3 = Deletion of Data [OECD3]

OECD1OECD2OECD3

filters.messagestring

Message Number. Values are dynamically queried from report_crs_message (not fixed); fetch them live via GET /v1/datasets/refs/crs_message_id.

filters.account_statestring

Account Status. Multi-select; submit as a comma-joined string. Allowed values are listed under enum.. Options: -1 = Closed; 0 = Unactive; 1 = Active; 99 = Suspend; 4 = Suspended; 5 = Dormant

-1019945

pageinteger

Page

page_sizeinteger

Page Size

orderByarray<object>

Order By

Responses

HTTP 200Paginated list result.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

List

totalintegerrequired

Total

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,
  "orderBy": []
}'

Response

{
  "code": 0,
  "message": null,
  "data": {
    "list": [
      {
        "id": "<string>",
        "return_year": "<string>",
        "batch": "<string>",
        "doc_type": "<string>",
        "aeoi_id": "<string>",
        "message": "<string>",
        "message_type": "<string>",
        "account_batch": "<string>",
        "account_no": "<string>",
        "client_type": "<string>",
        "entity_type": "<string>",
        "tax_id": "<string>",
        "tax_country": "<string>",
        "last_name": "<string>",
        "first_name": "<string>",
        "region": "<string>",
        "address": "<string>",
        "birth_date": "<string>",
        "total_asset": "<string>",
        "currency": "<string>",
        "account_state": "<string>",
        "payment_type1": "<string>",
        "payment_amount1": "<string>",
        "payment_type2": "<string>",
        "payment_amount2": "<string>",
        "payment_type3": "<string>",
        "payment_amount3": "<string>",
        "payment_type4": "<string>",
        "payment_amount4": "<string>",
        "status": "<string>",
        "lock": "<string>"
      }
    ],
    "total": 0
  }
}