plaid

Retrieve identity match score

Changed on

The /identity/match endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder's financial institution.

Fields within the balances object will always be null when retrieved by /identity/match. Instead, use the free /accounts/get endpoint to request balance cached data, or /accounts/balance/get or /signal/evaluate for real-time data.

post/identity/match

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/identity/match
  • 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.

access_tokenstring required

The access token associated with the Item for which data is being requested.

Response

OK

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
    • warning

      added the new CRA_PARTNER_INSIGHTS_ERROR enum value to the response property for the response 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

    • warning

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

    • info

      added the optional property /// to the response with the status

  • e07a869352e8Revision changes
    • info

      the request property /// became nullable

    • info

      added the optional property / to the response with the status

    • info

      removed the charge card enum value from the /// response property for the response status

    • info

      removed the installment enum value from the /// response property for the response status