Sample - Plaid API
GET/fdx/recipient/{recipientId}

Get recipient metadata

Retrieves metadata for a single FDX recipient application identified by recipientId. Use the recipient identifier returned by /fdx/recipients; when the lookup occurs during an active OAuth flow, provide OAUTH-STATE-ID to help correlate the request in logs.

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

2 parameters
recipientIdstringrequired
The recipient application's UUID, as returned by `/fdx/recipients`.
OAUTH-STATE-IDstringoptional
The OAuth `state` value to help correlate the lookup with an active OAuth flow; omit it when no OAuth flow is active.

2 status codes
200Returns recipient metadata containing the required `recipient_id`, `client_name`, and `third_party_legal_name` fields, with an optional `logo_uri`.
recipient_idstringrequired
The recipient's (application's) identifier
client_namestringrequired
The recipient's (application's) name, as displayed to your customers during the consent flow
logo_uristringoptional
URL for the recipient's (application's) logo
third_party_legal_namestringrequired
The recipient's (application's) legal entity name
defaultReturns an error object containing an `error_type`, `error_code`, `error_message`, and `display_message`; use `error_code` and `error_type` to identify and handle the error.
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

recipientId must be a UUID identifying the recipient application. If the lookup occurs during an active OAuth flow, pass the OAuth state value in OAUTH-STATE-ID.