DocumentUploadResponse

  • applicationId
    Type: string

    The application the documents were uploaded to.

  • documentCategory
    Type: string enum

    The category the documents were filed under.

    values
    • BANK_STATEMENTS
    • PAYSLIPS
    • TAX_SUMMARY
    • OTHER_DOCUMENTS
  • documents
    Type: array object[]
    • documentCategory
      Type: string
    • downloadUrl
      Type: string Format: uri
    • fileId
      Type: string
    • fileName
      Type: string
    • fileSize
      Type: integer Format: int64

      Signed 64-bit integers (long type).

    • fileType
      Type: string
    • processingReference
      Type: string

      Reference assigned when a bank statement is submitted for automated processing.

    • status
      Type: string
  • errors
    Type: array string[]
  • statementProcessingTriggered
    Type: boolean

    True when uploaded bank statements were submitted for automated statement processing. Processing is asynchronous; poll GET /v1/subscriber/applications/{applicationId} until its transaction summary populates.

  • totalUploaded
    Type: integer

    Number of files successfully uploaded.