API Reference
Start typing to search…

GET All Client CRSReportable records

get https://example.com/client/web/Clients//CRSReportable

Query all available CRSReportable records for the target client.

Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

Enter a valid ClientNumber.

Query Params
string

Different methods for determining the index of the first record, in the first page. Rowid returns the index of the first record in the returned page. Offset returns the index of a record in the first page offset by this value. Available options for pagination are -

  • Rowid (default)
  • Offset
string

Pointer to a page to start returning data from; must have been returned as part of next_url in a previous request.

int64

The zero-based index value of the first record to return from a collection. A value of zero specifies the index of the first record in the collection. Values greater than zero specify a record index in the collection equal to page_offset + 1.

int32
≥ 1

Maximum number of resources to return, for any particular page, in the response; must be a positive, non-zero integer.

Responses

Response body
object
data
array of objects
data
object
string

The Foreign Tax Identification Number (FTIN) of the client.

date | null

The Expiry Date of the Common Reporting Standard.

string

The Reason Code if no Foreign Tax Identification Number (FTIN) is provided. Field values are accessed through the Client Management specification endpoint GET /System/CRSReasonCodes.

string

The Country of Residence for the Common Reporting Standard. Field values are accessed through the System Administration specification endpoint GET /System/Countries.

date

The Effective Date of residence for the Common Reporting Standard country.

int64

The unique Client identifier. Field values are accessed through the Client Management specification endpoint GET /Clients/Profile.

page_info
object

In addition to the data returned by an API, page_info will be included if that response data has been paged.
The purpose of this object is to provide information about the page that is included in this response,
as well as information that will help build the next request.

int32

Number of entries included in the page of data returned in this response.

string

Identifies the starting row for the next page and should be included in the page_start_id query
parameter in the next request.
This information is also included in the next_url property as a convenience.

int64

The number of records to skip in the next page. This value must be included in the page_offset
query parameter in the next request and is included in the next_url property as a convenience.
This value is not included in the last page returned.

string

Relative URL that can be used to obtain the next page of data.
If the current response is the last page in the dataset, this property will not be included.
To retrieve the next appropriate page, a subsequent request should include the same query
parameters that were used for data filtering (if any); though they will also be present in
this 'next_url' value.

401

User is not authorized for this operation

403

User does not have the authority to perform the requested action

500

An error occurred on the backend server

Updated about 2 months ago

Did this page help you?
Language
Credentials
OAuth2
Authenticate

Updated about 2 months ago

Did this page help you?