Skip to main content

List Client Tracking History

GET 
/v1/reports/client-activity/:client_id

Returns the paginated tracking history (timeline) of events registered for the client, used to build the client onboarding/KYC timeline.

Request​

Path Parameters

    client_id stringrequired

    Unique identifier (UUID) of the client.

Query Parameters

    page_state string

    Previous page state.

    page_size number

    Page size.

Header Parameters

    x-wallet-uuid string

    Sender Wallet UUID (if empty, your default Wallet UUID will be settled)

    nonce stringrequired

    The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.

    x-product-uuid string

    UUID (v4) of the product that the request should use. Send it explicitly when the authenticated user has more than one product or when the integration must select a specific product. If omitted and the endpoint does not require it, the API uses the authenticated user's default product.

    x-product-target-user-uuid string

    UUID (v4) of the user on whose behalf the request should run within the selected product. If omitted, the request runs as the authenticated user. Requires x-product-uuid.

    x-lang string

    Possible values: [pt-BR, en-US]

    Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.

Responses​

Client tracking history returned successfully.

Schema
    data object[]required

    Client tracking history data.

  • Array [
    • id stringrequired

    Tracking event ID.

    event_id stringrequired

    Source event ID (from the originating system).

    source stringrequired

    Event source system.

    event_type stringrequired

    Event type.

    status stringrequired

    Event status.

    reference_id string

    Reference ID.

    event_created_at date-timerequired

    Event creation date at the originating system.

    metadata object

    Additional event metadata.

  • ]
    • has_next_page booleanrequired

    Has next page.

    page_state string

    Page state.

Loading...