Create a File

Changed on

To upload a file to Increase, you'll need to send a request of Content-Type multipart/form-data. The request should contain the file you would like to upload, as well as the parameters for creating a file.

post/files

Request

  • Base URL
    https://api.increase.com
  • URL
    https://api.increase.com/files
  • Auth
    HTTP bearer

Request body multipart/form-data

descriptionstring

The description you choose to give the File.

filestring binary required

The file contents. This should follow the specifications of RFC 7578 which defines file transfers for the multipart/form-data protocol.

purpose'card_dispute_attachment' | 'check_image_front' | 'check_image_back' | 'mailed_check_image' | 'check_attachment' | 'check_voucher_image' | 'check_signature' | 'form_ss_4' | 'identity_document' | 'loan_application_supplemental_document' | 'other' | 'trust_formation_document' | 'digital_wallet_artwork' | 'digital_wallet_app_icon' | 'physical_card_front' | 'physical_card_carrier' | 'document_request' | 'entity_supplemental_document' | 'unusual_activity_report_attachment' | 'proof_of_authorization_request_submission' required

What the File will be used for in Increase's systems.

Example request

{
  "file": "\"@tax_form.pdf\"",
  "purpose": "check_image_front"
}

Response

File

created_atstring date-time required

The time the File was created.

descriptionstring nullable required

A description of the File.

direction'to_increase' | 'from_increase' required

Whether the File was generated by Increase or by you and sent to Increase.

filenamestring nullable required

The filename that was provided upon upload or generated by Increase.

idstring required

The File's identifier.

idempotency_keystring nullable required

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

mime_typestring required

The MIME type of the file.

purpose'card_dispute_attachment' | 'check_image_front' | 'check_image_back' | 'processed_check_image_front' | 'processed_check_image_back' | 'mailed_check_image' | 'check_attachment' | 'check_voucher_image' | 'check_signature' | 'inbound_mail_item' | 'form_1099_int' | 'form_1099_misc' | 'form_ss_4' | 'identity_document' | 'increase_statement' | 'loan_application_supplemental_document' | 'other' | 'trust_formation_document' | 'digital_wallet_artwork' | 'digital_wallet_app_icon' | 'physical_card_front' | 'physical_card_back' | 'physical_card_carrier' | 'document_request' | 'entity_supplemental_document' | 'export' | 'fee_statement' | 'unusual_activity_report_attachment' | 'deposit_account_control_agreement' | 'proof_of_authorization_request_submission' | 'account_verification_letter' | 'funding_instructions' | 'hold_harmless_letter' required

What the File will be used for. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.

type'file' required

A constant representing the object's type. For this resource it will always be file.

Example response

{
  "created_at": "2020-01-31T23:59:59Z",
  "description": "2022-05 statement for checking account",
  "direction": "from_increase",
  "filename": "statement.pdf",
  "id": "file_makxrc67oh9l6sg7w9yc",
  "idempotency_key": null,
  "mime_type": "application/pdf",
  "purpose": "increase_statement",
  "type": "file"
}

Changes

  • df2b1ead4c49Revision changes
    • info

      the request property default value other was added

  • 64a92a8cc343Revision changes
    • info

      added subschema #8 subschema #10 to the /// response property anyOf list for the response status

    • info

      added subschema #8 subschema #10 to the /// response property anyOf list for the response status

    • info

      removed subschema #8 subschema #10 from the /// response property anyOf list for the response status

    • info

      removed subschema #8 subschema #10 from the /// response property anyOf list for the response status