Upload File by FileType in request

The POST /Files/UploadFile API method allows users to upload files of specific types to the server. This endpoint supports multipart form-data, where users can attach files and, optionally, associate them with a transaction using a transactionId. It facilitates the submission of various document types, including user icons, government-issued IDs, tax documents, and more.

Functionality:

  • Allows users to upload files to the server for different purposes, such as adding avatars, attaching documents to transactions, or submitting identification documents.
  • Supports various file types and document categories to meet different business or regulatory requirements.

Request Body (multipart/form-data):

  • file (required): The file to be uploaded (e.g., image, PDF).
  • transactionId (optional): Required only if the file is being associated with a specific transaction.
  • fileType (required): Specifies the type of file being uploaded. Supported file types include but are not limited to:
    • UserIcon - Avatar image for user profile
    • TransactionIcon - File linked to a specific transaction
    • DriverLicense - Upload of driver's license
    • SocialSecurityNumber - Upload of Social Security Number document
    • TaxFiling - Schedule C of tax filing
    • OperatingAgreement - Business operating agreement
    • ArticlesOfIncorporation - Articles of Incorporation
    • BusinessRegistration - Business registration document
    • BusinessLicense - Business license
    • TaxId_application - Tax ID application
    • Passport - Passport
    • RewardIntegrationImage - Image for reward integration
    • Lease_Agreement - Lease agreement
    • Utility_Bill - Utility bill
    • Other - Any other type of document
    • CardIconSmall - Small card icon
    • CardIconLarge - Large card icon
    • UsMilitaryRecordOfService - U.S. Military record of service
    • StateUsMilitaryArmedForcesId - U.S. Armed Forces ID
    • UsTaxForm - U.S. Tax form
    • W2 - W-2 form
    • Form1099 - 1099 form
    • PhoneBill - Phone bill
    • CableBill - Cable bill
    • InternetBill - Internet bill
    • BankStatement Bank statement
    • Statement401k 401(k) statement
    • BrokerageStatement Brokerage statement
    • LifeInsurance Life insurance document
    • HealthInsurance Health insurance document
    • AutoInsurance Auto insurance document
    • MunicipalId Municipal ID
    • StateIssuedId State-issued ID
    • CertificateOfCitizenship Certificate of citizenship
    • CourtOrderForLegalNameChange Court order for legal name change
    • StateUsPermanentResidentCard U.S. Permanent Resident Card
    • StateConsularIdentificationCard Consular identification card
    • StateUsBorderCrossingCard U.S. Border Crossing Card
    • StateUsEmploymentAuthorizationCard U.S. Employment Authorization Card
    • StateTribalId Tribal ID
    • BirthCertificate Birth certificate
    • Form5498 5498 tax form
    • Form1098 1098 tax form
    • PayStub Pay stub
    • MedicareCard Medicare card

Response:

  • OK: The file was uploaded successfully.
  • BadRequest: The request was invalid, potentially due to a missing file, invalid fileType, or incorrect transactionId.

Key Features:

  • Flexible File Upload: Supports a wide range of document types, from personal identification to business documentation.
  • Transaction-Specific Uploads: Allows attaching files to specific transactions by including a transactionId.
  • Secure Document Handling: Ensures that sensitive documents like Social Security numbers, tax forms, and military records are uploaded and stored securely.
  • Extensive Support for Document Types: Covers a broad spectrum of required document types for business, personal, and regulatory purposes.
Language
Credentials
Bearer
JWT
Click Try It! to start a request and see the response here!