POST /transfer/diligence/document/upload
Third-party sender customers can use /transfer/diligence/document/upload endpoint to upload a document on behalf of its end customer (i.e. originator) to Plaid. You’ll need to send a request of type multipart/form-data.
You must provide the client_id in the PLAID-CLIENT-ID header and secret in the PLAID-SECRET header.
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 |
|---|---|---|---|
purpose |
String | Yes |
Specifies the purpose of the uploaded file.
Valid values:
|
file |
String | Yes |
A file to upload. The file size must be less than 20MB. Supported file extensions: .pdf. |
originator_client_id |
String | Yes |
The Client ID of the originator whose document that you want to upload. |
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.