Retrieve file details
Retrieve file details associated with a specific 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/{fileID}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The request completed successfully.
Describes a file linked to a Moov account.
{
"fileID": "a1b482fb-b334-48e0-985b-622ea529f00c",
"fileName": "logo.png",
"accountID": "3dfff852-927d-47e8-822c-2fffc57ff6b9",
"filePurpose": "representative_verification",
"fileStatus": "pending",
"metadata": "{\"error_code\": \"document-name-mismatch\", \"requirement_id\": \"document.individual.verification\", \"representative_id\": \"c63ab175-251d-497e-a267-7346d087e180\", \"comment\": \"testing comment\"",
"decisionReason": "not correct file",
"fileSizeBytes": 0,
"createdOn": "2019-08-24T14:15:22Z",
"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.
The requested resource was not found.
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
Specify an API version.
API versioning follows the format vYYYY.QQ.BB, where
YYYYis the yearQQis the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)BBis the build number, starting at.01, for subsequent builds in the same quarter.- For example,
v2024.01.00is the initial release of the first quarter of 2024.
- For example,
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.00Path parameters
accountID
string
<uuid>
required
fileID
string
<uuid>
required
Response
accountID
string<uuid>
required
createdOn
string<date-time>
required
fileID
string<uuid>
required
fileName
string
<=64 characters
required
filePurpose
string<enum>
required
The file's purpose.
Possible values:
business_verification,
representative_verification,
individual_verification,
merchant_underwriting,
account_requirement,
identity_verification
fileSizeBytes
integer
required
fileStatus
string<enum>
required
The file's status.
Possible values:
pending,
approved,
rejected
metadata
string<json>
required
updatedOn
string<date-time>
required
decisionReason
string