Ask Moov Beta
Generative AI is experimental and can make mistakes.
Guides Dashboard Use cases API Changelog
  1. API reference
  2. Moov accounts
  3. Files

List files

List all the files associated with a particular Moov account.

To access this endpoint using an access token you’ll need to specify the /accounts/{accountID}/files.read scope.

GET
/accounts/{accountID}/files
cURL Go 
1
2

curl -X GET "https://api.moov.io/accounts/{accountID}/files" \
  -H "Authorization: Bearer {token}" \

1
2
3
4
5

mc, _ := moov.NewClient()

var accountID string

mc.ListFiles(ctx, accountID)
200 401 403 429 500 504
The request completed successfully.
[
  {
    "accountID": "3dfff852-927d-47e8-822c-2fffc57ff6b9",
    "createdOn": "2019-08-24T14:15:22Z",
    "decisionReason": "not correct file",
    "fileID": "a1b482fb-b334-48e0-985b-622ea529f00c",
    "fileName": "logo.png",
    "filePurpose": "representative_verification",
    "fileSizeBytes": 0,
    "fileStatus": "pending",
    "metadata": "{\"error_code\": \"document-name-mismatch\", \"requirement_id\": \"document.individual.verification\", \"representative_id\": \"c63ab175-251d-497e-a267-7346d087e180\", \"comment\": \"testing comment\"",
    "updatedOn": "2019-08-24T14:15:22Z"
  }
]

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request contained missing or expired authentication.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The user is not authorized to make the request.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
Request was refused due to rate limiting.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request failed due to an unexpected error.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request failed because a downstream service failed to respond.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.

Headers

x-moov-version

string
API version

Specify an API version.

API versioning follows the format vYYYY.QQ.BB, where

  • YYYY is the year
  • QQ is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)
  • BB is the build number, starting at .01, for subsequent builds in the same quarter.
    • For example, v2024.01.00 is the initial release of the first quarter of 2024.

The latest version represents the most recent development state. It may include breaking changes and should be treated as a beta release.

Default: v2024.01.00

Path parameters

accountID

string <uuid> required

Response

application/json

accountID

string<uuid>

createdOn

string<date-time>

decisionReason

string

fileID

string<uuid>

fileName

string <=64 characters

filePurpose

string<enum>
The file’s purpose.
Possible values: business_verification, representative_verification, individual_verification, merchant_underwriting, account_requirement, identity_verification

fileSizeBytes

integer

fileStatus

string<enum>
The file’s status.
Possible values: pending, approved, rejected

metadata

string<json>

updatedOn

string<date-time>