Document Requests

Get document request details

get/sites/{site-identifier}/documents/requests/{document-request-GUID}

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/{document-request-GUID}
  • 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

document-request-GUIDstring required
Example:e3c76443-8126-05b6-9914-c88c1ce84726

The GUID that identifies a document request

Response

Success

DocumentRequestGUIDstring guid
DocumentProviderCodestring
DocumentProviderNamestring
DocumentRequestFileNamestring
DocumentRequestTypeCodestring
DocumentRequestStatusCode'SIGNED' | 'OUT_FOR_SIGNATURE' | 'CANCELLED' | 'DECLINED' | 'ERROR' | 'DECLINE_ACKNOWLEDGED'
DocumentRequestStatusReasonstring
FundCodestring
FundNamestring
FundGUIDstring guid
SenderNamestring
SentDateTimestring date-time
CancelledByNamestring
CancelledDateTimestring date-time
DeclineAcknowledgedByNamestring
DeclineAcknowledgedDateTimestring date-time
CreatedDateTimestring date-time
CompletedDateTimestring date-time
RequestSubjectTextstring
RequestMessageTextstring

Example response

{
  "DocumentRequestGUID": "d4c47341-a13b-bcb8-8c14-f13fc0ded111",
  "DocumentProviderCode": "DOCUSIGN",
  "DocumentProviderName": "Docusign",
  "DocumentRequestFileName": "Document Request - SMSF.pdf",
  "DocumentRequestTypeCode": "SIGNATURE-REQUEST",
  "DocumentRequestStatusReason": "Document signed by authorized approver.",
  "FundCode": "SMSF_FUND",
  "FundName": "SMSF Fund",
  "FundGUID": "d4c47341-a13b-bcb8-8c14-f13fc0ded111",
  "SenderName": "John Doe",
  "SentDateTime": "2024-01-01T00:00:00Z",
  "CancelledByName": "John Doe",
  "CancelledDateTime": "2024-01-01T00:00:00Z",
  "DeclineAcknowledgedByName": "John Doe",
  "DeclineAcknowledgedDateTime": "2024-01-01T00:00:00Z",
  "CreatedDateTime": "2024-01-01T00:00:00Z",
  "CompletedDateTime": "2024-01-02T00:00:00Z",
  "RequestSubjectText": "Fund SMSF Documents for Signing",
  "RequestMessageText": "<p>Please review and sign your fund's 2026 Financial Statements and associated documents.</p>",
  "Permissions": [
    "cancel",
    "modify",
    "send_reminder"
  ],
  "Recipients": [
    {
      "Order": 1,
      "Name": "Dylan M",
      "EmailAddress": "dylanM@yahoo.com",
      "DocumentRequestRecipientGUID": "d4c47341-a13b-bcb8-8c14-f13fc0ded111"
    }
  ]
}

Changes

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