Retrieve file details
To use this endpoint from the browser, you’ll need to specify the
/accounts/{accountID}/files.read
scope when generating a token.
GET
/accounts/{accountID}/files/{fileID}
|
|
Successfully retrieved file details.
Describes a file linked to a Moov account.
{
"accountID": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43",
"createdOn": "2019-08-24T14:15:22Z",
"decisionReason": "not correct file",
"fileID": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43",
"fileName": "logo.png",
"filePurpose": "identity_verification",
"fileSizeBytes": 1024,
"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"
}
No account with the specified accountID was found.
Request was refused due to rate limiting.
Response headers
Retry-After
number
Path parameters
accountID
string
<uuid>
required
ID of the account.
fileID
string
<uuid>
required
Identifier for the file.
Response
application/json
accountID
string<uuid>
<=36 characters
UUID v4
createdOn
string<date-time>
<=24 characters
decisionReason
string
fileID
string<uuid>
<=36 characters
UUID v4
fileName
string
<=64 characters
filePurpose
string<enum>
Possible values:
identity_verification
,
business_verification
,
representative_verification
,
individual_verification
,
merchant_underwriting
,
account_requirement
fileSizeBytes
integer
fileStatus
string<enum>
The file status.
Possible values:
pending
,
approved
,
rejected
metadata
string<json>
updatedOn
string<date-time>
<=24 characters