Skip to content

Commit

Permalink
change scan to colored captured image for document upload
Browse files Browse the repository at this point in the history
  • Loading branch information
spencerhunter committed May 3, 2024
1 parent 0f3ac15 commit 80d5169
Show file tree
Hide file tree
Showing 6 changed files with 28 additions and 16 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,13 @@ meta:

# Create a document for a beneficial owner

Create a document for a beneficial owner pending verification by uploading a photo of the document. This requires a multipart form-data POST request. The file must be either a `.jpg`, `.jpeg`, or `.png`, up to 10MB in size.
To verify an individual identity, please upload a clear, colored image captured with a camera of a government-issued identification document.

Here's what you need to know about uploading a document:

- Multipart Form-Data POST Request: You'll need to use a multipart form-data POST request to upload your document. This is a specific type of HTTP request used for file uploads.
- Supported File Formats: The uploaded file must be a color image in one of these formats: JPG, JPEG, or PNG.
- File Size Limit: The file size cannot exceed 10MB.

### HTTP request

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,25 @@ guide:
step: 1
meta:
title: "Create Document | Dwolla API Documentation"
description: Create a document for a Customer pending verification by uploading a color scan or photo of government issued identification.
description: Create a document for a Customer pending verification by uploading a color or photo of government issued identification.
---

# Create a document for a customer

Create a document for a Customer 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. Additionally, Business Documents can also be uploaded in a `.pdf` format.
To verify an individual or business identity, please upload a clear, colored image captured with a camera of a government-issued identification document. Reference the table below for the list of acceptable documents.

Here's what you need to know about uploading a document:

- Multipart Form-Data POST Request: You'll need to use a multipart form-data POST request to upload your document. This is a specific type of HTTP request used for file uploads.
- Supported File Formats: The uploaded file must be a color image in one of these formats: JPG, JPEG, or PNG. Business Documents in PDF format are accepted for verification purposes.
- File Size Limit: The file size cannot exceed 10MB.

### Acceptable documents

| Customer type | Acceptable documents |
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Personal Verified Customer | `passport`, `license`, or `idCard`. Must be a color scan of U.S. government-issued identification. Foreign passports will be rejected with [ForeignPassportNotAllowed](/guides/personal-verified-customer/handle-verification-statuses#document-failure) if uploaded for this customer type. |
| Business Verified Customer | Controller documents - `passport`, `license`, or `idCard`. <br /> <ul><li>If `license` or `idCard`, must be a color scan of U.S. government-issued identification.</li><li>If `passport`, U.S. as well as foreign passports are accepted for business Controllers and Beneficial Owners.</li></ul> Business documents - `other`. Refer to our guide on [Handling Document status for Business Verified Customers](https://developers.dwolla.com/guides/business-verified-customer/handle-verification-statuses#handling-document-status) for acceptable documents. |
| Customer type | Acceptable documents |
| -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Personal Verified Customer | `passport`, `license`, or `idCard`. Must be a colored camera captured image of a U.S. government-issued identification. Foreign passports will be rejected with [ForeignPassportNotAllowed](/guides/personal-verified-customer/handle-verification-statuses#document-failure) if uploaded for this customer type. |
| Business Verified Customer | Controller documents - `passport`, `license`, or `idCard`. <br /> <ul><li>If `license` or `idCard`, must be a colored camera captured image of a U.S. government-issued identification.</li><li>If `passport`, U.S. as well as foreign passports are accepted for business Controllers and Beneficial Owners.</li></ul> Business documents - `other`. Refer to our guide on [Handling Document status for Business Verified Customers](https://developers.dwolla.com/guides/business-verified-customer/handle-verification-statuses#handling-document-status) for acceptable documents. |

### HTTP request

Expand Down
2 changes: 1 addition & 1 deletion pages/docs/balance/api-reference/documents/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ For more information on handling the Customer verification status of `document`,
| Parameter | Description |
| -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id | Document unique identifier |
| type | Either `passport`, `license`, `idCard`, or `other`. Must be a color scan of US Government issued identification. <br /> Refer to the [acceptable documents](/api-reference/documents/create-document-for-customer#acceptable-documents) section for more information on what each type is used for. |
| type | Either `passport`, `license`, `idCard`, or `other`. Must be a colored camera captured image of a U.S. government issued identification. <br /> Refer to the [acceptable documents](/api-reference/documents/create-document-for-customer#acceptable-documents) section for more information on what each type is used for. |
| status | Either `pending` or `reviewed`. When a document has been manually reviewed by Dwolla, its status will be `reviewed`. A reviewed document does not necessarily indicate that the customer has completed the identity verification process. |
| documentVerificationStatus | The value of this field indicates the status of the document after being reviewed by Dwolla. Values can be either `pending`, `accepted`, or `rejected`. |
| created | ISO 8601 Timestamp of document upload time and date. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -432,7 +432,7 @@ Check the beneficial owner's status again. The beneficial owner will either be i

### Handling `document` status

If a beneficial owner is not verified after being placed in `incomplete` status and submitting a second verification attempt, the only other state the beneficial owner can be in is `document`. If the beneficial owner has a status of `document`, they will need to upload additional pieces of information in order to verify their identity. Use the [create a document](/api-reference/documents/create-document-for-beneficial-owner) endpoint when uploading a colored scan of the identifying document. The document(s) will then be reviewed by Dwolla; this review may take anywhere from a few seconds up to 1-2 business days if manual verification is required to approve or reject.
If a beneficial owner is not verified after being placed in `incomplete` status and submitting a second verification attempt, the only other state the beneficial owner can be in is `document`. If the beneficial owner has a status of `document`, they will need to upload additional pieces of information in order to verify their identity. Use the [create a document](/api-reference/documents/create-document-for-beneficial-owner) endpoint when uploading a colored camera captured image of the identifying document. The document(s) will then be reviewed by Dwolla; this review may take anywhere from a few seconds up to 1-2 business days if manual verification is required to approve or reject.

You can provide the following best practices to the Customer in order to reduce the chances of a document being rejected:

Expand All @@ -450,7 +450,7 @@ You can provide the following best practices to the Customer in order to reduce

#### US persons

A color scanned photo of the Beneficial Owner’s identifying document can be specified as documentType: `license` (state issued driver's license), or `idCard` (U.S. government-issued photo id card). Examples include:
A colored camera captured image of the Beneficial Owner’s identifying document can be specified as documentType: `license` (state issued driver's license), or `idCard` (U.S. government-issued photo id card). Examples include:

- Non-expired State Issued Driver’s License/Identification Card
- Non-expired US Passport
Expand All @@ -459,7 +459,7 @@ A color scanned photo of the Beneficial Owner’s identifying document can be sp

#### Non-US persons

A color scanned photo of the Beneficial Owner’s identifying document can be specified as documentType: `passport`. Examples include:
A colored camera captured image of the Beneficial Owner’s identifying document can be specified as documentType: `passport`. Examples include:

- Non-expired Foreign Passport _**Note:** Foreign Passports are only accepted when the individual does not have an ITIN or SSN and the user must alternatively enter the Passport number_.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -568,7 +568,7 @@ dwolla.post(customerUrl, requestBody).then(function (res) {

## Handling `document` status

If the Customer has a status of `document`, the Customer will need to upload additional pieces of information in order to verify the account. Use the [create a document](/api-reference/documents/create-document-for-customer) endpoint when uploading a colored scan of the identifying document. The document(s) will then be reviewed by Dwolla; this review may take up to 1-2 business days to approve or reject.
If the Customer has a status of `document`, the Customer will need to upload additional pieces of information in order to verify the account. Use the [create a document](/api-reference/documents/create-document-for-customer) endpoint when uploading a colored camera captured image of the identifying document. The document(s) will then be reviewed by Dwolla; this review may take up to 1-2 business days to approve or reject.

You can provide the following best practices to the Customer in order to reduce the chances of a document being rejected:

Expand Down Expand Up @@ -661,7 +661,7 @@ When a business verified Customer is placed in the `document` verification statu

##### Controllers

**US persons:** A color scanned photo of the Controller’s identifying document can be specified as documentType: `license` (state issued driver's license), or `idCard` (U.S. government-issued photo id card).
**US persons:** A colored camera captured image of the Controller’s identifying document can be specified as documentType: `license` (state issued driver's license), or `idCard` (U.S. government-issued photo id card).

Supported Document Examples:

Expand All @@ -675,7 +675,7 @@ Unsupported Document Examples:
- Military IDs
- Expired government-issued IDs

**Non-US persons:** A color scanned photo of the Controller’s identifying document can be specified as documentType: `passport`. Examples include:
**Non-US persons:** A colored camera captured image of the Controller’s identifying document can be specified as documentType: `passport`. Examples include:

- Non-expired Foreign Passport _**Note:** Foreign Passports are only accepted when the individual does not have an ITIN or SSN and the user must alternatively enter the Passport number_.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -512,7 +512,7 @@ A Customer that is unable to answer at least three questions correctly will be m

## Handling status: `document`

If the Customer has a status of `document`, the Customer will need to upload additional pieces of information in order to verify the account. Use the [create a document](https://developers.dwolla.com/api-reference/documents/create-document-for-customer) endpoint when uploading a colored scan of the identifying document. The document(s) will then be reviewed by Dwolla; this review may take up to 1-2 business days to approve or reject.
If the Customer has a status of `document`, the Customer will need to upload additional pieces of information in order to verify the account. Use the [create a document](https://developers.dwolla.com/api-reference/documents/create-document-for-customer) endpoint when uploading a colored camera captured image of the identifying document. The document(s) will then be reviewed by Dwolla; this review may take up to 1-2 business days to approve or reject.

You can provide the following best practices to the Customer in order to reduce the chances of a document being rejected:

Expand All @@ -528,7 +528,7 @@ You can provide the following best practices to the Customer in order to reduce

### Document types

A color scanned photo of the Customer's identifying document can be specified as documentType: `passport`, `license` (state issued driver's license), or `idCard` (other U.S. government-issued photo id card).
A colored camera captured image of the Customer's identifying document can be specified as documentType: `passport`, `license` (state issued driver's license), or `idCard` (other U.S. government-issued photo id card).

<AlertBar variation="info">
Note: Military IDs are <b>not</b> accepted
Expand Down

0 comments on commit 80d5169

Please sign in to comment.