POST /transfer/platform/requirement/submit

The /transfer/platform/requirement/submit endpoint allows platforms to submit onboarding requirements for an originator as part of the Scaled Platform Transfer offering.

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.
`requirement_submissions[]`	Array	Yes	A list of requirement submissions that all relate to the originator. Must contain between 1 and 50 requirement submissions.
`requirement_submissions[].person_id`	String	No	The `person_id` of the person the requirement submission is related to. A `person_id` is returned by `/transfer/platform/person/create`. This field should not be included for requirements that are not related to a person.
`requirement_submissions[].value`	String	Yes	The value of the requirement, which can be a string or an object depending on the `requirement_type`. If it is an object, the object should be JSON marshaled into a string. See the documentation on this endpoint for more information and examples.
`requirement_submissions[].requirement_type`	String	Yes	The type of requirement being submitted
`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.
`originator_client_id`	String	Yes	The client ID of the originator

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.