POST /business_verification/create
Create a new business verification to check a business's identity and risk profile.
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 |
|---|---|---|---|
business |
Object | Yes |
Business information provided in the verification request |
business.name |
String | Yes |
The name of the business. Must have at least one character and a maximum length of 500 characters. |
business.email |
String | No |
A valid email address. Must not have leading or trailing spaces and address must be RFC compliant. For more information, see RFC 3696. |
business.website |
String | No |
An 'http' or 'https' URL (must begin with either of those). |
business.address |
Object | Yes |
Physical address of a business. Used for input requests. |
business.address.street2 |
String | No |
Extra street information, like an apartment or suite number. If provided, a string with at least one non-whitespace character, with a max length of 50 characters. |
business.address.region |
String | No |
A subdivision code. "Subdivision" is a generic term for "state", "province", "prefecture", "zone", etc. For the list of valid codes, see country subdivision codes. Country prefixes are omitted, since they are inferred from the |
business.address.postal_code |
String | No |
The postal code for the associated address. Between 2 and 10 alphanumeric characters. For US-based addresses this must be 5 numeric digits. |
business.address.country |
String | Yes |
Valid, capitalized, two-letter ISO code representing the country of this object. Must be in ISO 3166-1 alpha-2 form. |
business.address.street |
String | Yes |
The primary street portion of an address. If an address is provided, this field will always be filled. A string with at least one non-whitespace alphabetical character, with a max length of 80 characters. |
business.address.city |
String | Yes |
City from the address. A string with at least one non-whitespace alphabetical character, with a max length of 100 characters. |
business.phone_number |
String | No |
A phone number in E.164 format. |
client_id |
String | No |
Your Plaid API |
client_user_id |
String | Yes |
A unique ID that identifies the end user in your system. This ID can also be used to associate user-specific data from other Plaid products. Financial Account Matching requires this field and the |
secret |
String | No |
Your Plaid API |
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.