Sign in
plaid

(Deprecated) List a Beacon User's history

List all changes to the Beacon User in reverse-chronological order.

post/beacon/user/history/list

Request body

beacon_user_idstring required

ID of the associated Beacon User.

cursorstring nullable

An identifier that determines which page of results you receive.

client_idstring

Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.

secretstring

Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.

Example request

{
  "beacon_user_id": "becusr_42cF1MNo42r9Xj",
  "cursor": "eyJkaXJlY3Rpb24iOiJuZXh0Iiwib2Zmc2V0IjoiMTU5NDM"
}

Response

OK

next_cursorstring nullable required

An identifier that determines which page of results you receive.

request_idstring required

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Example response

{
  "beacon_users": [
    {
      "item_ids": [
        "515cd85321d3649aecddc015"
      ],
      "id": "becusr_42cF1MNo42r9Xj",
      "version": 1,
      "created_at": "2020-07-24T03:26:02Z",
      "updated_at": "2020-07-24T03:26:02Z",
      "status": "cleared",
      "program_id": "becprg_11111111111111",
      "client_user_id": "your-db-id-3b24110",
      "user": {
        "date_of_birth": "1990-05-29",
        "name": {
          "given_name": "Leslie",
          "family_name": "Knope"
        },
        "address": {
          "street": "123 Main St.",
          "street2": "Unit 42",
          "city": "Pawnee",
          "region": "IN",
          "postal_code": "46001",
          "country": "US"
        },
        "email_address": "user@example.com",
        "phone_number": "+19876543212",
        "id_number": {
          "value": "123456789",
          "type": "us_ssn"
        },
        "ip_address": "192.0.2.42",
        "depository_accounts": [
          {
            "account_mask": "4000",
            "routing_number": "021000021",
            "added_at": "2020-07-24T03:26:02Z"
          }
        ]
      },
      "audit_trail": {
        "dashboard_user_id": "54350110fedcbaf01234ffee",
        "timestamp": "2020-07-24T03:26:02Z"
      }
    }
  ],
  "next_cursor": "eyJkaXJlY3Rpb24iOiJuZXh0Iiwib2Zmc2V0IjoiMTU5NDM"
}

Changes

Changed in 6 of the 52 revisions of this API.314

  • 94406d9a4d271See the full diff
    • ○

      endpoint deprecated

      endpoint-deprecated

  • 80d23bfdc2e51See the full diff
    • ●

      added the new in_epic enum value to the beacon_users/items/user/id_number/type response property for the response status 200

      response-property-enum-value-added

  • a2c34406c3171See the full diff
    • ○

      added the required property beacon_users/items/user/depository_accounts to the response with the 200 status

      response-required-property-added

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • be701ec9316121See the full diff
    • ▲

      the beacon_users/items/client_user_id response property's minLength was decreased from 1 to 0 for the response status 200

      response-property-min-length-decreased

    • ▲

      the beacon_users/items/user/address/country response property's minLength was decreased from 2 to 0 for the response status 200

      response-property-min-length-decreased

    • ○

      added the required property beacon_users/items/item_ids to the response with the 200 status

      response-required-property-added

  • ec7541420dd21See the full diff
    • ○

      endpoint added

      endpoint-added

  • 5de70cc1e6ca1See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 699 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog