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

Upload file

Upload a file and link it to the specified Moov account.

The maximum file size is 10MB. Each account is allowed a maximum of 50 files. Acceptable file types include csv, jpg, pdf, and png.

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

POST
/accounts/{accountID}/files
cURL Go 
1
2
3
4
5
6

curl -X POST "https://api.moov.io/accounts/{accountID}/files" \
  -H "Authorization: Bearer {token}" \
  --form \
  -F "file=@/path/to/your/file.txt" \
  -F "filePurpose=business_verification" \
  -F "metadata={\"representative_id\":\"UUID\"}"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

mc, _ := moov.NewClient()

var accountID string
file, _ := os.Open("/path/to/file.csv")

mc.UploadFile(ctx, accountID, moov.UploadFile{
    FilePurpose: moov.FilePurpose_MerchantUnderwriting,
    Metadata: map[string]string{
        "requirement_id": "business.underwriting-documents-tier-one",
        "other_keys":     "for customer use",
    },
    Filename: "file.csv",
    File:     file,
})
200 400 401 403 404 409 422 429 500 504
The request completed successfully.
Describes a file linked to a Moov account.
{
  "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 server could not understand the request due to invalid syntax.
{
  "error": "string"
}

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.
The request conflicted with the current state of the target resource.
{
  "error": "string"
}

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request was well-formed, but the contents failed validation. Check the request for missing or invalid fields.
{
  "error": "string",
  "file": "string",
  "filePurpose": "string",
  "metadata": "string"
}

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

Body

multipart/form-data
Request to upload a file for an account.

file

string<binary> required
The file to be added. Valid types are csv, png, jpeg, pdf.

filePurpose

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

metadata

string<json>

Additional metadata to be stored with the file, formatted as a JSON string.

Valid keys are representative_id, comment, requirement_id, error_code.

Response

application/json
Describes a file linked to a Moov account.

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