Create a document for a client's beneficial owner
POST https://api-sandbox.dwolla.com/beneficial-owners/{{beneficialOwnerId}}
Create a document for a Client Account's Beneficial owner pending verification by uploading a color scan or photo of government issued identification (see below for acceptable document types). This requires a multipart form-data POST request. The uploaded file must be a color image, in a .jpg, .jpeg, or .png format, and less than 10MB in size.
Request parameters
| Form field | Description |
|---|
| file | File contents. |
| documentType | Acceptable values of: passport, license, or idCard. |
HTTP status and error codes
| HTTP Status | Code | Message | Description |
|---|
| 201 | Created | Success | A document resource was created. |
| 400 | BadFile | There was an error with the provided file. | Check file and try again. |
| 400 | InvalidFileType | Invalid file type. | File types supported: Personal IDs - .jpg, .jpeg or .png. |
| 400 | MaxNumberOfResources | Only 4 documents can be uploaded when verifying a customer. | Max of four files upload allowed. Please wait for Dwolla to manually check the documents |
| 400 | DuplicateResource | Document already exists. | Document already exists. Follow the link to find the existing document for the Beneficial owner. |
| 403 | InvalidResourceState | Resource cannot be modified. | Document creation not allowed for already verified Beneficial owner. |
| 404 | NotFound | The requested resource was not found. | Beneficial owner not found. Check Beneficial owner Id. |
| 413 | FileTooLarge | The provided document is too large. 10MB is the maximum file size allowed. | Document requests are limited to 10 MiB. |
Request Body
[{"name"=>"file", "value"=>nil, "datatype"=>"null"}, {"name"=>"documentType", "value"=>"passport", "datatype"=>"string"}]
| Key | Datatype | Required | Description |
|---|
Accept | string | | |
Content-Type | string | | |
Cache-Control | string | | |
Authorization | string | | |