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.

Servers

https://production.plaid.com
https://sandbox.plaid.com

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`is_bank_addendum_completed`	Boolean	Yes	Denotes whether the partner has forwarded the Plaid bank addendum to the end customer.
`client_id`	String	No	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.
`application_name`	String	Yes	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.
`website`	String	Yes	The end customer's website.
`legal_entity_name`	String	Yes	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.
`billing_contact`	Object	No	The billing contact for the end customer. Defaults to partner's billing contact if omitted.
`billing_contact.family_name`	String	No
`billing_contact.given_name`	String	No
`billing_contact.email`	String	No
`registration_number`	String	No	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.
`customer_support_info`	Object	No	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.
`customer_support_info.contact_url`	String	No
`customer_support_info.email`	String	No
`customer_support_info.link_update_url`	String	No
`customer_support_info.phone_number`	String	No
`assets_under_management`	Object	No	Assets under management for the given end customer. Required for end customers with monthly service commitments.
`assets_under_management.amount`	Number	Yes
`assets_under_management.iso_currency_code`	String	Yes
`products[]`	Array	No	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.
`logo`	String	No	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.
`is_diligence_attested`	Boolean	Yes	Denotes whether or not the partner has completed attestation of diligence for the end customer to be created.
`company_name`	String	Yes	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.
`create_link_customization`	Boolean	No	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.
`secret`	String	No	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.
`technical_contact`	Object	No	The technical contact for the end customer. Defaults to partner's technical contact if omitted.
`technical_contact.family_name`	String	No
`technical_contact.given_name`	String	No
`technical_contact.email`	String	No
`address`	Object	Yes	The end customer's address.
`address.region`	String	No
`address.postal_code`	String	No
`address.country_code`	String	No	ISO-3166-1 alpha-2 country code standard.
`address.street`	String	No
`address.city`	String	No
`redirect_uris[]`	Array	No	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.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.