plaid

Enables a Plaid reseller's end customer in the Production environment.

Changed on

The /beta/partner/customer/v1/enable endpoint is used by reseller partners to enable an end customer in the full Production environment.

post/beta/partner/customer/v1/enable

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/beta/partner/customer/v1/enable
  • 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.

end_customer_client_idstring required
productsProducts[]

Response

OK

end_customer_client_idstring
status'UNDER_REVIEW' | 'PENDING_ENABLEMENT' | 'ACTIVE' | 'DENIED' | 'MORE_INFORMATION_NEEDED'

The status of the given end customer.

UNDER_REVIEW: The end customer has been created and enabled in the Sandbox environment. The end customer must be manually reviewed by the Plaid team before it can be enabled in 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 the Sandbox environment, but it did not pass review by the Plaid team and therefore cannot be enabled for Production access. Talk to your account manager for more information.

product_statusesPartnerEndCustomerProductStatuses

Mapping of product names to their current status.

production_secretstring
request_idstring

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

  • e536704a333fRevision changes
    • info

      added the new cra_home_lending enum value to the request property /