List documents for customer

Returns all identity verification documents submitted for a customer. Includes document status, verification results, document type (passport, driver’s license, etc.), and failure reasons if verification was rejected. Used to track document submission and verification progress during the business verification process.

GET /customers/{id}/documents

cURL

cURL

GET https://api-sandbox.dwolla.com/customers/176878b8-ecdb-469b-a82b-43ba5e8704b2/documents
Accept: application/vnd.dwolla.v1.hal+json
Authorization: Bearer pBA9fVDBEyYZCEsLfwKehyh1RTpzjUj5KzIRfDi0wKTii7DqY

...

{
  "_links": {
    "self": {
      "href": "https://api-sandbox.dwolla.com/customers/176878b8-ecdb-469b-a82b-43ba5e8704b2/documents"
    }
  },
  "_embedded": {
    "documents": [
      {
        "_links": {
          "self": {
            "href": "https://api-sandbox.dwolla.com/documents/56502f7a-fa59-4a2f-8579-0f8bc9d7b9cc"
          }
        },
        "id": "56502f7a-fa59-4a2f-8579-0f8bc9d7b9cc",
        "status": "pending",
        "type": "passport",
        "created": "2015-09-29T21:42:16.000Z",
        "documentVerificationStatus": "pending"
      },
      {
        "_links": {
            "self": {
                "href": "https://api-sandbox.dwolla.com/documents/20988444-c7e1-40cf-ab1a-a20da878e568",
                "type": "application/vnd.dwolla.v1.hal+json",
                "resource-type": "document"
            }
        },
        "id": "20988444-c7e1-40cf-ab1a-a20da878e568",
        "status": "reviewed",
        "type": "license",
        "created": "2019-05-30T22:01:40.000Z",
        "documentVerificationStatus": "rejected",
        "failureReason": "ScanDobMismatch",
        "allFailureReasons": [
            {
                "reason": "ScanDobMismatch",
                "description": "Scan DOB does not match DOB on account"
            },
            {
                "reason": "ScanIdExpired",
                "description": "ID is expired or missing expiration date"
            }
        ]
      }
    ]
  },
  "total": 2
}

200

{
  "_links": {},
  "_embedded": {
    "documents": [
      {
        "_links": {
          "self": {
            "href": "https://api.dwolla.com",
            "type": "application/vnd.dwolla.v1.hal+json",
            "resource-type": "resource-type"
          }
        },
        "id": "56502f7a-fa59-4a2f-8579-0f8bc9d7b9cc",
        "status": "reviewed",
        "type": "passport",
        "created": "2015-09-29T21:42:16.000Z",
        "documentVerificationStatus": "rejected",
        "failureReason": "ScanDobMismatch",
        "allFailureReasons": [
          {
            "reason": "ScanDobMismatch",
            "description": "Scan DOB does not match DOB on account"
          }
        ]
      }
    ]
  },
  "total": 2
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

Accept · enum<string> · default: application/vnd.dwolla.v1.hal+json · required

The media type of the response. Must be application/vnd.dwolla.v1.hal+json

Available options: application/vnd.dwolla.v1.hal+json

Path Parameters

id · string · required

customer unique identifier

Response

200

application/vnd.dwolla.v1.hal+json

successful operation

_links · object · required

Show child attributes

_embedded · object · required

Show child attributes

total · integer · required

Example:

2