POST /beta/partner/customer/v1/update

The /beta/partner/customer/v1/update endpoint updates an existing end customer record.

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
`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.
`end_customer_client_id`	String	Yes
`questionnaires`	Object	No	The questionnaires for the end customer.
`questionnaires.cra`	Object	No	The CRA questionnaire for the end customer.
`questionnaires.cra.is_third_party_involved`	Boolean	No	Denotes whether the third party is involved.
`questionnaires.cra.purposes`	Object	No	A map of permissible purposes to their corresponding use cases.
`questionnaires.cra.purposes.EMPLOYMENT`	Object	No	The list of use cases associated with a given permissible purpose.
`questionnaires.cra.purposes.EMPLOYMENT.use_cases[]`	Array	No	List of use cases for the given permissible purpose.
`questionnaires.cra.purposes.INSURANCE_UNDERWRITING`	Object	No	The list of use cases associated with a given permissible purpose.
`questionnaires.cra.purposes.INSURANCE_UNDERWRITING.use_cases[]`	Array	No	List of use cases for the given permissible purpose.
`questionnaires.cra.purposes.WRITTEN_INSTRUCTION`	Object	No	The list of use cases associated with a given permissible purpose.
`questionnaires.cra.purposes.WRITTEN_INSTRUCTION.use_cases[]`	Array	No	List of use cases for the given permissible purpose.
`questionnaires.cra.purposes.EXTENSION_OF_CREDIT_OR_ACCOUNT_REVIEW`	Object	No	The list of use cases associated with a given permissible purpose.
`questionnaires.cra.purposes.EXTENSION_OF_CREDIT_OR_ACCOUNT_REVIEW.use_cases[]`	Array	No	List of use cases for the given permissible purpose.
`questionnaires.cra.purposes.LICENSE_ELIGIBILITY`	Object	No	The list of use cases associated with a given permissible purpose.
`questionnaires.cra.purposes.LICENSE_ELIGIBILITY.use_cases[]`	Array	No	List of use cases for the given permissible purpose.
`questionnaires.cra.purposes.BUSINESS_NEED_ACCOUNT_REVIEW`	Object	No	The list of use cases associated with a given permissible purpose.
`questionnaires.cra.purposes.BUSINESS_NEED_ACCOUNT_REVIEW.use_cases[]`	Array	No	List of use cases for the given permissible purpose.
`questionnaires.cra.purposes.BUSINESS_NEED_TRANSACTION`	Object	No	The list of use cases associated with a given permissible purpose.
`questionnaires.cra.purposes.BUSINESS_NEED_TRANSACTION.use_cases[]`	Array	No	List of use cases for the given permissible purpose.
`questionnaires.cra.purposes.RISK_ASSESSMENT`	Object	No	The list of use cases associated with a given permissible purpose.
`questionnaires.cra.purposes.RISK_ASSESSMENT.use_cases[]`	Array	No	List of use cases for the given permissible purpose.
`questionnaires.cra.is_technical_service_provider_involved`	Boolean	No	Denotes whether the technical service provider is involved.
`legal_entity_name`	String	No
`bank_addendum_acceptance`	Object	No	The bank addendum acceptance for the end customer.
`bank_addendum_acceptance.customer_agreement_timestamp`	String	No	The timestamp of when the end customer accepted the bank addendum in ISO 8601 format (`YYYY-MM-DDTHH:mm:ssZ`).
`bank_addendum_acceptance.customer_accepted`	Boolean	No	Denotes whether the end customer has accepted the bank addendum terms.
`bank_addendum_acceptance.customer_ip_address`	String	No	The IP address of the end customer when they accepted the bank addendum.
`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.
`redirect_uris[]`	Array	No

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.