Creates a new end customer for a Plaid reseller.
POST /partner/customer/create
The /partner/customer/create endpoint is used by reseller partners to create end customers. To create end customers, it should be called in the Production environment only, even when creating Sandbox API keys. If called in the Sandbox environment, it will return a sample response, but no customer will be created and the API keys will not be valid.
Request Body
Required
Request schema for /partner/customer/create.
Parameters
client_id
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
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.
company_name
The company name of the end customer being created. This will be used to display the end customer in the Plaid Dashboard. It will not be shown to end users.
is_diligence_attested
Denotes whether or not the partner has completed attestation of diligence for the end customer to be created.
products
The products to be enabled for the end customer. If empty or
null, this field will default to the products enabled for the reseller at the time this endpoint is called.
create_link_customization
If
true, the end customer’s default Link customization will be set to match the partner’s. You can always change the end customer’s Link customization in the Plaid Dashboard. See the Link Customization docs for more information. If you require the ability to programmatically create end customers using multiple different Link customization profiles, contact your Plaid Account Manager for assistance.
Important: Data Transparency Messaging (DTM) use cases will not be copied to the end customer’s Link customization unless the Publish changes button is clicked after the use cases are applied. Link will not work in Production unless the end customer’s DTM use cases are configured. For more details, see Data Transparency Messaging.
logo
Base64-encoded representation of the end customer’s logo. Must be a PNG of size 1024x1024 under 4MB. The logo will be shared with financial institutions and shown to the end user during Link flows. A logo is required if
create_link_customization is true. If create_link_customization is false and the logo is omitted, the partner’s logo will be used if one exists, otherwise a stock logo will be used.
legal_entity_name
The end customer’s legal name. This will be shared with financial institutions as part of the OAuth registration process. It will not be shown to end users.
website
The end customer’s website.
application_name
The name of the end customer’s application. This will be shown to end users when they go through the Plaid Link flow. The application name must be unique and cannot match the name of another application already registered with Plaid.
technical_contact
The technical contact for the end customer. Defaults to partner’s technical contact if omitted.
given_name
family_name
email
billing_contact
The billing contact for the end customer. Defaults to partner’s billing contact if omitted.
given_name
family_name
email
customer_support_info
This information is public. Users of your app will see this information when managing connections between your app and their bank accounts in Plaid Portal. Defaults to partner’s customer support info if omitted. This field is mandatory for partners whose Plaid accounts were created after November 26, 2024 and will be mandatory for all partners by the 1033 compliance deadline.
email
This field is mandatory for partners whose Plaid accounts were created after November 26, 2024 and will be mandatory for all partners by the 1033 compliance deadline.
phone_number
contact_url
link_update_url
address
The end customer’s address.
city
street
region
postal_code
country_code
ISO-3166-1 alpha-2 country code standard.
is_bank_addendum_completed
Denotes whether the partner has forwarded the Plaid bank addendum to the end customer.
assets_under_management
Assets under management for the given end customer. Required for end customers with monthly service commitments.
amount
iso_currency_code
redirect_uris
A list of URIs indicating the destination(s) where a user can be forwarded after completing the Link flow; used to support OAuth authentication flows when launching Link in the browser or another app. URIs should not contain any query parameters. When used in Production, URIs must use https. To specify any subdomain, use
* as a wildcard character, e.g. https://*.example.com/oauth.html. To modify redirect URIs for an end customer after creating them, go to the end customer’s API page in the Dashboard.
registration_number
The unique identifier assigned to a financial institution by regulatory authorities, if applicable. For banks, this is the FDIC Certificate Number. For credit unions, this is the Credit Union Charter Number.
Response
Response schema for /partner/customer/create.
Response Properties
end_customer
The details for the newly created end customer, including secrets for Sandbox and Limited Production.
request_id
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.