Returns a Plaid reseller's end customer.

POST /partner/customer/get

The /partner/customer/get endpoint is used by reseller partners to retrieve data about a single end customer.

Request Body

Required

Request schema for /partner/customer/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/get.

Response Properties

end_customer
object
The details for an end customer.
client_id
string
The client_id of the end customer.
company_name
string
The company name associated with the end customer.
status
string
The status of the given end customer. UNDER_REVIEW: The end customer has been created and enabled in Sandbox and Limited Production. The end customer must be manually reviewed by the Plaid team before it can be enabled in full production, at which point its status will automatically transition to PENDING_ENABLEMENT or DENIED. PENDING_ENABLEMENT: The end customer is ready to be fully enabled in the Production environment. Call the /partner/customer/enable endpoint to enable the end customer in full Production. ACTIVE: The end customer has been fully enabled in all environments. DENIED: The end customer has been created and enabled in Sandbox and Limited Production, but it did not pass review by the Plaid team and therefore cannot be enabled for full Production access. Talk to your Account Manager for more information.
request_id
string
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.