Table of Contents

Upload Documents

This endpoint is used to upload a document.

Definitions

Route: /documents/upload/presigned
Method: POST
OperationId: presigned

Permissions

The user must be a member of one of the following roles:

  • documents:manager
  • documents:uploader

Request

Headers

Name Description Notes
accept The expected format of the response application/json
osg-client-id The unique identifier assigned to your organization
client_customer_id The unique identifier assigned to your client
correlation_id The unique identifier for correlation

Parameters

Responses

Status Description Body
200 The request was successful and is being processed. UploadDocumentsPresignedResult

Failures

Status Description Body
400 The request was invalid. UploadDocumentsPresignedResult
401 The request was not authorized. None
403 The request was not allowed. None
Default An unexpected error occurred. None

Schemas

UploadDocumentPresigned

{
  "file_name": string,
  "content_type": string,
  "account_number": string,
  "document_date": string,
  "document_type": string
}
Account Number

The account number, or identifier, of the customer to whom the communication is being sent.

Account Discriminator

A discriminator used to differentiate between multiple accounts with the same account number. This allows you to send, and differentiate, mulitple communications to the same customer in a single request.
This field is required if the same AccountNumber is used for multiple communications in a single request.

FileN ame

This is the file name to be uploaded.

Document Date

This is the date the document was created.

Document Type

This is the type of document.

UploadResult

{
  "result": {
    "is_success": boolean,
    "errors": [
      string
    ],
    "message": string,
    "sent_on_utc": string,
    "trace_id": string,
    "correlation_id": string
  },
  "upload_id": string,
  "upload_url": "string"
}
Upload Id

The upload Id used to close out the upload process.

Upload Url

The url to use to upload a file.

Result