POST /sites/{site-identifier}/documents/requests/initialize

Document Requests

Initialize document request

post/sites/{site-identifier}/documents/requests/initialize

Request

Base URL: https://api-dev.superconcepts.com.au/api/v1
URL: https://api-dev.superconcepts.com.au/api/v1/sites/{site-identifier}/documents/requests/initialize
Auth: OAuth 2 (authorization code, authorization URL https://api.supermate.com.au/oauth/v1/authorize, token URL https://api.supermate.com.au/oauth/v1/token, scopes: actuarial_write, audit_read, audit_write, client_access_grant, contactevents_read, contactevents_write, default, documents_read, documents_write, fund:investments_read, fund:members_read, fund:members_write, fund:transactions_read, fund:transactions_write, fund_read, fund_write, security:domains_write, security:policies_write, security:users_invite, site:accounting-notes_write, site:asset-categories_write, site:auditor_write, site:branding_write, site:datafeed-config_write, site:identity_write, site:letters_write, site:policies_write, site:reporting_write, sites_read, superstream:config_write)

Path parameters

site-identifierstring required

The GUID that identifies a site

Request body

FundIdentifierstring guid

ReportSuiteInstanceGUIDstring guid

JobGUIDstring guid

Example request

{
  "FundIdentifier": "d4c47341-a13b-bcb8-8c14-f13fc0ded109",
  "ReportSuiteInstanceGUID": "d4c47341-a13b-bcb8-8c14-f13fc0ded111"
}

Response

Success

FundIdentifierstring guid

DocumentProviderCodestring

DocumentProviderNamestring

DocumentRequestTypeCodestring

ReportSuiteInstanceGUIDstring guid

JobGUIDstring guid

RequestSubjectTextstring

RequestMessageTextstring

Example response

{
  "FundIdentifier": "d4c47341-a13b-bcb8-8c14-f13fc0ded109",
  "DocumentProviderCode": "DOCUSIGN",
  "DocumentProviderName": "Docusign",
  "DocumentRequestTypeCode": "SIGNATURE-REQUEST",
  "ReportSuiteInstanceGUID": "d4c47341-a13b-bcb8-8c14-f13fc0ded111",
  "RequestSubjectText": "Fund SMSF Documents for Signing",
  "RequestMessageText": "Please review and sign your fund's 2026 Financial Statements and associated documents.",
  "Recipients": [
    {
      "Order": 1,
      "Name": "Dylan M",
      "EmailAddress": "dylanM@yahoo.com",
      "RecipientGUID": "d4c47341-a13b-bcb8-8c14-f13fc0ded222"
    }
  ],
  "Documents": [
    {
      "DocumentName": "Document Request - SMSF.pdf",
      "DocumentDescription": "Report Suite EOY",
      "ReportSuiteInstanceGUID": "d4c47341-a13b-bcb8-8c14-f13fc0ded111"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.