plaid

Get Recipient

Changed on

Returns metadata for a single recipient (application), identified by recipientId.

get/fdx/recipient/{recipientId}

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/fdx/recipient/{recipientId}
  • Auth
    API key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version

Path parameters

recipientIdstring required

The recipient's (application's) identifier (a UUID), as returned by /fdx/recipients.

Headers

OAUTH-STATE-IDstring

Optional. If this lookup happens during an active OAuth flow, pass the value of the OAuth state parameter to help Plaid correlate this request in logs.

Response

OK

recipient_idstring required

The recipient's (application's) identifier

client_namestring required

The recipient's (application's) name, as displayed to your customers during the consent flow

logo_uristring nullable

URL for the recipient's (application's) logo

third_party_legal_namestring required

The recipient's (application's) legal entity name

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_REPORT_ERROR enum value to the response property for the response status

  • a1bbca018160Revision changes
    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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