Create a Holding Document

Request:

mutation {
    makeHoldingDocument(
      input: {
        name: "PPM",
        extension: "pdf",
        holdingId: "71ac4fd6-2877-46bd-a8b9-f76bca6d6dc4",
        shareWith: ["investor"]
      })
  {
        uploadInfo
        holdingDocumentId
        accountDocumentId
        documentId
  }
}
Response:

{
  "data": {
    "makeHoldingDocument": {
      "uploadInfo": {
        "url": "https://s3.amazonaws.com/documents.vertalo",
        "fields": {
          "key": "example/1c8e4025-2fbe-40ec-ba18-b910fb4db2f6.pdf",
          "Content-Type": "application/pdf",
          "bucket": "documents.vertalo",
          "X-Amz-Algorithm": "AWS4-HMAC-SHA256",
          "X-Amz-Credential": "...JXETTCGRODP/20220212/us-east-1/s3/aws4_request",
          "X-Amz-Date": "20220212T165022Z",
          "X-Amz-Security-Token": "IQoJb3JpZ2luX2VjEBQaCXVzLWVhkyl...g9Pp5kLZtLsrlro2vJQ==",
          "Policy": "eyJleHBpcmF0aW9uIjoiMjAyMi0wMi0xMlQxNzo...WtMWnRMc3Jscm8ydkpRPT0ifV19",
          "X-Amz-Signature": "ebe00453aded2a1c20bdafb...2129eddf5f42a50e45e77130aeeb1c0"
        }
      },
      "holdingDocumentId": "75718a2b-81e5-4655-8c37-7a5f47a4be45",
      "accountDocumentId": null,
      "documentId": "1c8e4025-2fbe-40ec-ba18-b910fb4db2f6"
    }
  }
}

Input parameters:

  • name: file name
  • extension: file extension without leading “.”
  • id: holding ID
  • shareWith: array of role

[Note: If shareWith is an empty array, only the role responsible for the upload will have read-access to the file.]

The Vertalo platform requires that a signed URL (SURL) be generated for any file that is to be uploaded. (Vertalo uses Amazon S3 for file storage.) In this example, a SURL is being generated for a holding document that corresponds to a specific holding for a specific investor. Vertalo does not provide a file upload facility; you will have to program this yourself as appropriate for your development environment. See the example in this section.

What's on this Page