Returns OAuth-institution registration information for a given end customer.

POST /partner/customer/oauth_institutions/get

The /partner/customer/oauth_institutions/get endpoint is used by reseller partners to retrieve OAuth-institution registration information about a single end customer. To learn how to set up a webhook to listen to status update events, visit the reseller documentation.

Request Body

Required

Request schema for /partner/customer/oauth_institutions/get.

Parameters

client_id
string
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.
secret
string
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.
end_customer_client_id
required, string

Response

Response schema for /partner/customer/oauth_institutions/get.

Response Properties

flowdown_status
string
The status of the addendum to the Plaid MSA (“flowdown”) for the end customer.
questionnaire_status
string
The status of the end customer’s security questionnaire.
institutions
array[object]
The OAuth institutions with which the end customer’s application is being registered.
name
string
institution_id
string
environments
object
Registration statuses by environment.
development
string
The registration status for the end customer’s application.
production
string
The registration status for the end customer’s application.
production_enablement_date
string
The date on which the end customer’s application was approved by the institution, or an empty string if their application has not yet been approved.
classic_disablement_date
string
The date on which non-OAuth Item adds will no longer be supported for this institution, or an empty string if no such date has been set by the institution.
request_id
string
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.