Docs
Get API Keys
  • Authorization
    Root
    Accounts
    External Parties
    Funding Sources
    Transfers
    Webhook Subscriptions
    Webhooks

List documents for a beneficial owner #

This section contains information on how to retrieve a list of documents that belong to a beneficial owner.

HTTP request #

GET https://api.dwolla.com/beneficial-owners/{id}/documents

Request parameters #

ParameterRequiredTypeDescription
idyesstringBeneficial owner unique identifier.

Request and response #

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

...

{
  "_links": {
    "self": {
      "href": "https://api-sandbox.dwolla.com/beneficial-owners/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/11fe0bab-39bd-42ee-bb39-275afcc050d0"
          }
        },
        "id": "11fe0bab-39bd-42ee-bb39-275afcc050d0",
        "status": "reviewed",
        "type": "passport",
        "created": "2015-09-29T21:45:37.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
}
Test in the Sandbox for free today.
Use sandbox environment to test API requests.
Get API Keys
2023 All Rights Reserved
Financial institutions play an important role in our network.

All funds transfers made using the Dwolla Platform are performed by a financial institution partner, and any funds held in a Dwolla Balance are held by a financial institution partner. Learn more about our financial institution partners.