Sample - Plaid API
POST/identity/match/list

List Identity Match attempts

Lists Link-originated Identity Match attempts for a client in chronological order, with the oldest attempt first. Use start_time and end_time to define the inclusive RFC 3339 query window, and use cursor to continue through additional pages. Results are retained for up to one year and omit attempts for deleted Items.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

6 body fields

Request defining the inclusive time window and pagination settings for Link-originated Identity Match attempts.

client_idstringoptional
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.
secretstringoptional
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_timestringrequired
Inclusive start of the query window in RFC 3339 format.
end_timestringrequired
Inclusive end of the query window in RFC 3339 format.
countintegeroptional
Maximum number of attempts to return in one page.
Default:25
cursorstringoptional
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`.

2 status codes
200Returns a page of Identity Match attempts ordered from oldest to newest, together with `next_cursor`, `has_more`, and a unique `request_id`.
identity_match_attemptsarray<object>required
Page of Link-originated Identity Match attempts ordered by creation time, oldest first.
next_cursorstringrequired
Cursor for the next page. Null when there are no more pages.
has_morebooleanrequired
Whether more attempts remain in the query window.
request_idstringrequired
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
defaultReturned when the request cannot be processed; the error object identifies the `error_type`, `error_code`, `error_message`, and `display_message`.
error_typestringrequired
A broad categorization of the error. Safe for programmatic use.
Allowed:INVALID_REQUESTINVALID_RESULTINVALID_INPUTINSTITUTION_ERRORRATE_LIMIT_EXCEEDEDAPI_ERRORITEM_ERRORASSET_REPORT_ERRORBASE_REPORT_ERRORRECAPTCHA_ERROROAUTH_ERRORPAYMENT_ERROR
error_codestringrequired
The particular error code. Safe for programmatic use.
error_code_reasonstringoptional
The specific reason for the error code. Currently, reasons are only supported for OAuth-based item errors; `null` will be returned otherwise. Safe for programmatic use. Possible values: `OAUTH_INVALID_TOKEN`: The user's OAuth connection to this institution has been invalidated. `OAUTH_CONSENT_EXPIRED`: The user's access consent for this OAuth connection to this institution has expired. `OAUTH_USER_REVOKED`: The user's OAuth connection to this institution is invalid because the user revoked their connection.
error_messagestringrequired
A developer-friendly representation of the error code. This may change over time and is not safe for programmatic use.
display_messagestringrequired
A user-friendly representation of the error code. `null` if the error is not related to user action. This may change over time and is not safe for programmatic use.
request_idstringoptional
A unique ID identifying the request, to be used for troubleshooting purposes. This field will be omitted in errors provided by webhooks.
causesarrayoptional
In this product, a request can pertain to more than one Item. If an error is returned for such a request, `causes` will return an array of errors containing a breakdown of these errors on the individual Item level, if any can be identified. `causes` will be provided for the `error_type` `ASSET_REPORT_ERROR` or `CHECK_REPORT_ERROR`. `causes` will also not be populated inside an error nested within a `warning` object.
statusintegeroptional
The HTTP status code associated with the error. This will only be returned in the response body when the error information is provided via a webhook.
documentation_urlstringoptional
The URL of a Plaid documentation page with more information about the error
suggested_actionstringoptional
Suggested steps for resolving the error
required_account_subtypesarray<string>optional
A list of the account subtypes that were requested via the `account_filters` parameter in `/link/token/create`. Currently only populated for `NO_ACCOUNTS` errors from Items with `investments_auth` as an enabled product.
provided_account_subtypesarray<string>optional
A list of the account subtypes that were extracted but did not match the requested subtypes via the `account_filters` parameter in `/link/token/create`. Currently only populated for `NO_ACCOUNTS` errors from Items with `investments_auth` as an enabled product.

Error handling

start_time and end_time are required and must be RFC 3339 date-time strings defining the query window. count must be between 1 and 25 and defaults to 25 when omitted; for subsequent pages, pass the returned next_cursor in cursor while keeping the same time range.