LElemon
Accounts: General

Get Account Checks

Changed on
get/accounts/{account_id}/checks

Request

Path parameters

account_idstring required

An account identifier.

Query parameters

cursorstring

A pagination cursor. When you receive a paginated response containing the property pagination.next_cursor, you can pass its value here to get the next page of results for your query. A cursor will include filter parameters, so there is not need to specify both the cursor and any other filter parameter.

limitinteger

In order to customize the number of elements returned, you can provide a limit here. The service will not return more elements than specified.

category'onboarding' | 'post_onboarding' | 'offboarding'

Filter checks by category. Use offboarding to retrieve the outstanding actions blocking account closure.

Headers

LMG-Data-Privacy-Access-Principalstring required
LMG-Data-Privacy-Access-Justificationstring required

Response

Successful Response

Example response

{
  "data": [
    {
      "history": [
        {
          "timestamp": "2023-06-23T07:29:55.465000+00:00"
        }
      ]
    }
  ],
  "pagination": {
    "next_cursor": "<opaque-data>"
  }
}

Changes

  • 1f1df208c0e4Revision changes
    • warning

      added the new cash_balance enum value to the // response property for the response status

    • warning

      added the new offboarding enum value to the // response property for the response status

    • warning

      added the new overdue_fees enum value to the // response property for the response status

    • warning

      added the new positions enum value to the // response property for the response status

    • info

      added the new optional query request parameter category