POST /transfer/diligence/submit
Use the /transfer/diligence/submit endpoint to submit transfer diligence on behalf of the originator (i.e., the end customer).
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  | 
| secret | String | No | Your Plaid API  | 
| originator_diligence | Object | Yes | The diligence information for the originator. | 
| originator_diligence.funding_account | Object | Yes | The originator's funding account, linked with Plaid Link or  | 
| originator_diligence.funding_account.account_id | String | Yes | The Plaid  | 
| originator_diligence.funding_account.access_token | String | Yes | The access token associated with the Item data is being requested for. | 
| originator_diligence.tax_id | String | Yes | The tax ID of the originator. | 
| originator_diligence.dba | String | Yes | The business name of the originator. | 
| originator_diligence.website | String | Yes | The website of the originator. | 
| originator_diligence.debit_usage_configuration | Object | No | Specifies the originator's expected usage of debits. For all dollar amounts, use a decimal string with two digits of precision e.g. "10.00". This field is required if the originator is expected to process debit transfers. | 
| originator_diligence.debit_usage_configuration.expected_monthly_amount | String | Yes | The originator’s monthly expected ACH debit processing amount for the next 6-12 months. | 
| originator_diligence.debit_usage_configuration.expected_highest_amount | String | Yes | The originator’s expected highest amount for a single debit transfer. | 
| originator_diligence.debit_usage_configuration.sec_codes[] | Array | Yes | Specifies the expected use cases for the originator’s debit transfers. This should be a list that contains one or more of the following codes: 
 
 
 
 | 
| originator_diligence.debit_usage_configuration.expected_frequency | String | Yes | The originator's expected transfer frequency. Valid values: 
 | 
| originator_diligence.debit_usage_configuration.expected_average_amount | String | Yes | The originator’s expected average amount per debit. | 
| originator_diligence.naics_code | String | Yes | The NAICS code of the originator. | 
| originator_diligence.address | Object | Yes | The originator's address. | 
| originator_diligence.address.region | String | Yes | The two-letter code for the state or province (e.g., "CA"). | 
| originator_diligence.address.postal_code | String | Yes | The postal code (e.g., "94103"). | 
| originator_diligence.address.country_code | String | Yes | ISO-3166-1 alpha-2 country code standard. | 
| originator_diligence.address.street | String | Yes | The full street address. | 
| originator_diligence.address.city | String | Yes | The full city name. | 
| originator_diligence.credit_usage_configuration | Object | No | Specifies the originator's expected usage of credits. For all dollar amounts, use a decimal string with two digits of precision e.g. "10.00". This field is required if the originator is expected to process credit transfers. | 
| originator_diligence.credit_usage_configuration.expected_monthly_amount | String | Yes | The originator’s monthly expected ACH credit processing amount for the next 6-12 months. | 
| originator_diligence.credit_usage_configuration.expected_highest_amount | String | Yes | The originator’s expected highest amount for a single credit transfer. | 
| originator_diligence.credit_usage_configuration.sec_codes[] | Array | Yes | Specifies the expected use cases for the originator’s credit transfers. This should be a list that contains one or more of the following codes: 
 
 
 | 
| originator_diligence.credit_usage_configuration.expected_frequency | String | Yes | The originator's expected transfer frequency. Valid values: 
 | 
| originator_diligence.credit_usage_configuration.expected_average_amount | String | Yes | The originator’s expected average amount per credit. | 
| originator_client_id | String | Yes | Client ID of the the originator whose diligence that you want to submit. | 
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.