List documents for a client

GET https://api-sandbox.dwolla.com/clients/{{clientAccountId}}/documents

Retrieve a list of documents that belong to a Client account.

Request parameters

ParameterRequiredTypeDescription
idyesstringClient account resource unique identifier.

HTTP status and error codes

HTTP StatusCodeMessageDescription
200OkSuccessThe Dwolla API accepted the request and returned a response.
404NotFoundThe requested resource was not found.Client Account not found. Check Client Account Id.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring
Content-Typestring
Authorizationstring

RESPONSES

status: OK

{"_links":{"self":{"href":"https://api-sandbox.dwolla.com/clients/02585eb7-683a-4872-addd-fbafc6e9fcf7/documents","type":"application/vnd.dwolla.v1.hal+json","resource-type":"document"}},"_embedded":{"documents":[{"_links":{"self":{"href":"https://api-sandbox.dwolla.com/documents/9975829d-a436-4940-9739-6e6f07e7e069","type":"application/vnd.dwolla.v1.hal+json","resource-type":"document"}},"id":"9975829d-a436-4940-9739-6e6f07e7e069","status":"reviewed","type":"passport","created":"2022-06-03T14:56:49.000Z","documentVerificationStatus":"accepted"}]},"total":1}