POST /transfer/platform/originator/create

Use the /transfer/platform/originator/create endpoint to submit information about the originator you are onboarding, including the originator's agreement to the required legal terms.

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
`tos_acceptance_metadata`	Object	Yes	Metadata related to the acceptance of Terms of Service
`tos_acceptance_metadata.originator_ip_address`	String	Yes	The IP address of the originator when they accepted the TOS. Formatted as an IPv4 or IPv6 IP address
`tos_acceptance_metadata.agreement_accepted`	Boolean	Yes	Indicates whether the TOS agreement was accepted
`tos_acceptance_metadata.agreement_accepted_at`	String	Yes	ISO8601 timestamp indicating when the originator accepted the TOS
`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.
`webhook`	String	No	The webhook URL to which a `PLATFORM_ONBOARDING_UPDATE` webhook should be sent.
`originator_reviewed_at`	String	Yes	ISO8601 timestamp indicating the most recent time the platform collected onboarding data from the originator
`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.