plaid

List Link Identity Match attempts

Changed on

Returns a chronological history of Link-originated Identity Match attempts for a client, ordered by creation time with the oldest attempt first.

This endpoint requires separate enablement in addition to access to Identity Match. To request endpoint access, contact your account manager or submit a product access support ticket.

Results are retained for up to one year. Attempts marked as deleted are omitted.

post/identity/match/list

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/identity/match/list
  • Auth
    API key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version

Request body

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.

start_timestring date-time required

Inclusive start of the query window in RFC 3339 format. On the first request, this cannot be earlier than one calendar year before the current time.

end_timestring date-time required

Inclusive end of the query window in RFC 3339 format. Must be on or after start_time.

countinteger

Maximum number of attempts to return in one page.

cursorstring

Opaque pagination cursor. Omit on the first request. For subsequent requests, set this field to the next_cursor from the previous response and use the same start_time and end_time. You may change count between pages.

Response

OK

next_cursorstring nullable required

Cursor for the next page. Null when there are no more pages.

has_moreboolean required

Whether more attempts remain in the query window.

request_idstring required

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

Changes

  • ea443cd78f6fRevision changes
    • breaking

      the response property // became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • warning

      added the new CRA_PARTNER_INSIGHTS_ERROR enum value to the response property for the response status

    • warning

      added the new CRA_REPORT_ERROR enum value to the response property for the response status

  • e536704a333fRevision changes
    • info

      endpoint added