--- title: Secured Signing API Without OAuth 2 - Secured Signing description: Secured Signing Support guide to Secured Signing API Without OAuth 2. image: https://blog.securedsigning.com/hubfs/Imported_Blog_Media/Home-Page-Hero-Image-01-Hero-8-3.png --- [Skip to content](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#main-content) [![Secured Signing Blue Logo - SVG](https://blog.securedsigning.com/hubfs/Logos/Secured%20Signing%20Blue%20Logo%20-%20SVG.svg "Secured Signing Blue Logo - SVG")](https://www.securedsigning.com/) # Secured Signing API Without OAuth 2 Aug 23, 2023, 12:00:00 AM ![](https://blog.securedsigning.com/hubfs/Imported_Blog_Media/Home-Page-Hero-Image-01-Hero-8-3.png) 1. [Getting Started](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#gettingstarted) 2. [Authentication](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#authentication) 3. [Client & UI SDK](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#clientuisdk) 4. [Documentation](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#documentation)   \*  For  **Partner API** , please click  [**here**](https://securedsigning.com/documentation/enterprise/partner-api) . \* For **API With OAuth 2 version**, please click [**here**](https://blog.securedsigning.com/support/secured-signing-api-with-oauth2/). ## **Getting Started** Add an API Account by logging in to your account Navigate to **My Account**  > **My Settings** > **API Settings** Add an API key using the button a the top. This will generate an API account, with configurable settings for your connection. \* It is important to specify a domain from where the API requests come. #### **Using the API** The API is Rest based, and can be found at **[Documentation](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#documentation)** #### Response Codes The following response codes apply to all requests. Check each request type in the list below for more response codes specific to that request. | Status | Code | Meaning | | --- | --- | --- | | 200 | OK | The request was processed successfully | | 401 | Unauthorized | Authentication failed or the Authenticate header was not provided | | 404 | Not Found | The URI does not match any of the recognised resources | #### Response and Request Data Formats **Supported Request Formats** Use the Content-Type header to specify the format your data is in. - JSON: application/json - Multipart Form Data: multipart/form-data **Supported Response Formats** Use the Accept header to specify the output desired format. If you can’t set that header, use the format parameter in the query string. The format parameter takes precedence over the Accept header. - JSON: application/json #### **Getting Started Walk-throughs** - **[Getting Started – FormDirect](https://blog.securedsigning.com/wp-content/uploads/2022/12/Getting-Started-FormDirect.pdf)** - **[Getting Started – ISign](https://blog.securedsigning.com/wp-content/uploads/2022/12/Getting-Started-ISign.pdf)** - **[Getting Started – WeSign](https://blog.securedsigning.com/wp-content/uploads/2022/12/Getting-Started-WeSign.pdf)** - **[Smart Tag API Documentation](https://securedsigning.com/documentation/developer/smarttag-api)** #### **Please feel free to [Contact Us](https://blog.securedsigning.com/contact-us/) for any questions or help** ## Authentication The REST API uses stateless authentication using HMAC SHA-256. All requests to resources (excluding the schema pages) must be accompanied by the correct Authentication headers as per this specification. #### Authentication headers - **X-CUSTOM-API-KEY :** This is your ApiKey which can be generated from “My Settings” in the Account page - **X-CUSTOM-SIGNATURE :** This is a HMAC SHA-256 hash of a string of properties outlined below using your api secret which is generated at the same time as your ApiKey - **X-CUSTOM-DATE :** This is a Unix timestamp of the time you made the request. We allow a slight buffer on this in case of any time sync issues. - **X-CUSTOM-NONCE :** A randomly generated string of your choice. Ensure it is unique to each request, and no more than 32 characters long. - **\* Referer :**The address where the request originated. Please specify the domain you set in API Settings. The signature header value to be hashed is created using the following properties ApiKey, time stamp and nonce as show below ``` ApiKey\n timestamp\n nonce ``` Please use ‘\\n’ as shown above. After the string is created above, it is hashed using HMAC SHA-256 using your API Secret. It must be Base64 string encoded before adding it to the header. e.g. In JavaScript (We are using Googles CryptoJS library for the hashing and Base64 encoding) ``` var hash = CryptoJS.HmacSHA256(apiKey + '\n' + timestamp + '\n' + nonce, apiSecretKey); var hashInBase64 = CryptoJS.enc.Base64.stringify(hash); ``` Our client SDK libraries perform these functions for you, as well as adding the headers automatically. ## Client & UI SDK The client SDK provides an encapsulated library exposing simple to use methods that hide the complexity of integrating with our Rest API. \* The provided SDKs’ codes are on Github. **[Fork me on GitHub](https://github.com/SecuredSigning)** #### **JavaScript** We also host the JavaScript version from our hosting. Please add the following script reference in the header section of your page ``` ``` To initialise the JavaScript SDK library First create a config object as shown below ``` var config = { "apiKey": , "baseUrl": "//api.securedsigning.com/web", "version": "v1.4", "secret": }; ``` Next initialise the library. We have provided a function `SSApiLoaded` that executes when the scripts have loaded if you are using our hosted JavaScript libraries ``` function SSApiLoaded() { securedsigning = new SecuredSigning(config); }; ``` An SDK method call normally takes 3 parameters 1. requestData: the data required for performing the task 2. onSuccess: Callback function to handle a successful request 3. onError: Callback function to handle any errors An example ``` securedsigning.sendSmartTagDocument(requestData, function (data) { console.log(data); },function (error) { console(error); }); ``` #### **.NET** You can view the source code on GitHub [**here.**](https://github.com/SecuredSigning/.NET-Client-SDK) Install our .NET client SDK **SecuredSigning.Client** `PM> Install-Package SecuredSigning.Client` This library has the following dependencies **ServiceStack.Client.Signed**, **ServiceStack.Text.Signed** and **ServiceStack.Interfaces** To initialise the library call the constructor ``` var client = new ServiceClient("https://api.securedsigning.com/web","v1.4", , ); ``` We have provided data objects for the requests e.g. ``` [Schema("EmailTemplate")] public class EmailTemplate { public string Reference { get; set; } public string Name { get; set; } } ``` An example of a function call ``` var forms = client.getFormList(); ``` #### **Other Languages** We have provided more client SDKs of different programing languages as well, with their source codes on GitHub. - **Java :** **[JAR file](https://securedsigning.com/Secured%20Signing%20Client%20SDK.jar) [GitHub Repository](https://github.com/SecuredSigning/Java-Client-SDK)** ## **UI SDK** The UI SDK is provided as part of the JavaScript sdk. Please add the scripts as below ``` ``` #### **Initialising SDK** To initialise the JavaScript SDK library First create a config object as shown below ``` var config = { "apiKey": , "baseUrl": "//api.securedsigning.com/web", "version": "v1.4", "secret": }; ``` #### **Uploading a document** You can use our uploader to add a document for signing Use the following JavaScript function passing in a DOM element id for the upload button This then on Success starts an ISign or WeSign process ``` securedsigning.CreateUpload(, function(data) { ISign(data.Reference); //WeSign(data.Reference); },function (error) { alert(error); }); ``` After a document is submitted, a reference will return. #### **Embedding html resources** ##### **I Sign** For an I Sign signing resource This embeds a signing resource in a DOM element with the id of ‘content’ ``` function ISign(ref) { var request = { Email: "firstlastname@sample.com", FirstName: "firstname", LastName: "lastname", DocumentReference: ref }; securedsigning.getISignResource(request, "content", function (error) { }); } ``` ##### **We Sign** For an We Sign signing resource This embeds a signing resource in a DOM element with the id of ‘content’ ``` function WeSign(ref) { var request = { DocumentReference: ref }; securedsigning.getWeSignResource(request, "content", function (error) { }); } ``` Download a sample webpage **[here](https://securedsigning.com/UISDKSample.html)**. ## Documentation API Key:  API Secret:  Secured Signing API - ## [Account](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Account) - [Show/Hide](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Account) - List Operations - Expand Operations - Raw - - ### [get](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Account/AccountRequest) [/Account/Info](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Account/AccountRequest) - [Get account information](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Account/AccountRequest) #### Implementation Notes Get account information. #### Response Class (Status ) - Model - Model Schema AccountInfo { Email ( string, optional): The email of the account user, Name ( string, optional): The name of the account user, PlanName ( string, optional): The price plan name of the account, DocumentRemain ( string): The amount of documents remain in the plan, not applied to PAYG and Global Membership, DocumentUsed ( string): The amount of documents used, DocumentLeft ( string): The amount of documents available; use this to determine if new document can be uploaded., DefaultDueDate ( string): Default due date setting in days of this account, MaxDueDate ( string): Maximum due date setting in days of this account; note that it's in weeks in Secured Signing Web UI., DateFormat ( string, optional): The signature date format setting of the account; Not for date in API response;, GMT ( string, optional): Default GMT of the user, MaxUploadSize ( string): The maximum size cab be uploaded for each document, Actived ( string): If the account is actived or not, Locked ( string): If the account is locked or not, AccountStatus ( string, optional) = \['FreeWay' or 'Paid' or 'OnHold' or 'Inactive' or 'Cancelled' or 'Expired' or 'Disabled'\]: The status of the account, UserId ( string, optional): The reference of the user, EnabledFaceToFaceSigning ( string): If the account enables Face to Face signing, EnabledVideoConfirmation ( string): If the account enables Video Confirmation before signing, EnabledDocNegotiation ( string): If the account enables document negotiation, EnabledReviewBeforeSigning ( string): If the account enables review before signing } ``` { "Email": "", "Name": "", "PlanName": "", "DocumentRemain": "", "DocumentUsed": "", "DocumentLeft": "", "DefaultDueDate": "", "MaxDueDate": "", "DateFormat": "", "GMT": "", "MaxUploadSize": "", "Actived": "", "Locked": "", "AccountStatus": "", "UserId": "", "EnabledFaceToFaceSigning": "", "EnabledVideoConfirmation": "", "EnabledDocNegotiation": "", "EnabledReviewBeforeSigning": "" } ``` Response Content Type application/json #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 404 | Unable to find user or api key | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - ## [Attachment](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Attachment) - [Show/Hide](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Attachment) - List Operations - Expand Operations - Raw - - ### [delete](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Attachment/DeleteAttachmentRequest) [/Attachment/{AttachmentReference}](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Attachment/DeleteAttachmentRequest) - [Delete the attachment](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Attachment/DeleteAttachmentRequest) #### Implementation Notes Delete the attachment #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | AttachmentReference | | **Attachment reference** | path | string | #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 401 | Unauthorised: Check your api key | | | 404 | Unable to find document, please check reference | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [post](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Attachment/DeleteAttachmentRequest_0) [/Attachment/Delete/{AttachmentReference}](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Attachment/DeleteAttachmentRequest_0) - [Delete the attachment](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Attachment/DeleteAttachmentRequest_0) #### Implementation Notes Delete the attachment #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | AttachmentReference | | **Attachment reference** | path | string | | body | Parameter content type: application/json | | body | - Model - Model Schema DeleteAttachmentRequest { AttachmentReference ( string): Attachment reference } ``` { "AttachmentReference": "" } ``` Click to set as parameter value | #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 401 | Unauthorised: Check your api key | | | 404 | Unable to find document, please check reference | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [get](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Attachment/GetAttachmentsRequest) [/Attachment/GetAttachments](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Attachment/GetAttachmentsRequest) - [Returns account user's active documents](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Attachment/GetAttachmentsRequest) #### Implementation Notes Returns an array of all In progress and signed documents that haven't been removed. #### Response Class (Status ) - Model - Model Schema AttachmentResponse { Reference ( string): Attachment reference, Number ( string, optional): Attachment Number, can only be digitals, Category ( string, optional): Attachment Category, Name ( string): File Name, FileType ( string) = \['pdf' or 'doc' or 'docx' or 'rtf'\]: File type of file, FileUrl ( string): Url to download retrieve file data } ``` [ { "Reference": "", "Number": "", "Category": "", "Name": "", "FileType": "", "FileUrl": "" } ] ``` Response Content Type application/json #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 401 | Unauthorised: Check your api key | | | 404 | Document not found, may have been removed | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [post](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Attachment/UploadAttachmentRequest) [/Attachment/UploadByUrl](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Attachment/UploadAttachmentRequest) - [Uploads a file by url](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Attachment/UploadAttachmentRequest) #### Implementation Notes Uploads a file using a url #### Response Class (Status ) - Model - Model Schema AttachmentResponse { Reference ( string): Attachment reference, Number ( string, optional): Attachment Number, can only be digitals, Category ( string, optional): Attachment Category, Name ( string): File Name, FileType ( string) = \['pdf' or 'doc' or 'docx' or 'rtf'\]: File type of file, FileUrl ( string): Url to download retrieve file data } ``` { "Reference": "", "Number": "", "Category": "", "Name": "", "FileType": "", "FileUrl": "" } ``` Response Content Type application/json #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | body | Parameter content type: application/json | | body | - Model - Model Schema UploadAttachmentRequest { File ( FileInfo): The file infomation } ``` { "File": "FileInfo" } ``` Click to set as parameter value | #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 401 | Unauthorised: Check your api key | | | 404 | Document not found, check uploaded file name matches file name in data | | | 413 | File is too large | | | 426 | Not enough documents left in plan | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [post](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Attachment/AttachmentUploaderRequest) [/Attachment/Uploader](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Attachment/AttachmentUploaderRequest) - [Uploads a file by mulitpart form](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Attachment/AttachmentUploaderRequest) #### Implementation Notes Uploads a file using multipart form type. Allowed FileTypes: .pdf, .doc, .docx, .odt, .rtf .xls, .xlsx, .ods, .txt, .gif, .jpeg, .jpg, .png, .bmp, .dcm, .svg, .tif, .tiff. #### Response Class (Status ) - Model - Model Schema AttachmentResponse { Reference ( string): Attachment reference, Number ( string, optional): Attachment Number, can only be digitals, Category ( string, optional): Attachment Category, Name ( string): File Name, FileType ( string) = \['pdf' or 'doc' or 'docx' or 'rtf'\]: File type of file, FileUrl ( string): Url to download retrieve file data } ``` { "Reference": "", "Number": "", "Category": "", "Name": "", "FileType": "", "FileUrl": "" } ``` Response Content Type application/json #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | body | | | body | file | | Number | | Attachment Number, can only be digitals | query | string | | Category | | Attachment Category | query | string | #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 401 | Unauthorised: Check your api key | | | 404 | Document not found, check uploaded file name matches file name in data | | | 413 | File is too large | | | 426 | Not enough documents left in plan | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - ## [Billing](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Billing) - [Show/Hide](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Billing) - List Operations - Expand Operations - Raw - - ### [get](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Billing/InvoiceDetailsRequest) [/Billing/InvoiceDetail/{InvoiceReference}](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Billing/InvoiceDetailsRequest) - [Get invoice details](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Billing/InvoiceDetailsRequest) #### Implementation Notes Get invoice details #### Response Class (Status ) - Model - Model Schema InvoiceDetail { InvoiceNO ( string, optional), Description ( string, optional), InvoiceType ( string) = \['None' or 'BuySMS' or 'BuyIdCheck' or 'Account' or 'MembershipAccount' or 'Membership' or 'Partner' or 'BuyDocumentNegotiation' or 'Sender'\], StartDate ( string, optional), StartDateTimezone ( string, optional), EndDate ( string, optional), EndDateTimezone ( string, optional), InvoiceUser ( string, optional), InvoiceMembership ( string, optional), InvoicePartner ( string, optional), Price ( double), Quantity ( int), Devices ( int), TotalDocuments ( int), NumberOfSMS ( int), IDCheckCost ( double), NumberOfNegotiation ( int), IDCheckDetails ( Array\[string\], optional) } ``` [ { "InvoiceNO": "", "Description": "", "InvoiceType": "", "StartDate": "", "StartDateTimezone": "", "EndDate": "", "EndDateTimezone": "", "InvoiceUser": "", "InvoiceMembership": "", "InvoicePartner": "", "Price": 0, "Quantity": "int", "Devices": "int", "TotalDocuments": "int", "NumberOfSMS": "int", "IDCheckCost": 0, "NumberOfNegotiation": "int", "IDCheckDetails": [ "" ] } ] ``` Response Content Type application/json #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | InvoiceReference | | | path | string | #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 404 | Unable to find user or api key | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [get](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Billing/InvoiceRequest) [/Billing/Invoices](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Billing/InvoiceRequest) - [Get account information](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Billing/InvoiceRequest) #### Implementation Notes Get account information. #### Response Class (Status ) - Model - Model Schema InvoiceInfo { InvoiceReference ( string, optional), InvoiceNO ( string, optional), InvoiceDate ( string, optional), InvoiceTimezone ( string, optional), Description ( string, optional), Amount ( double), InvoiceType ( string) = \['None' or 'BuySMS' or 'BuyIdCheck' or 'Account' or 'MembershipAccount' or 'Membership' or 'Partner' or 'BuyDocumentNegotiation' or 'Sender'\] } ``` [ { "InvoiceReference": "", "InvoiceNO": "", "InvoiceDate": "", "InvoiceTimezone": "", "Description": "", "Amount": 0, "InvoiceType": "" } ] ``` Response Content Type application/json #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 404 | Unable to find user or api key | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - ## [Document](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document) - [Show/Hide](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document) - List Operations - Expand Operations - Raw - - ### [delete](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/DeleteRequest) [/Document/{DocumentReference}](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/DeleteRequest) - [Delete the document](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/DeleteRequest) #### Implementation Notes Delete the document #### Response Class (Status ) - Model - Model Schema DocumentResponse { Name ( string): File Name, FormDirectReference ( string, optional): Form reference, Signers ( Array\[SignerStatusResponse\]): List of signers, Status ( string, optional) = \['Complete' or 'Declined' or 'Expired' or 'Rejected' or 'Signed' or 'Filling' or 'Filling Form' or 'InProgress' or 'Signing' or 'NotStart' or '# of # Signed'\]: Document signing status, DueDate ( Date, optional): Due Date of document, GMT ( string, optional): GMT Offset, LastSignedDate ( Date, optional): Date of latest signature, Folder ( Date, optional) = \['InBox' or 'Progress' or 'Signed'\]: The folder of the document, Logs ( Array\[DocumentLog\], optional): Document logs, HasFileUploaded ( boolean): Whether invitee uploaded any files during signing process., PackageReference ( string, optional): Package reference, ClientReference ( string, optional): client side referese; e.g. external id etc., EditUrl ( string, optional), IDVerificationRequested ( boolean): ID Verification requested., Reference ( string): Document reference, used for document access } SignerStatusResponse { HasSigned ( boolean): User signing status, DeclinedReason ( string, optional): Declined reason. Return only when invitee declined to sign., VideoConfirmationDetail ( VideoConfirmationDetail, optional), IDCheckStatus ( string, optional), IDVerificationStatus ( string, optional), IDVerificationResult ( string, optional), IDVerificationFaceMatchResult ( string, optional), IDVerificationLivenessResult ( string, optional), SigningKey ( string, optional): Url for access to signing; Only when this is an embedded signer, SignerReference ( string, optional): Signer reference, IsFaceToFaceSigning ( boolean), VideoConfirmationEnabled ( boolean), ReviewBeforeSigningEnabled ( boolean), MobileNumber ( string, optional): Mobile number of signer, for SMS secured forms. Must include the mobile carrier code e.g. Australia 04, New Zealand 027 or 021 etc, MobileCountry ( string, optional): Mobile Country code for phone number e.g. Australia 61, New Zealand 64 etc, ShareUsers ( Array\[ShareUser\], optional), ClientReference ( string, optional), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } VideoConfirmationDetail { Name ( string, optional), ShortUrl ( string, optional), IsVideoReady ( boolean), Password ( string, optional), Email ( string, optional), IsWitness ( boolean), IsVideoDisabled ( boolean), IsVideoOptOut ( boolean), WitnessOwner ( string, optional) } ShareUser { IsDefault ( boolean), IsOwner ( boolean), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } DocumentLog { Name ( string, optional): Name of user responsible for action, Action ( string, optional): Log entry, Date ( date, optional): Date of log entry, GMT ( string, optional): GMT Offset, Role ( string, optional): Role of user responsible for action } ``` { "Name": "", "FormDirectReference": "", "Signers": [ { "HasSigned": false, "DeclinedReason": "", "VideoConfirmationDetail": { "Name": "", "ShortUrl": "", "IsVideoReady": false, "Password": "", "Email": "", "IsWitness": false, "IsVideoDisabled": false, "IsVideoOptOut": false, "WitnessOwner": "" }, "IDCheckStatus": "", "IDVerificationStatus": "", "IDVerificationResult": "", "IDVerificationFaceMatchResult": "", "IDVerificationLivenessResult": "", "SigningKey": "", "SignerReference": "", "IsFaceToFaceSigning": false, "VideoConfirmationEnabled": false, "ReviewBeforeSigningEnabled": false, "MobileNumber": "", "MobileCountry": "", "ShareUsers": [ { "IsDefault": false, "IsOwner": false, "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "ClientReference": "", "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "Status": "", "DueDate": "Date", "GMT": "", "LastSignedDate": "Date", "Folder": "Date", "Logs": [ { "Name": "", "Action": "", "Date": "date", "GMT": "", "Role": "" } ], "HasFileUploaded": false, "PackageReference": "", "ClientReference": "", "EditUrl": "", "IDVerificationRequested": false, "Reference": "" } ``` Response Content Type application/json #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | DocumentReference | | **Document reference** | path | string | | RemoveFromPackage | true false | If the document is part of package, delete this whole package or just remove this document. | query | boolean | #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 401 | Unauthorised: Check your api key | | | 404 | Unable to find document, please check reference | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [post](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/CombineRequest) [/Document/Combine](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/CombineRequest) - [Returns a combined document](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/CombineRequest) #### Implementation Notes Returns a document reference for the combined documents #### Response Class (Status ) - Model - Model Schema DocumentReferenceResponse { Reference ( string): Document reference, used for document access } ``` { "Reference": "" } ``` Response Content Type application/json #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | Folder | InBox | Put the combined file in a folder; Only 'InBox' supported; if put in inbox, the document will be charged and visible in web portal; by default, the document is in an invisible temporary folder and can only be used via API. | body | string | #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 401 | Unauthorised: Check your api key | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [post](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/DeleteRequest_0) [/Document/Delete/{DocumentReference}](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/DeleteRequest_0) - [Delete the document](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/DeleteRequest_0) #### Implementation Notes Delete the document #### Response Class (Status ) - Model - Model Schema DocumentResponse { Name ( string): File Name, FormDirectReference ( string, optional): Form reference, Signers ( Array\[SignerStatusResponse\]): List of signers, Status ( string, optional) = \['Complete' or 'Declined' or 'Expired' or 'Rejected' or 'Signed' or 'Filling' or 'Filling Form' or 'InProgress' or 'Signing' or 'NotStart' or '# of # Signed'\]: Document signing status, DueDate ( Date, optional): Due Date of document, GMT ( string, optional): GMT Offset, LastSignedDate ( Date, optional): Date of latest signature, Folder ( Date, optional) = \['InBox' or 'Progress' or 'Signed'\]: The folder of the document, Logs ( Array\[DocumentLog\], optional): Document logs, HasFileUploaded ( boolean): Whether invitee uploaded any files during signing process., PackageReference ( string, optional): Package reference, ClientReference ( string, optional): client side referese; e.g. external id etc., EditUrl ( string, optional), IDVerificationRequested ( boolean): ID Verification requested., Reference ( string): Document reference, used for document access } SignerStatusResponse { HasSigned ( boolean): User signing status, DeclinedReason ( string, optional): Declined reason. Return only when invitee declined to sign., VideoConfirmationDetail ( VideoConfirmationDetail, optional), IDCheckStatus ( string, optional), IDVerificationStatus ( string, optional), IDVerificationResult ( string, optional), IDVerificationFaceMatchResult ( string, optional), IDVerificationLivenessResult ( string, optional), SigningKey ( string, optional): Url for access to signing; Only when this is an embedded signer, SignerReference ( string, optional): Signer reference, IsFaceToFaceSigning ( boolean), VideoConfirmationEnabled ( boolean), ReviewBeforeSigningEnabled ( boolean), MobileNumber ( string, optional): Mobile number of signer, for SMS secured forms. Must include the mobile carrier code e.g. Australia 04, New Zealand 027 or 021 etc, MobileCountry ( string, optional): Mobile Country code for phone number e.g. Australia 61, New Zealand 64 etc, ShareUsers ( Array\[ShareUser\], optional), ClientReference ( string, optional), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } VideoConfirmationDetail { Name ( string, optional), ShortUrl ( string, optional), IsVideoReady ( boolean), Password ( string, optional), Email ( string, optional), IsWitness ( boolean), IsVideoDisabled ( boolean), IsVideoOptOut ( boolean), WitnessOwner ( string, optional) } ShareUser { IsDefault ( boolean), IsOwner ( boolean), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } DocumentLog { Name ( string, optional): Name of user responsible for action, Action ( string, optional): Log entry, Date ( date, optional): Date of log entry, GMT ( string, optional): GMT Offset, Role ( string, optional): Role of user responsible for action } ``` { "Name": "", "FormDirectReference": "", "Signers": [ { "HasSigned": false, "DeclinedReason": "", "VideoConfirmationDetail": { "Name": "", "ShortUrl": "", "IsVideoReady": false, "Password": "", "Email": "", "IsWitness": false, "IsVideoDisabled": false, "IsVideoOptOut": false, "WitnessOwner": "" }, "IDCheckStatus": "", "IDVerificationStatus": "", "IDVerificationResult": "", "IDVerificationFaceMatchResult": "", "IDVerificationLivenessResult": "", "SigningKey": "", "SignerReference": "", "IsFaceToFaceSigning": false, "VideoConfirmationEnabled": false, "ReviewBeforeSigningEnabled": false, "MobileNumber": "", "MobileCountry": "", "ShareUsers": [ { "IsDefault": false, "IsOwner": false, "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "ClientReference": "", "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "Status": "", "DueDate": "Date", "GMT": "", "LastSignedDate": "Date", "Folder": "Date", "Logs": [ { "Name": "", "Action": "", "Date": "date", "GMT": "", "Role": "" } ], "HasFileUploaded": false, "PackageReference": "", "ClientReference": "", "EditUrl": "", "IDVerificationRequested": false, "Reference": "" } ``` Response Content Type application/json #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | DocumentReference | | **Document reference** | path | string | | RemoveFromPackage | true false | If the document is part of package, delete this whole package or just remove this document. | query | boolean | | body | Parameter content type: application/json | | body | - Model - Model Schema DeleteRequest { DocumentReference ( string): Document reference, RemoveFromPackage ( boolean): If the document is part of package, delete this whole package or just remove this document. } ``` { "DocumentReference": "", "RemoveFromPackage": false } ``` Click to set as parameter value | #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 401 | Unauthorised: Check your api key | | | 404 | Unable to find document, please check reference | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [post](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/ExtendRequest) [/Document/Extend](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/ExtendRequest) - [Extend the document due date](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/ExtendRequest) #### Implementation Notes Extend the document due date; for all document in same package. #### Response Class (Status ) - Model - Model Schema DocumentResponse { Name ( string): File Name, FormDirectReference ( string, optional): Form reference, Signers ( Array\[SignerStatusResponse\]): List of signers, Status ( string, optional) = \['Complete' or 'Declined' or 'Expired' or 'Rejected' or 'Signed' or 'Filling' or 'Filling Form' or 'InProgress' or 'Signing' or 'NotStart' or '# of # Signed'\]: Document signing status, DueDate ( Date, optional): Due Date of document, GMT ( string, optional): GMT Offset, LastSignedDate ( Date, optional): Date of latest signature, Folder ( Date, optional) = \['InBox' or 'Progress' or 'Signed'\]: The folder of the document, Logs ( Array\[DocumentLog\], optional): Document logs, HasFileUploaded ( boolean): Whether invitee uploaded any files during signing process., PackageReference ( string, optional): Package reference, ClientReference ( string, optional): client side referese; e.g. external id etc., EditUrl ( string, optional), IDVerificationRequested ( boolean): ID Verification requested., Reference ( string): Document reference, used for document access } SignerStatusResponse { HasSigned ( boolean): User signing status, DeclinedReason ( string, optional): Declined reason. Return only when invitee declined to sign., VideoConfirmationDetail ( VideoConfirmationDetail, optional), IDCheckStatus ( string, optional), IDVerificationStatus ( string, optional), IDVerificationResult ( string, optional), IDVerificationFaceMatchResult ( string, optional), IDVerificationLivenessResult ( string, optional), SigningKey ( string, optional): Url for access to signing; Only when this is an embedded signer, SignerReference ( string, optional): Signer reference, IsFaceToFaceSigning ( boolean), VideoConfirmationEnabled ( boolean), ReviewBeforeSigningEnabled ( boolean), MobileNumber ( string, optional): Mobile number of signer, for SMS secured forms. Must include the mobile carrier code e.g. Australia 04, New Zealand 027 or 021 etc, MobileCountry ( string, optional): Mobile Country code for phone number e.g. Australia 61, New Zealand 64 etc, ShareUsers ( Array\[ShareUser\], optional), ClientReference ( string, optional), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } VideoConfirmationDetail { Name ( string, optional), ShortUrl ( string, optional), IsVideoReady ( boolean), Password ( string, optional), Email ( string, optional), IsWitness ( boolean), IsVideoDisabled ( boolean), IsVideoOptOut ( boolean), WitnessOwner ( string, optional) } ShareUser { IsDefault ( boolean), IsOwner ( boolean), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } DocumentLog { Name ( string, optional): Name of user responsible for action, Action ( string, optional): Log entry, Date ( date, optional): Date of log entry, GMT ( string, optional): GMT Offset, Role ( string, optional): Role of user responsible for action } ``` { "Name": "", "FormDirectReference": "", "Signers": [ { "HasSigned": false, "DeclinedReason": "", "VideoConfirmationDetail": { "Name": "", "ShortUrl": "", "IsVideoReady": false, "Password": "", "Email": "", "IsWitness": false, "IsVideoDisabled": false, "IsVideoOptOut": false, "WitnessOwner": "" }, "IDCheckStatus": "", "IDVerificationStatus": "", "IDVerificationResult": "", "IDVerificationFaceMatchResult": "", "IDVerificationLivenessResult": "", "SigningKey": "", "SignerReference": "", "IsFaceToFaceSigning": false, "VideoConfirmationEnabled": false, "ReviewBeforeSigningEnabled": false, "MobileNumber": "", "MobileCountry": "", "ShareUsers": [ { "IsDefault": false, "IsOwner": false, "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "ClientReference": "", "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "Status": "", "DueDate": "Date", "GMT": "", "LastSignedDate": "Date", "Folder": "Date", "Logs": [ { "Name": "", "Action": "", "Date": "date", "GMT": "", "Role": "" } ], "HasFileUploaded": false, "PackageReference": "", "ClientReference": "", "EditUrl": "", "IDVerificationRequested": false, "Reference": "" } ``` Response Content Type application/json #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | body | Parameter content type: application/json | | body | - Model - Model Schema ExtendRequest { DocumentReference ( string): Document reference, DueDate ( Date): The ISO 8601 formats is the better way to pass the due date to API; otherwise API will try to parse the date string according to user's settings. If it can not be identified, an error will return, GMT ( string, optional): The total minutes of the offset between your local time to UTC time. If it's not specified, user's settings will be applied. If the date is UTC time already, set it as 0. } ``` { "DocumentReference": "", "DueDate": "Date", "GMT": "" } ``` Click to set as parameter value | #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 401 | Unauthorised: Check your api key | | | 404 | Unable to find document, please check reference | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [get](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/FieldDataRequest) [/Document/FieldData/{DocumentReference}](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/FieldDataRequest) - [Get field data in documents](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/FieldDataRequest) #### Implementation Notes Get field data in documents #### Response Class (Status ) - Model - Model Schema FormFillerField { Label ( string): Field label, Value ( string): Field value, FieldType ( string) = \['Text' or 'MultiLineText' or 'CheckBox' or 'DropDownList' or 'DateInput'\]: Field type, IsRequired ( boolean): If field is mandatory, ID ( string): Field reference; Obsolated, use Reference instead., Reference ( string): Field reference;, ReadOnly ( boolean): If field is readonly, ClientField ( boolean): Field name on client side } ``` [ { "Label": "", "Value": "", "FieldType": "", "IsRequired": false, "ID": "", "Reference": "", "ReadOnly": false, "ClientField": false } ] ``` Response Content Type application/json #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | DocumentReference | | **Document reference** | path | string | #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 401 | Unauthorised: Check your api key | | | 404 | Document not found, may have been removed | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [post](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/DocumentFileValidationRequest) [/Document/FileValidation](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/DocumentFileValidationRequest) - [validate document](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/DocumentFileValidationRequest) #### Implementation Notes Verifies the signatures in document. The document may not be found due to it being removed from Secured Signing according to our data retention policy. #### Response Class (Status ) - Model - Model Schema DocumentValidationResponse { Signatures ( Array\[VerifySignature\], optional), DocumentURL ( string, optional), DocumentName ( string, optional) } VerifySignature { isValid ( boolean), SignatureTime ( string, optional), User ( string, optional), Signer ( VerifiedSignerResponse, optional) } VerifiedSignerResponse { FirstName ( string): First name of user, LastName ( string): Last name of user, Email ( string): Email address of user, Title ( string, optional), Reason ( string, optional), Company ( string, optional) } ``` { "Signatures": [ { "isValid": false, "SignatureTime": "", "User": "", "Signer": { "FirstName": "", "LastName": "", "Email": "", "Title": "", "Reason": "", "Company": "" } } ], "DocumentURL": "", "DocumentName": "" } ``` Response Content Type application/json #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | body | | | body | file | #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 401 | Unauthorised: Check your api key | | | 404 | Document not found, may have been removed | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [get](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/GetActiveDocumentsRequest) [/Document/GetActiveDocuments/{Folder}](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/GetActiveDocumentsRequest) - [Returns account user's active documents](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/GetActiveDocumentsRequest) #### Implementation Notes Returns an array of all In progress and signed documents that haven't been removed. #### Response Class (Status ) - Model - Model Schema DocumentResponse { Name ( string): File Name, FormDirectReference ( string, optional): Form reference, Signers ( Array\[SignerStatusResponse\]): List of signers, Status ( string, optional) = \['Complete' or 'Declined' or 'Expired' or 'Rejected' or 'Signed' or 'Filling' or 'Filling Form' or 'InProgress' or 'Signing' or 'NotStart' or '# of # Signed'\]: Document signing status, DueDate ( Date, optional): Due Date of document, GMT ( string, optional): GMT Offset, LastSignedDate ( Date, optional): Date of latest signature, Folder ( Date, optional) = \['InBox' or 'Progress' or 'Signed'\]: The folder of the document, Logs ( Array\[DocumentLog\], optional): Document logs, HasFileUploaded ( boolean): Whether invitee uploaded any files during signing process., PackageReference ( string, optional): Package reference, ClientReference ( string, optional): client side referese; e.g. external id etc., EditUrl ( string, optional), IDVerificationRequested ( boolean): ID Verification requested., Reference ( string): Document reference, used for document access } SignerStatusResponse { HasSigned ( boolean): User signing status, DeclinedReason ( string, optional): Declined reason. Return only when invitee declined to sign., VideoConfirmationDetail ( VideoConfirmationDetail, optional), IDCheckStatus ( string, optional), IDVerificationStatus ( string, optional), IDVerificationResult ( string, optional), IDVerificationFaceMatchResult ( string, optional), IDVerificationLivenessResult ( string, optional), SigningKey ( string, optional): Url for access to signing; Only when this is an embedded signer, SignerReference ( string, optional): Signer reference, IsFaceToFaceSigning ( boolean), VideoConfirmationEnabled ( boolean), ReviewBeforeSigningEnabled ( boolean), MobileNumber ( string, optional): Mobile number of signer, for SMS secured forms. Must include the mobile carrier code e.g. Australia 04, New Zealand 027 or 021 etc, MobileCountry ( string, optional): Mobile Country code for phone number e.g. Australia 61, New Zealand 64 etc, ShareUsers ( Array\[ShareUser\], optional), ClientReference ( string, optional), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } VideoConfirmationDetail { Name ( string, optional), ShortUrl ( string, optional), IsVideoReady ( boolean), Password ( string, optional), Email ( string, optional), IsWitness ( boolean), IsVideoDisabled ( boolean), IsVideoOptOut ( boolean), WitnessOwner ( string, optional) } ShareUser { IsDefault ( boolean), IsOwner ( boolean), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } DocumentLog { Name ( string, optional): Name of user responsible for action, Action ( string, optional): Log entry, Date ( date, optional): Date of log entry, GMT ( string, optional): GMT Offset, Role ( string, optional): Role of user responsible for action } ``` [ { "Name": "", "FormDirectReference": "", "Signers": [ { "HasSigned": false, "DeclinedReason": "", "VideoConfirmationDetail": { "Name": "", "ShortUrl": "", "IsVideoReady": false, "Password": "", "Email": "", "IsWitness": false, "IsVideoDisabled": false, "IsVideoOptOut": false, "WitnessOwner": "" }, "IDCheckStatus": "", "IDVerificationStatus": "", "IDVerificationResult": "", "IDVerificationFaceMatchResult": "", "IDVerificationLivenessResult": "", "SigningKey": "", "SignerReference": "", "IsFaceToFaceSigning": false, "VideoConfirmationEnabled": false, "ReviewBeforeSigningEnabled": false, "MobileNumber": "", "MobileCountry": "", "ShareUsers": [ { "IsDefault": false, "IsOwner": false, "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "ClientReference": "", "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "Status": "", "DueDate": "Date", "GMT": "", "LastSignedDate": "Date", "Folder": "Date", "Logs": [ { "Name": "", "Action": "", "Date": "date", "GMT": "", "Role": "" } ], "HasFileUploaded": false, "PackageReference": "", "ClientReference": "", "EditUrl": "", "IDVerificationRequested": false, "Reference": "" } ] ``` Response Content Type application/json #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | Folder | InBox Progress Signed | | path | string | | DocumentLog | true false | wheather return with documeng log | query | boolean | #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 401 | Unauthorised: Check your api key | | | 404 | Document not found, may have been removed | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [get](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/GetDocumentUrlRequest) [/Document/GetDocumentUrl/{DocumentReference}](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/GetDocumentUrlRequest) - [Returns a url for downloading a document](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/GetDocumentUrlRequest) #### Implementation Notes Returns the download URL for that document. The document may not be found due to it being removed from Secured Signing according to our data retention policy. #### Response Class (Status ) - Model - Model Schema DocumentUrlResponse { Url ( string, optional): Url which file content will be downloaded from } ``` { "Url": "" } ``` Response Content Type application/json #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | DocumentReference | | **Document reference** | path | string | #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 401 | Unauthorised: Check your api key | | | 404 | Document not found, may have been removed | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [get](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/LogRequest) [/Document/Log/{DocumentReference}](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/LogRequest) - [Return a document log](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/LogRequest) #### Implementation Notes Returns a collection of document logs #### Response Class (Status ) - Model - Model Schema DocumentLog { Name ( string, optional): Name of user responsible for action, Action ( string, optional): Log entry, Date ( date, optional): Date of log entry, GMT ( string, optional): GMT Offset, Role ( string, optional): Role of user responsible for action } ``` [ { "Name": "", "Action": "", "Date": "date", "GMT": "", "Role": "" } ] ``` Response Content Type application/json #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | DocumentReference | | **Document reference** | path | string | #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 401 | Unauthorised: Check your api key | | | 404 | Unable to find document, please check reference | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [post](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/SendReminderRequest) [/Document/SendReminder](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/SendReminderRequest) - [Send invitation reminder to invitee](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/SendReminderRequest) #### Implementation Notes Send invitation reminder to invitee #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | body | Parameter content type: application/json | | body | - Model - Model Schema SendReminderRequest { DocumentReference ( string): Document reference, SignerReference ( string): Signer reference } ``` { "DocumentReference": "", "SignerReference": "" } ``` Click to set as parameter value | #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 401 | Unauthorised: Check your api key | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [get](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/DownloadSigningCompletionCertificateDataRequest) [/Document/SigningCompletionCertificate/{DocumentReference}](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/DownloadSigningCompletionCertificateDataRequest) - [Returns array of all certificates for this document](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/DownloadSigningCompletionCertificateDataRequest) #### Implementation Notes Returns metadata only. #### Response Class (Status ) - Model - Model Schema SigningCompletionCertificateResponse { CertificateReference ( string, optional), SigningDate ( Date), Status ( string, optional), DownloadURL ( string, optional) } ``` [ { "CertificateReference": "", "SigningDate": "Date", "Status": "", "DownloadURL": "" } ] ``` Response Content Type application/json #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | DocumentReference | | **Document reference** | path | string | #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 401 | Unauthorised: Check your api key | | | 404 | Certificates not found | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [get](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/StatusRequest) [/Document/Status/{DocumentReference}](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/StatusRequest) - [Return current document status](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/StatusRequest) #### Implementation Notes Returns a string containing the current status of a document #### Response Class (Status ) - Model - Model Schema DocumentResponse { Name ( string): File Name, FormDirectReference ( string, optional): Form reference, Signers ( Array\[SignerStatusResponse\]): List of signers, Status ( string, optional) = \['Complete' or 'Declined' or 'Expired' or 'Rejected' or 'Signed' or 'Filling' or 'Filling Form' or 'InProgress' or 'Signing' or 'NotStart' or '# of # Signed'\]: Document signing status, DueDate ( Date, optional): Due Date of document, GMT ( string, optional): GMT Offset, LastSignedDate ( Date, optional): Date of latest signature, Folder ( Date, optional) = \['InBox' or 'Progress' or 'Signed'\]: The folder of the document, Logs ( Array\[DocumentLog\], optional): Document logs, HasFileUploaded ( boolean): Whether invitee uploaded any files during signing process., PackageReference ( string, optional): Package reference, ClientReference ( string, optional): client side referese; e.g. external id etc., EditUrl ( string, optional), IDVerificationRequested ( boolean): ID Verification requested., Reference ( string): Document reference, used for document access } SignerStatusResponse { HasSigned ( boolean): User signing status, DeclinedReason ( string, optional): Declined reason. Return only when invitee declined to sign., VideoConfirmationDetail ( VideoConfirmationDetail, optional), IDCheckStatus ( string, optional), IDVerificationStatus ( string, optional), IDVerificationResult ( string, optional), IDVerificationFaceMatchResult ( string, optional), IDVerificationLivenessResult ( string, optional), SigningKey ( string, optional): Url for access to signing; Only when this is an embedded signer, SignerReference ( string, optional): Signer reference, IsFaceToFaceSigning ( boolean), VideoConfirmationEnabled ( boolean), ReviewBeforeSigningEnabled ( boolean), MobileNumber ( string, optional): Mobile number of signer, for SMS secured forms. Must include the mobile carrier code e.g. Australia 04, New Zealand 027 or 021 etc, MobileCountry ( string, optional): Mobile Country code for phone number e.g. Australia 61, New Zealand 64 etc, ShareUsers ( Array\[ShareUser\], optional), ClientReference ( string, optional), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } VideoConfirmationDetail { Name ( string, optional), ShortUrl ( string, optional), IsVideoReady ( boolean), Password ( string, optional), Email ( string, optional), IsWitness ( boolean), IsVideoDisabled ( boolean), IsVideoOptOut ( boolean), WitnessOwner ( string, optional) } ShareUser { IsDefault ( boolean), IsOwner ( boolean), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } DocumentLog { Name ( string, optional): Name of user responsible for action, Action ( string, optional): Log entry, Date ( date, optional): Date of log entry, GMT ( string, optional): GMT Offset, Role ( string, optional): Role of user responsible for action } ``` { "Name": "", "FormDirectReference": "", "Signers": [ { "HasSigned": false, "DeclinedReason": "", "VideoConfirmationDetail": { "Name": "", "ShortUrl": "", "IsVideoReady": false, "Password": "", "Email": "", "IsWitness": false, "IsVideoDisabled": false, "IsVideoOptOut": false, "WitnessOwner": "" }, "IDCheckStatus": "", "IDVerificationStatus": "", "IDVerificationResult": "", "IDVerificationFaceMatchResult": "", "IDVerificationLivenessResult": "", "SigningKey": "", "SignerReference": "", "IsFaceToFaceSigning": false, "VideoConfirmationEnabled": false, "ReviewBeforeSigningEnabled": false, "MobileNumber": "", "MobileCountry": "", "ShareUsers": [ { "IsDefault": false, "IsOwner": false, "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "ClientReference": "", "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "Status": "", "DueDate": "Date", "GMT": "", "LastSignedDate": "Date", "Folder": "Date", "Logs": [ { "Name": "", "Action": "", "Date": "date", "GMT": "", "Role": "" } ], "HasFileUploaded": false, "PackageReference": "", "ClientReference": "", "EditUrl": "", "IDVerificationRequested": false, "Reference": "" } ``` Response Content Type application/json #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | DocumentReference | | **Document reference** | path | string | | DocumentLog | true false | wheather return with documeng log | query | boolean | #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 401 | Unauthorised: Check your api key | | | 404 | Unable to find document, please check reference | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [post](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/UpdateSignerRequest) [/Document/UpdateSigner](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/UpdateSignerRequest) - [Update signer profile](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/UpdateSignerRequest) #### Implementation Notes Update signer profile #### Response Class (Status ) - Model - Model Schema DocumentResponse { Name ( string): File Name, FormDirectReference ( string, optional): Form reference, Signers ( Array\[SignerStatusResponse\]): List of signers, Status ( string, optional) = \['Complete' or 'Declined' or 'Expired' or 'Rejected' or 'Signed' or 'Filling' or 'Filling Form' or 'InProgress' or 'Signing' or 'NotStart' or '# of # Signed'\]: Document signing status, DueDate ( Date, optional): Due Date of document, GMT ( string, optional): GMT Offset, LastSignedDate ( Date, optional): Date of latest signature, Folder ( Date, optional) = \['InBox' or 'Progress' or 'Signed'\]: The folder of the document, Logs ( Array\[DocumentLog\], optional): Document logs, HasFileUploaded ( boolean): Whether invitee uploaded any files during signing process., PackageReference ( string, optional): Package reference, ClientReference ( string, optional): client side referese; e.g. external id etc., EditUrl ( string, optional), IDVerificationRequested ( boolean): ID Verification requested., Reference ( string): Document reference, used for document access } SignerStatusResponse { HasSigned ( boolean): User signing status, DeclinedReason ( string, optional): Declined reason. Return only when invitee declined to sign., VideoConfirmationDetail ( VideoConfirmationDetail, optional), IDCheckStatus ( string, optional), IDVerificationStatus ( string, optional), IDVerificationResult ( string, optional), IDVerificationFaceMatchResult ( string, optional), IDVerificationLivenessResult ( string, optional), SigningKey ( string, optional): Url for access to signing; Only when this is an embedded signer, SignerReference ( string, optional): Signer reference, IsFaceToFaceSigning ( boolean), VideoConfirmationEnabled ( boolean), ReviewBeforeSigningEnabled ( boolean), MobileNumber ( string, optional): Mobile number of signer, for SMS secured forms. Must include the mobile carrier code e.g. Australia 04, New Zealand 027 or 021 etc, MobileCountry ( string, optional): Mobile Country code for phone number e.g. Australia 61, New Zealand 64 etc, ShareUsers ( Array\[ShareUser\], optional), ClientReference ( string, optional), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } VideoConfirmationDetail { Name ( string, optional), ShortUrl ( string, optional), IsVideoReady ( boolean), Password ( string, optional), Email ( string, optional), IsWitness ( boolean), IsVideoDisabled ( boolean), IsVideoOptOut ( boolean), WitnessOwner ( string, optional) } ShareUser { IsDefault ( boolean), IsOwner ( boolean), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } DocumentLog { Name ( string, optional): Name of user responsible for action, Action ( string, optional): Log entry, Date ( date, optional): Date of log entry, GMT ( string, optional): GMT Offset, Role ( string, optional): Role of user responsible for action } ``` { "Name": "", "FormDirectReference": "", "Signers": [ { "HasSigned": false, "DeclinedReason": "", "VideoConfirmationDetail": { "Name": "", "ShortUrl": "", "IsVideoReady": false, "Password": "", "Email": "", "IsWitness": false, "IsVideoDisabled": false, "IsVideoOptOut": false, "WitnessOwner": "" }, "IDCheckStatus": "", "IDVerificationStatus": "", "IDVerificationResult": "", "IDVerificationFaceMatchResult": "", "IDVerificationLivenessResult": "", "SigningKey": "", "SignerReference": "", "IsFaceToFaceSigning": false, "VideoConfirmationEnabled": false, "ReviewBeforeSigningEnabled": false, "MobileNumber": "", "MobileCountry": "", "ShareUsers": [ { "IsDefault": false, "IsOwner": false, "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "ClientReference": "", "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "Status": "", "DueDate": "Date", "GMT": "", "LastSignedDate": "Date", "Folder": "Date", "Logs": [ { "Name": "", "Action": "", "Date": "date", "GMT": "", "Role": "" } ], "HasFileUploaded": false, "PackageReference": "", "ClientReference": "", "EditUrl": "", "IDVerificationRequested": false, "Reference": "" } ``` Response Content Type application/json #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | body | Parameter content type: application/json | | body | - Model - Model Schema UpdateSignerRequest { DocumentReference ( string): Document reference, Signers ( Array\[Signer\]): New signer information } Signer { SignerReference ( string, optional): Signer reference, IsFaceToFaceSigning ( boolean), VideoConfirmationEnabled ( boolean), ReviewBeforeSigningEnabled ( boolean), MobileNumber ( string, optional): Mobile number of signer, for SMS secured forms. Must include the mobile carrier code e.g. Australia 04, New Zealand 027 or 021 etc, MobileCountry ( string, optional): Mobile Country code for phone number e.g. Australia 61, New Zealand 64 etc, ShareUsers ( Array\[ShareUser\], optional), ClientReference ( string, optional), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } ShareUser { IsDefault ( boolean), IsOwner ( boolean), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } ``` { "DocumentReference": "", "Signers": [ { "SignerReference": "", "IsFaceToFaceSigning": false, "VideoConfirmationEnabled": false, "ReviewBeforeSigningEnabled": false, "MobileNumber": "", "MobileCountry": "", "ShareUsers": [ { "IsDefault": false, "IsOwner": false, "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "ClientReference": "", "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ] } ``` Click to set as parameter value | #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 401 | Unauthorised: Check your api key | | | 404 | Unable to find document, please check reference | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [post](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/UploadRequest) [/Document/UploadByUrl](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/UploadRequest) - [Uploads a file by url](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/UploadRequest) #### Implementation Notes Uploads a file using a url #### Response Class (Status ) - Model - Model Schema DocumentReferenceResponse { Reference ( string): Document reference, used for document access } ``` { "Reference": "" } ``` Response Content Type application/json #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | File | Parameter content type: application/json | **The file infomation** | body | - Model - Model Schema FileInfo { ClientReference ( string, optional): The reference of the document on client side, Name ( string): File Name, FileType ( string) = \['pdf' or 'doc' or 'docx' or 'rtf'\]: File type of file, FileUrl ( string): Url to download retrieve file data } ``` { "ClientReference": "", "Name": "", "FileType": "", "FileUrl": "" } ``` Click to set as parameter value | | Folder | InBox | Upload the file and put in a folder; Only 'InBox' supported; if put in inbox, the document will be charged and visible in web portal; by default, the document is in an invisible temporary folder and can only be used via API. | body | string | #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 401 | Unauthorised: Check your api key | | | 404 | Document not found, check uploaded file name matches file name in data | | | 413 | File is too large | | | 426 | Not enough documents left in plan | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [post](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/UploaderRequest) [/Document/Uploader](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/UploaderRequest) - [Uploads a file by mulitpart form](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/UploaderRequest) #### Implementation Notes Uploads a file using multipart form type. Allowed FileTypes: .pdf, .doc, .docx, .odt, .rtf .xls, .xlsx, .ods, .txt, .gif, .jpeg, .jpg, .png, .bmp, .dcm, .svg, .tif, .tiff. #### Response Class (Status ) - Model - Model Schema DocumentReferenceResponse { Reference ( string): Document reference, used for document access } ``` { "Reference": "" } ``` Response Content Type application/json #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | body | | | body | file | | ClientReference | Parameter content type: | Client reference | body | string | | Folder | InBox | Upload the file and put in a folder; Only 'InBox' supported; if put in inbox, the document will be charged and visible in web portal; by default, the document is in an invisible temporary folder and can only be used via API. | body | string | #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 401 | Unauthorised: Check your api key | | | 404 | Document not found, check uploaded file name matches file name in data | | | 413 | File is too large | | | 426 | Not enough documents left in plan | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [post](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/Uploader2Request) [/Document/Uploader/{ClientReference}](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/Uploader2Request) - [Uploads a file with client reference by mulitpart form](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/Uploader2Request) #### Implementation Notes Uploads a file using multipart form type. Allowed FileTypes: .gif,.jpeg,.jpg,.png,.bmp,.dcm,.svg,.tif,.tiff,.doc,.docx,.odt,.ods,.xls,.xlsx,.pdf,.rtf,.txt. #### Response Class (Status ) - Model - Model Schema DocumentReferenceResponse { Reference ( string): Document reference, used for document access } ``` { "Reference": "" } ``` Response Content Type application/json #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | ClientReference | | Client reference | path | string | | body | Parameter content type: | | body | - Model - Model Schema Uploader2Request { ClientReference ( string, optional): Client reference, AnyThing ( file), Folder ( string, optional) = \['InBox'\]: Upload the file and put in a folder; Only 'InBox' supported; if put in inbox, the document will be charged and visible in web portal; by default, the document is in an invisible temporary folder and can only be used via API. } ``` { "ClientReference": "", "AnyThing": "file", "Folder": "" } ``` Click to set as parameter value | #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 401 | Unauthorised: Check your api key | | | 404 | Document not found, check uploaded file name matches file name in data | | | 413 | File is too large | | | 426 | Not enough documents left in plan | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [get](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/DocumentValidationRequest) [/Document/Validation/{DocumentReference}](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/DocumentValidationRequest) - [validate document](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Document/DocumentValidationRequest) #### Implementation Notes Verifies the signatures in document. The document may not be found due to it being removed from Secured Signing according to our data retention policy. #### Response Class (Status ) - Model - Model Schema DocumentValidationResponse { Signatures ( Array\[VerifySignature\], optional), DocumentURL ( string, optional), DocumentName ( string, optional) } VerifySignature { isValid ( boolean), SignatureTime ( string, optional), User ( string, optional), Signer ( VerifiedSignerResponse, optional) } VerifiedSignerResponse { FirstName ( string): First name of user, LastName ( string): Last name of user, Email ( string): Email address of user, Title ( string, optional), Reason ( string, optional), Company ( string, optional) } ``` { "Signatures": [ { "isValid": false, "SignatureTime": "", "User": "", "Signer": { "FirstName": "", "LastName": "", "Email": "", "Title": "", "Reason": "", "Company": "" } } ], "DocumentURL": "", "DocumentName": "" } ``` Response Content Type application/json #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | DocumentReference | | **Document reference** | path | string | #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 401 | Unauthorised: Check your api key | | | 404 | Document not found, may have been removed | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - ## [Download](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Download) - [Show/Hide](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Download) - List Operations - Expand Operations - Raw - - ### [get](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Download/DownloadAttachmentRequest) [/Download/Attachment/{AttachmentReference}](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Download/DownloadAttachmentRequest) - [Returns attachment file data](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Download/DownloadAttachmentRequest) #### Implementation Notes Returns attachment file data #### Response Class (Status ) - Model - Model Schema Object { } ``` {} ``` Response Content Type application/json #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | AttachmentReference | | **Document reference** | path | string | #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 401 | Unauthorised: Check your api key | | | 404 | Document not found, may have been removed | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [get](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Download/DownloadENotaryJournalRequest) [/Download/ENotaryJournal/{DocumentReference}/{ENotaryJournalDataType}](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Download/DownloadENotaryJournalRequest) - [Returns Notary journal data](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Download/DownloadENotaryJournalRequest) #### Implementation Notes Returns Notary journal data in pdf or json #### Response Class (Status ) - Model - Model Schema Object { } ``` {} ``` Response Content Type application/json #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | DocumentReference | | **Document reference** | path | string | | ENotaryJournalDataType | pdf json xlsx | ID Verification data return type | path | string | #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 401 | Unauthorised: Check your api key | | | 404 | Notary journal report not found | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [get](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Download/DownloadFormDataRequest) [/Download/FormData/{DocumentReference}/{FormDataFileType}](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Download/DownloadFormDataRequest) - [Get FormData for that specific Document](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Download/DownloadFormDataRequest) #### Implementation Notes choose different export options (csv, xls, xlsx, xml), if it has Xslt set for that Form, it will apply automatically. #### Response Class (Status ) - Model - Model Schema Object { } ``` {} ``` Response Content Type application/json #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | DocumentReference | | **Document reference** | path | string | | FormDataFileType | xml csv xlsx xls | Form data file return type | path | string | #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 401 | Unauthorised: Check your api key | | | 404 | Document not found, may have been removed | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [get](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Download/DownloadDocumentRequest) [/Download/GetDocumentData/{DocumentReference}](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Download/DownloadDocumentRequest) - [Returns document data](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Download/DownloadDocumentRequest) #### Implementation Notes Returns the document data as a stream. The document may not be found due to it being removed from Secured Signing according to our data retention policy. #### Response Class (Status ) - Model - Model Schema Object { } ``` {} ``` Response Content Type application/json #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | DocumentReference | | **Document reference** | path | string | #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 401 | Unauthorised: Check your api key | | | 404 | Document not found, may have been removed | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [get](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Download/DownloadUploadedFileRequest) [/Download/GetUploadedFileData/{DocumentReference}](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Download/DownloadUploadedFileRequest) - [Returns uploaded file data](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Download/DownloadUploadedFileRequest) #### Implementation Notes Returns the document data as a stream. The document may not be found due to it being removed from Secured Signing according to our data retention policy. #### Response Class (Status ) - Model - Model Schema Object { } ``` {} ``` Response Content Type application/json #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | DocumentReference | | **Document reference** | path | string | #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 401 | Unauthorised: Check your api key | | | 404 | Document not found, may have been removed | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [get](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Download/DownloadIDVerificationRequest) [/Download/IDVerification/{DocumentReference}/{IDVerificationDataType}](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Download/DownloadIDVerificationRequest) - [Returns ID Verification data](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Download/DownloadIDVerificationRequest) #### Implementation Notes Returns ID Verification data in pdf or json #### Response Class (Status ) - Model - Model Schema IdVisualCheckInfo { ExamingDate ( string, optional), DocClass ( string, optional), PortraitImage ( string, optional), FrontIDImage ( string, optional), BackIDImage ( string, optional), SelectedIDImage ( string, optional), SelectedFrontIDImage ( boolean), FirstName ( string, optional), MiddleName ( string, optional), LastName ( string, optional), DOB ( string, optional), DocumentNumber ( string, optional), ExpirationDate ( string, optional), IssuingState ( string, optional), Country ( string, optional), FaceMatchResult ( string, optional), FaceMatchScore ( string, optional), FaceErrorMessage ( string, optional), IsPassed ( boolean), UserFirstName ( string, optional), UserMiddleName ( string, optional), UserLastName ( string, optional), Attentions ( Array\[Attention\], optional), DocId ( string, optional) } Attention { Name ( string, optional), Detail ( string, optional) } ``` [ { "ExamingDate": "", "DocClass": "", "PortraitImage": "", "FrontIDImage": "", "BackIDImage": "", "SelectedIDImage": "", "SelectedFrontIDImage": false, "FirstName": "", "MiddleName": "", "LastName": "", "DOB": "", "DocumentNumber": "", "ExpirationDate": "", "IssuingState": "", "Country": "", "FaceMatchResult": "", "FaceMatchScore": "", "FaceErrorMessage": "", "IsPassed": false, "UserFirstName": "", "UserMiddleName": "", "UserLastName": "", "Attentions": [ { "Name": "", "Detail": "" } ], "DocId": "" } ] ``` Response Content Type application/json #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | DocumentReference | | **Document reference** | path | string | | IDVerificationDataType | pdf json | ID Verification data return type | path | string | #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 401 | Unauthorised: Check your api key | | | 404 | ID Verification report not found | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [get](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Download/DownloadInvoiceRequest) [/Download/Invoice/{InvoiceReference}](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Download/DownloadInvoiceRequest) - [Returns invoice file data](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Download/DownloadInvoiceRequest) #### Implementation Notes Returns invoice file data #### Response Class (Status ) - Model - Model Schema Object { } ``` {} ``` Response Content Type application/json #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | InvoiceReference | | **Invoice reference** | path | string | #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 401 | Unauthorised: Check your api key | | | 404 | Invoice not found, may not issued or no payment needed | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [get](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Download/DownloadSigningCompletionCertificateRequest) [/Download/SigningCompletionCertificate/{CertificateReference}](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Download/DownloadSigningCompletionCertificateRequest) - [Returns the specified Signing Completion Certificate](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Download/DownloadSigningCompletionCertificateRequest) #### Response Class (Status ) - Model - Model Schema Object { } ``` {} ``` Response Content Type application/json #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | CertificateReference | | **Signing Completion Certificate reference** | path | string | #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 401 | Unauthorised: Check your api key | | | 404 | Certificate not found | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [get](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Download/DownloadCapturedImagesRequest) [/Download/Snapshot/{DocumentReference}](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Download/DownloadCapturedImagesRequest) - [Returns the specified captured images](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Download/DownloadCapturedImagesRequest) #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | DocumentReference | | **Document reference** | path | string | #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 401 | Unauthorised: Check your api key | | | 404 | Captured image not found | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [get](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Download/DownloadVideoSigningRecordingRequest) [/Download/VideoSigningRecording/{DocumentReference}](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Download/DownloadVideoSigningRecordingRequest) - [Returns Video Signing recording](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Download/DownloadVideoSigningRecordingRequest) #### Implementation Notes Returns Video Signing recording #### Response Class (Status ) - Model - Model Schema Object { } ``` {} ``` Response Content Type application/json #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | DocumentReference | | **Document reference** | path | string | #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 401 | Unauthorised: Check your api key | | | 404 | Video Signing recording not found | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - ## [EmailTemplate](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/EmailTemplate) - [Show/Hide](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/EmailTemplate) - List Operations - Expand Operations - Raw - - ### [get](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/EmailTemplate/CompletionEmailTemplateRequest) [/EmailTemplate/GetCompletionTemplates](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/EmailTemplate/CompletionEmailTemplateRequest) - [Returns account user's active completion email templates.](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/EmailTemplate/CompletionEmailTemplateRequest) #### Implementation Notes Returns account user's active completion email templates. #### Response Class (Status ) - Model - Model Schema EmailTemplate { Reference ( string): Email template's reference., Name ( string): Email template's name., IsDefault ( boolean): If the email template is default one or not, Subject ( string): Email template's subject., Template ( string): Email template's text. } ``` [ { "Reference": "", "Name": "", "IsDefault": false, "Subject": "", "Template": "" } ] ``` Response Content Type application/json #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 401 | Unauthorised: Check your api key | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [get](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/EmailTemplate/EmailTemplateRequest) [/EmailTemplate/GetInvitationTemplates](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/EmailTemplate/EmailTemplateRequest) - [Returns account user's active invitation email templates.](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/EmailTemplate/EmailTemplateRequest) #### Implementation Notes Returns account user's active invitation email templates. #### Response Class (Status ) - Model - Model Schema EmailTemplate { Reference ( string): Email template's reference., Name ( string): Email template's name., IsDefault ( boolean): If the email template is default one or not, Subject ( string): Email template's subject., Template ( string): Email template's text. } ``` [ { "Reference": "", "Name": "", "IsDefault": false, "Subject": "", "Template": "" } ] ``` Response Content Type application/json #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 401 | Unauthorised: Check your api key | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - ## [FormDirect](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/FormDirect) - [Show/Hide](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/FormDirect) - List Operations - Expand Operations - Raw - - ### [get](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/FormDirect/EmployerListRequest) [/FormDirect/Employers](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/FormDirect/EmployerListRequest) - [List employer details for some forms](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/FormDirect/EmployerListRequest) #### Implementation Notes List employer details for some forms. return form type and employer details. #### Response Class (Status ) - Model - Model Schema Employers { SuperFund ( Array\[SuperFundInfo\], optional), TFN ( Array\[TFNInfo\], optional), AccClaimsHistory ( Array\[AccClaimsHistoryInfo\], optional), MOJ ( Array\[MOJInfo\], optional), StandardMOJ ( Array\[StandardMOJInfo\], optional) } SuperFundInfo { Reference ( string): EmployerReference, Name ( string): Name for identify, IsDefault ( boolean): If it's the default employer, ABN ( string, optional), BusinessName ( string, optional), SuperFundName ( string, optional), USI ( string, optional), Phone ( string, optional), SuperFundWebsite ( string, optional) } TFNInfo { Reference ( string): EmployerReference, Name ( string): Name for identify, IsDefault ( boolean): If it's the default employer, ABN ( string, optional), BusinessName ( string, optional), BusinessAddress ( string, optional), BusinessSuburb ( string, optional), BusinessState ( string, optional), BusinessPostcode ( string, optional), BusinessEmail ( string, optional), ContactPerson ( string, optional), ContactPhone ( string, optional) } AccClaimsHistoryInfo { Reference ( string): EmployerReference, Name ( string): Name for identify, IsDefault ( boolean): If it's the default employer, OrganisationName ( string, optional), ContactPersonName ( string, optional), ContactPersonPhone ( string, optional), ContactPersonEmail ( string, optional) } MOJInfo { Reference ( string): EmployerReference, Name ( string): Name for identify, IsDefault ( boolean): If it's the default employer, ThirdPartyCustomerID ( string, optional), ThirdPartyName ( string, optional), ThirdPartyReference ( string, optional), ReportType ( string, optional), ServiceType ( string, optional) } StandardMOJInfo { Reference ( string): EmployerReference, Name ( string): Name for identify, IsDefault ( boolean): If it's the default employer, ThirdPartyName ( string, optional), ThirdPartyActingFor ( string, optional), ThirdPartyReference ( string, optional), ThirdPartyReturnAddressName ( string, optional), ThirdPartyStreet ( string, optional), ThirdPartySuburb ( string, optional), ThirdPartyTown ( string, optional), ThirdPartyState ( string, optional), ThirdPartyPostCode ( string, optional), ThirdPartyCountry ( string, optional) } ``` { "SuperFund": [ { "Reference": "", "Name": "", "IsDefault": false, "ABN": "", "BusinessName": "", "SuperFundName": "", "USI": "", "Phone": "", "SuperFundWebsite": "" } ], "TFN": [ { "Reference": "", "Name": "", "IsDefault": false, "ABN": "", "BusinessName": "", "BusinessAddress": "", "BusinessSuburb": "", "BusinessState": "", "BusinessPostcode": "", "BusinessEmail": "", "ContactPerson": "", "ContactPhone": "" } ], "AccClaimsHistory": [ { "Reference": "", "Name": "", "IsDefault": false, "OrganisationName": "", "ContactPersonName": "", "ContactPersonPhone": "", "ContactPersonEmail": "" } ], "MOJ": [ { "Reference": "", "Name": "", "IsDefault": false, "ThirdPartyCustomerID": "", "ThirdPartyName": "", "ThirdPartyReference": "", "ReportType": "", "ServiceType": "" } ], "StandardMOJ": [ { "Reference": "", "Name": "", "IsDefault": false, "ThirdPartyName": "", "ThirdPartyActingFor": "", "ThirdPartyReference": "", "ThirdPartyReturnAddressName": "", "ThirdPartyStreet": "", "ThirdPartySuburb": "", "ThirdPartyTown": "", "ThirdPartyState": "", "ThirdPartyPostCode": "", "ThirdPartyCountry": "" } ] } ``` Response Content Type application/json #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 401 | Unauthorised: Check your api key | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [get](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/FormDirect/ExportRequest) [/FormDirect/Export/{DocumentReference}/{FormDataFileType}](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/FormDirect/ExportRequest) - [Get FormData for that specific Document](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/FormDirect/ExportRequest) #### Implementation Notes choose different export options (csv, xls, xlsx, xml), if it has Xslt set for that Form, it will apply automatically. #### Response Class (Status ) - Model - Model Schema Object { } ``` {} ``` Response Content Type application/json #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | DocumentReference | | **Document reference** | path | string | | FormDataFileType | xml csv xlsx xls | Form data file return type | path | string | #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 401 | Unauthorised: Check your api key | | | 404 | Document not found, may have been removed | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [get](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/FormDirect/FormDirectRequest) [/FormDirect/GetFormList](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/FormDirect/FormDirectRequest) - [Gets form list](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/FormDirect/FormDirectRequest) #### Implementation Notes Gets a list of Forms available for an account. Returns a collection of signers required for signing the forms. #### Response Class (Status ) - Model - Model Schema FormDirect { Name ( string): Form name, FormType ( int): Form type, Reference ( string): Form reference, Signers ( Array\[FormDirectInvitee\]): List of signers required for the form, EmbedForm ( boolean): If true, the signing links will be used in an iFrame to access the forms, ReturnUrl ( string, optional): After signing a form, the page will redirect to the specified url, NotifyUrl ( string, optional): Notify Url, XMLData ( string, optional): Auto fill data for the form. It is an XML document converted to a string. Secured Signing creates the template for the data., EmployerReference ( string, optional): Auto fill employer data for the form. It can be returned by FormDirect/Employers api. Secured Signing creates the template for the data., ClientReference ( string, optional): client side referese; e.g. external id etc. } FormDirectInvitee { SignerType ( string, optional): Role of invitee in signing process, MobileNumber ( string, optional): Mobile number of signer, for SMS secured forms. Must include the mobile carrier code e.g. Australia 04, New Zealand 027 or 021 etc, MobileCountry ( string, optional): Mobile Country code for phone number e.g. Australia 61, New Zealand 64 etc, ShareUsers ( Array\[ShareUser\], optional), ClientReference ( string, optional), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } ShareUser { IsDefault ( boolean), IsOwner ( boolean), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } ``` [ { "Name": "", "FormType": "int", "Reference": "", "Signers": [ { "SignerType": "", "MobileNumber": "", "MobileCountry": "", "ShareUsers": [ { "IsDefault": false, "IsOwner": false, "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "ClientReference": "", "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "EmbedForm": false, "ReturnUrl": "", "NotifyUrl": "", "XMLData": "", "EmployerReference": "", "ClientReference": "" } ] ``` Response Content Type application/json #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 401 | Unauthorised: Check your api key | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [get](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/FormDirect/FormFieldsRequest) [/FormDirect/GetPredefinedFormFields/{FormReference}](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/FormDirect/FormFieldsRequest) - [Gets predefined fields for a single form](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/FormDirect/FormFieldsRequest) #### Implementation Notes Gets a single form. Returns a collection of signers required for signing the forms. #### Response Class (Status ) - Model - Model Schema FormFieldResponse { Fields ( Array\[FormField\], optional), LastUpdateTime ( Date, optional): Date of last update } FormField { FieldName ( string, optional), DisplayName ( string, optional), FieldType ( string) = \['Text' or 'MultiLineText' or 'CheckBox' or 'DropDownList' or 'DateInput'\], FiledValue ( string, optional), ValueOptions ( Array\[string\], optional), ClientField ( string, optional), ClientMapping ( int) } ``` { "Fields": [ { "FieldName": "", "DisplayName": "", "FieldType": "", "FiledValue": "", "ValueOptions": [ "" ], "ClientField": "", "ClientMapping": "int" } ], "LastUpdateTime": "Date" } ``` Response Content Type application/json #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | FormReference | | **Form reference** | path | string | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [get](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/FormDirect/SingleFormDirectRequest) [/FormDirect/GetSingleForm/{FormReference}](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/FormDirect/SingleFormDirectRequest) - [Gets a single form](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/FormDirect/SingleFormDirectRequest) #### Implementation Notes Gets a single form. Returns a collection of signers required for signing the forms. #### Response Class (Status ) - Model - Model Schema FormDirect { Name ( string): Form name, FormType ( int): Form type, Reference ( string): Form reference, Signers ( Array\[FormDirectInvitee\]): List of signers required for the form, EmbedForm ( boolean): If true, the signing links will be used in an iFrame to access the forms, ReturnUrl ( string, optional): After signing a form, the page will redirect to the specified url, NotifyUrl ( string, optional): Notify Url, XMLData ( string, optional): Auto fill data for the form. It is an XML document converted to a string. Secured Signing creates the template for the data., EmployerReference ( string, optional): Auto fill employer data for the form. It can be returned by FormDirect/Employers api. Secured Signing creates the template for the data., ClientReference ( string, optional): client side referese; e.g. external id etc. } FormDirectInvitee { SignerType ( string, optional): Role of invitee in signing process, MobileNumber ( string, optional): Mobile number of signer, for SMS secured forms. Must include the mobile carrier code e.g. Australia 04, New Zealand 027 or 021 etc, MobileCountry ( string, optional): Mobile Country code for phone number e.g. Australia 61, New Zealand 64 etc, ShareUsers ( Array\[ShareUser\], optional), ClientReference ( string, optional), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } ShareUser { IsDefault ( boolean), IsOwner ( boolean), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } ``` { "Name": "", "FormType": "int", "Reference": "", "Signers": [ { "SignerType": "", "MobileNumber": "", "MobileCountry": "", "ShareUsers": [ { "IsDefault": false, "IsOwner": false, "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "ClientReference": "", "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "EmbedForm": false, "ReturnUrl": "", "NotifyUrl": "", "XMLData": "", "EmployerReference": "", "ClientReference": "" } ``` Response Content Type application/json #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | FormReference | | **Form reference** | path | string | #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 401 | Unauthorised: Check your api key | | | 404 | Form not found | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [post](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/FormDirect/SendFormDirectRequest2) [/FormDirect/SendForms](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/FormDirect/SendFormDirectRequest2) - [Starts Form Direct Process](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/FormDirect/SendFormDirectRequest2) #### Implementation Notes Send a package of forms for filling and signing #### Response Class (Status ) - Model - Model Schema DocumentResponse { Name ( string): File Name, FormDirectReference ( string, optional): Form reference, Signers ( Array\[SignerStatusResponse\]): List of signers, Status ( string, optional) = \['Complete' or 'Declined' or 'Expired' or 'Rejected' or 'Signed' or 'Filling' or 'Filling Form' or 'InProgress' or 'Signing' or 'NotStart' or '# of # Signed'\]: Document signing status, DueDate ( Date, optional): Due Date of document, GMT ( string, optional): GMT Offset, LastSignedDate ( Date, optional): Date of latest signature, Folder ( Date, optional) = \['InBox' or 'Progress' or 'Signed'\]: The folder of the document, Logs ( Array\[DocumentLog\], optional): Document logs, HasFileUploaded ( boolean): Whether invitee uploaded any files during signing process., PackageReference ( string, optional): Package reference, ClientReference ( string, optional): client side referese; e.g. external id etc., EditUrl ( string, optional), IDVerificationRequested ( boolean): ID Verification requested., Reference ( string): Document reference, used for document access } SignerStatusResponse { HasSigned ( boolean): User signing status, DeclinedReason ( string, optional): Declined reason. Return only when invitee declined to sign., VideoConfirmationDetail ( VideoConfirmationDetail, optional), IDCheckStatus ( string, optional), IDVerificationStatus ( string, optional), IDVerificationResult ( string, optional), IDVerificationFaceMatchResult ( string, optional), IDVerificationLivenessResult ( string, optional), SigningKey ( string, optional): Url for access to signing; Only when this is an embedded signer, SignerReference ( string, optional): Signer reference, IsFaceToFaceSigning ( boolean), VideoConfirmationEnabled ( boolean), ReviewBeforeSigningEnabled ( boolean), MobileNumber ( string, optional): Mobile number of signer, for SMS secured forms. Must include the mobile carrier code e.g. Australia 04, New Zealand 027 or 021 etc, MobileCountry ( string, optional): Mobile Country code for phone number e.g. Australia 61, New Zealand 64 etc, ShareUsers ( Array\[ShareUser\], optional), ClientReference ( string, optional), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } VideoConfirmationDetail { Name ( string, optional), ShortUrl ( string, optional), IsVideoReady ( boolean), Password ( string, optional), Email ( string, optional), IsWitness ( boolean), IsVideoDisabled ( boolean), IsVideoOptOut ( boolean), WitnessOwner ( string, optional) } ShareUser { IsDefault ( boolean), IsOwner ( boolean), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } DocumentLog { Name ( string, optional): Name of user responsible for action, Action ( string, optional): Log entry, Date ( date, optional): Date of log entry, GMT ( string, optional): GMT Offset, Role ( string, optional): Role of user responsible for action } ``` [ { "Name": "", "FormDirectReference": "", "Signers": [ { "HasSigned": false, "DeclinedReason": "", "VideoConfirmationDetail": { "Name": "", "ShortUrl": "", "IsVideoReady": false, "Password": "", "Email": "", "IsWitness": false, "IsVideoDisabled": false, "IsVideoOptOut": false, "WitnessOwner": "" }, "IDCheckStatus": "", "IDVerificationStatus": "", "IDVerificationResult": "", "IDVerificationFaceMatchResult": "", "IDVerificationLivenessResult": "", "SigningKey": "", "SignerReference": "", "IsFaceToFaceSigning": false, "VideoConfirmationEnabled": false, "ReviewBeforeSigningEnabled": false, "MobileNumber": "", "MobileCountry": "", "ShareUsers": [ { "IsDefault": false, "IsOwner": false, "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "ClientReference": "", "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "Status": "", "DueDate": "Date", "GMT": "", "LastSignedDate": "Date", "Folder": "Date", "Logs": [ { "Name": "", "Action": "", "Date": "date", "GMT": "", "Role": "" } ], "HasFileUploaded": false, "PackageReference": "", "ClientReference": "", "EditUrl": "", "IDVerificationRequested": false, "Reference": "" } ] ``` Response Content Type application/json #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | body | Parameter content type: application/json | | body | - Model - Model Schema SendFormDirectRequest2 { Forms ( Array\[FormDirect\]): Collection of forms to be sent, if an account reference is not supplied for the forms, the forms will be associated with your api account., DueDate ( Date, optional): Due date that forms are to be signed by. If not set, +14 days is the default, GMT ( string, optional): GMT Offset, InvitationEmailTemplateReference ( string, optional), ListItems ( Array\[DropDownListItem\], optional) } FormDirect { Name ( string): Form name, FormType ( int): Form type, Reference ( string): Form reference, Signers ( Array\[FormDirectInvitee\]): List of signers required for the form, EmbedForm ( boolean): If true, the signing links will be used in an iFrame to access the forms, ReturnUrl ( string, optional): After signing a form, the page will redirect to the specified url, NotifyUrl ( string, optional): Notify Url, XMLData ( string, optional): Auto fill data for the form. It is an XML document converted to a string. Secured Signing creates the template for the data., EmployerReference ( string, optional): Auto fill employer data for the form. It can be returned by FormDirect/Employers api. Secured Signing creates the template for the data., ClientReference ( string, optional): client side referese; e.g. external id etc. } FormDirectInvitee { SignerType ( string, optional): Role of invitee in signing process, MobileNumber ( string, optional): Mobile number of signer, for SMS secured forms. Must include the mobile carrier code e.g. Australia 04, New Zealand 027 or 021 etc, MobileCountry ( string, optional): Mobile Country code for phone number e.g. Australia 61, New Zealand 64 etc, ShareUsers ( Array\[ShareUser\], optional), ClientReference ( string, optional), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } ShareUser { IsDefault ( boolean), IsOwner ( boolean), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } DropDownListItem { ClientField ( string): The field name on client side, Item ( string): Item name, Value ( string): Item value } ``` { "Forms": [ { "Name": "", "FormType": "int", "Reference": "", "Signers": [ { "SignerType": "", "MobileNumber": "", "MobileCountry": "", "ShareUsers": [ { "IsDefault": false, "IsOwner": false, "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "ClientReference": "", "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "EmbedForm": false, "ReturnUrl": "", "NotifyUrl": "", "XMLData": "", "EmployerReference": "", "ClientReference": "" } ], "DueDate": "Date", "GMT": "", "InvitationEmailTemplateReference": "", "ListItems": [ { "ClientField": "", "Item": "", "Value": "" } ] } ``` Click to set as parameter value | #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Forms sent successfully | | | 401 | Unauthorised: Check your api key | | | 402 | Account on hold, payment required | | | 404 | Form not found | | | 426 | Not enough documents left in plan | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [post](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/FormDirect/SendFormDirectRequest) [/FormDirect/SendForms2](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/FormDirect/SendFormDirectRequest) - [Starts Form Direct Process](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/FormDirect/SendFormDirectRequest) #### Implementation Notes Send a package of forms for filling and signing #### Response Class (Status ) - Model - Model Schema PackageResponse { PackageReference ( string, optional), PackageName ( string, optional), PackageStatus ( string, optional), Documents ( Array\[DocumentResponse\], optional) } DocumentResponse { Name ( string): File Name, FormDirectReference ( string, optional): Form reference, Signers ( Array\[SignerStatusResponse\]): List of signers, Status ( string, optional) = \['Complete' or 'Declined' or 'Expired' or 'Rejected' or 'Signed' or 'Filling' or 'Filling Form' or 'InProgress' or 'Signing' or 'NotStart' or '# of # Signed'\]: Document signing status, DueDate ( Date, optional): Due Date of document, GMT ( string, optional): GMT Offset, LastSignedDate ( Date, optional): Date of latest signature, Folder ( Date, optional) = \['InBox' or 'Progress' or 'Signed'\]: The folder of the document, Logs ( Array\[DocumentLog\], optional): Document logs, HasFileUploaded ( boolean): Whether invitee uploaded any files during signing process., PackageReference ( string, optional): Package reference, ClientReference ( string, optional): client side referese; e.g. external id etc., EditUrl ( string, optional), IDVerificationRequested ( boolean): ID Verification requested., Reference ( string): Document reference, used for document access } SignerStatusResponse { HasSigned ( boolean): User signing status, DeclinedReason ( string, optional): Declined reason. Return only when invitee declined to sign., VideoConfirmationDetail ( VideoConfirmationDetail, optional), IDCheckStatus ( string, optional), IDVerificationStatus ( string, optional), IDVerificationResult ( string, optional), IDVerificationFaceMatchResult ( string, optional), IDVerificationLivenessResult ( string, optional), SigningKey ( string, optional): Url for access to signing; Only when this is an embedded signer, SignerReference ( string, optional): Signer reference, IsFaceToFaceSigning ( boolean), VideoConfirmationEnabled ( boolean), ReviewBeforeSigningEnabled ( boolean), MobileNumber ( string, optional): Mobile number of signer, for SMS secured forms. Must include the mobile carrier code e.g. Australia 04, New Zealand 027 or 021 etc, MobileCountry ( string, optional): Mobile Country code for phone number e.g. Australia 61, New Zealand 64 etc, ShareUsers ( Array\[ShareUser\], optional), ClientReference ( string, optional), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } VideoConfirmationDetail { Name ( string, optional), ShortUrl ( string, optional), IsVideoReady ( boolean), Password ( string, optional), Email ( string, optional), IsWitness ( boolean), IsVideoDisabled ( boolean), IsVideoOptOut ( boolean), WitnessOwner ( string, optional) } ShareUser { IsDefault ( boolean), IsOwner ( boolean), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } DocumentLog { Name ( string, optional): Name of user responsible for action, Action ( string, optional): Log entry, Date ( date, optional): Date of log entry, GMT ( string, optional): GMT Offset, Role ( string, optional): Role of user responsible for action } ``` { "PackageReference": "", "PackageName": "", "PackageStatus": "", "Documents": [ { "Name": "", "FormDirectReference": "", "Signers": [ { "HasSigned": false, "DeclinedReason": "", "VideoConfirmationDetail": { "Name": "", "ShortUrl": "", "IsVideoReady": false, "Password": "", "Email": "", "IsWitness": false, "IsVideoDisabled": false, "IsVideoOptOut": false, "WitnessOwner": "" }, "IDCheckStatus": "", "IDVerificationStatus": "", "IDVerificationResult": "", "IDVerificationFaceMatchResult": "", "IDVerificationLivenessResult": "", "SigningKey": "", "SignerReference": "", "IsFaceToFaceSigning": false, "VideoConfirmationEnabled": false, "ReviewBeforeSigningEnabled": false, "MobileNumber": "", "MobileCountry": "", "ShareUsers": [ { "IsDefault": false, "IsOwner": false, "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "ClientReference": "", "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "Status": "", "DueDate": "Date", "GMT": "", "LastSignedDate": "Date", "Folder": "Date", "Logs": [ { "Name": "", "Action": "", "Date": "date", "GMT": "", "Role": "" } ], "HasFileUploaded": false, "PackageReference": "", "ClientReference": "", "EditUrl": "", "IDVerificationRequested": false, "Reference": "" } ] } ``` Response Content Type application/json #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | body | Parameter content type: application/json | | body | - Model - Model Schema SendFormDirectRequest { Forms ( Array\[FormDirect\]): Collection of forms to be sent, if an account reference is not supplied for the forms, the forms will be associated with your api account., DueDate ( Date, optional): Due date that forms are to be signed by. If not set, +14 days is the default, GMT ( string, optional): GMT Offset, InvitationEmailTemplateReference ( string, optional), ListItems ( Array\[DropDownListItem\], optional) } FormDirect { Name ( string): Form name, FormType ( int): Form type, Reference ( string): Form reference, Signers ( Array\[FormDirectInvitee\]): List of signers required for the form, EmbedForm ( boolean): If true, the signing links will be used in an iFrame to access the forms, ReturnUrl ( string, optional): After signing a form, the page will redirect to the specified url, NotifyUrl ( string, optional): Notify Url, XMLData ( string, optional): Auto fill data for the form. It is an XML document converted to a string. Secured Signing creates the template for the data., EmployerReference ( string, optional): Auto fill employer data for the form. It can be returned by FormDirect/Employers api. Secured Signing creates the template for the data., ClientReference ( string, optional): client side referese; e.g. external id etc. } FormDirectInvitee { SignerType ( string, optional): Role of invitee in signing process, MobileNumber ( string, optional): Mobile number of signer, for SMS secured forms. Must include the mobile carrier code e.g. Australia 04, New Zealand 027 or 021 etc, MobileCountry ( string, optional): Mobile Country code for phone number e.g. Australia 61, New Zealand 64 etc, ShareUsers ( Array\[ShareUser\], optional), ClientReference ( string, optional), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } ShareUser { IsDefault ( boolean), IsOwner ( boolean), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } DropDownListItem { ClientField ( string): The field name on client side, Item ( string): Item name, Value ( string): Item value } ``` { "Forms": [ { "Name": "", "FormType": "int", "Reference": "", "Signers": [ { "SignerType": "", "MobileNumber": "", "MobileCountry": "", "ShareUsers": [ { "IsDefault": false, "IsOwner": false, "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "ClientReference": "", "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "EmbedForm": false, "ReturnUrl": "", "NotifyUrl": "", "XMLData": "", "EmployerReference": "", "ClientReference": "" } ], "DueDate": "Date", "GMT": "", "InvitationEmailTemplateReference": "", "ListItems": [ { "ClientField": "", "Item": "", "Value": "" } ] } ``` Click to set as parameter value | #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Forms sent successfully | | | 401 | Unauthorised: Check your api key | | | 402 | Account on hold, payment required | | | 404 | Form not found | | | 426 | Not enough documents left in plan | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [post](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/FormDirect/UpdateEmployerRequest) [/FormDirect/UpdateEmployers](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/FormDirect/UpdateEmployerRequest) - [Save employer details for some forms](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/FormDirect/UpdateEmployerRequest) #### Implementation Notes Save employer details for some forms #### Response Class (Status ) - Model - Model Schema Employers { SuperFund ( Array\[SuperFundInfo\], optional), TFN ( Array\[TFNInfo\], optional), AccClaimsHistory ( Array\[AccClaimsHistoryInfo\], optional), MOJ ( Array\[MOJInfo\], optional), StandardMOJ ( Array\[StandardMOJInfo\], optional) } SuperFundInfo { Reference ( string): EmployerReference, Name ( string): Name for identify, IsDefault ( boolean): If it's the default employer, ABN ( string, optional), BusinessName ( string, optional), SuperFundName ( string, optional), USI ( string, optional), Phone ( string, optional), SuperFundWebsite ( string, optional) } TFNInfo { Reference ( string): EmployerReference, Name ( string): Name for identify, IsDefault ( boolean): If it's the default employer, ABN ( string, optional), BusinessName ( string, optional), BusinessAddress ( string, optional), BusinessSuburb ( string, optional), BusinessState ( string, optional), BusinessPostcode ( string, optional), BusinessEmail ( string, optional), ContactPerson ( string, optional), ContactPhone ( string, optional) } AccClaimsHistoryInfo { Reference ( string): EmployerReference, Name ( string): Name for identify, IsDefault ( boolean): If it's the default employer, OrganisationName ( string, optional), ContactPersonName ( string, optional), ContactPersonPhone ( string, optional), ContactPersonEmail ( string, optional) } MOJInfo { Reference ( string): EmployerReference, Name ( string): Name for identify, IsDefault ( boolean): If it's the default employer, ThirdPartyCustomerID ( string, optional), ThirdPartyName ( string, optional), ThirdPartyReference ( string, optional), ReportType ( string, optional), ServiceType ( string, optional) } StandardMOJInfo { Reference ( string): EmployerReference, Name ( string): Name for identify, IsDefault ( boolean): If it's the default employer, ThirdPartyName ( string, optional), ThirdPartyActingFor ( string, optional), ThirdPartyReference ( string, optional), ThirdPartyReturnAddressName ( string, optional), ThirdPartyStreet ( string, optional), ThirdPartySuburb ( string, optional), ThirdPartyTown ( string, optional), ThirdPartyState ( string, optional), ThirdPartyPostCode ( string, optional), ThirdPartyCountry ( string, optional) } ``` { "SuperFund": [ { "Reference": "", "Name": "", "IsDefault": false, "ABN": "", "BusinessName": "", "SuperFundName": "", "USI": "", "Phone": "", "SuperFundWebsite": "" } ], "TFN": [ { "Reference": "", "Name": "", "IsDefault": false, "ABN": "", "BusinessName": "", "BusinessAddress": "", "BusinessSuburb": "", "BusinessState": "", "BusinessPostcode": "", "BusinessEmail": "", "ContactPerson": "", "ContactPhone": "" } ], "AccClaimsHistory": [ { "Reference": "", "Name": "", "IsDefault": false, "OrganisationName": "", "ContactPersonName": "", "ContactPersonPhone": "", "ContactPersonEmail": "" } ], "MOJ": [ { "Reference": "", "Name": "", "IsDefault": false, "ThirdPartyCustomerID": "", "ThirdPartyName": "", "ThirdPartyReference": "", "ReportType": "", "ServiceType": "" } ], "StandardMOJ": [ { "Reference": "", "Name": "", "IsDefault": false, "ThirdPartyName": "", "ThirdPartyActingFor": "", "ThirdPartyReference": "", "ThirdPartyReturnAddressName": "", "ThirdPartyStreet": "", "ThirdPartySuburb": "", "ThirdPartyTown": "", "ThirdPartyState": "", "ThirdPartyPostCode": "", "ThirdPartyCountry": "" } ] } ``` Response Content Type application/json #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | body | Parameter content type: application/json | | body | - Model - Model Schema UpdateEmployerRequest { SuperFund ( Array\[SuperFundInfo\], optional), TFN ( Array\[TFNInfo\], optional), AccClaimsHistory ( Array\[AccClaimsHistoryInfo\], optional) } SuperFundInfo { Reference ( string): EmployerReference, Name ( string): Name for identify, IsDefault ( boolean): If it's the default employer, ABN ( string, optional), BusinessName ( string, optional), SuperFundName ( string, optional), USI ( string, optional), Phone ( string, optional), SuperFundWebsite ( string, optional) } TFNInfo { Reference ( string): EmployerReference, Name ( string): Name for identify, IsDefault ( boolean): If it's the default employer, ABN ( string, optional), BusinessName ( string, optional), BusinessAddress ( string, optional), BusinessSuburb ( string, optional), BusinessState ( string, optional), BusinessPostcode ( string, optional), BusinessEmail ( string, optional), ContactPerson ( string, optional), ContactPhone ( string, optional) } AccClaimsHistoryInfo { Reference ( string): EmployerReference, Name ( string): Name for identify, IsDefault ( boolean): If it's the default employer, OrganisationName ( string, optional), ContactPersonName ( string, optional), ContactPersonPhone ( string, optional), ContactPersonEmail ( string, optional) } ``` { "SuperFund": [ { "Reference": "", "Name": "", "IsDefault": false, "ABN": "", "BusinessName": "", "SuperFundName": "", "USI": "", "Phone": "", "SuperFundWebsite": "" } ], "TFN": [ { "Reference": "", "Name": "", "IsDefault": false, "ABN": "", "BusinessName": "", "BusinessAddress": "", "BusinessSuburb": "", "BusinessState": "", "BusinessPostcode": "", "BusinessEmail": "", "ContactPerson": "", "ContactPhone": "" } ], "AccClaimsHistory": [ { "Reference": "", "Name": "", "IsDefault": false, "OrganisationName": "", "ContactPersonName": "", "ContactPersonPhone": "", "ContactPersonEmail": "" } ] } ``` Click to set as parameter value | #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 401 | Unauthorised: Check your api key | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - ## [FormFiller](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/FormFiller) - [Show/Hide](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/FormFiller) - List Operations - Expand Operations - Raw - - ### [get](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/FormFiller/FormFillerFieldRequest) [/FormFiller/GetFieldTemplate/{TemplateReference}](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/FormFiller/FormFillerFieldRequest) - [Gets all field details in a single template](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/FormFiller/FormFillerFieldRequest) #### Implementation Notes Gets a single template. Returns a collection of fields required for filling the template. #### Response Class (Status ) - Model - Model Schema FormFillerTemplate { Name ( string): Template name, Reference ( string): Identifier, Signers ( Array\[Signer\]): List of signers required for the template, Fields ( Array\[FormFillerField\]): List of fields required for the template, ClientReference ( string, optional): client side referese; e.g. external id etc. } Signer { SignerReference ( string, optional): Signer reference, IsFaceToFaceSigning ( boolean), VideoConfirmationEnabled ( boolean), ReviewBeforeSigningEnabled ( boolean), MobileNumber ( string, optional): Mobile number of signer, for SMS secured forms. Must include the mobile carrier code e.g. Australia 04, New Zealand 027 or 021 etc, MobileCountry ( string, optional): Mobile Country code for phone number e.g. Australia 61, New Zealand 64 etc, ShareUsers ( Array\[ShareUser\], optional), ClientReference ( string, optional), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } ShareUser { IsDefault ( boolean), IsOwner ( boolean), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } FormFillerField { Label ( string): Field label, Value ( string): Field value, FieldType ( string) = \['Text' or 'MultiLineText' or 'CheckBox' or 'DropDownList' or 'DateInput'\]: Field type, IsRequired ( boolean): If field is mandatory, ID ( string): Field reference; Obsolated, use Reference instead., Reference ( string): Field reference;, ReadOnly ( boolean): If field is readonly, ClientField ( boolean): Field name on client side } ``` { "Name": "", "Reference": "", "Signers": [ { "SignerReference": "", "IsFaceToFaceSigning": false, "VideoConfirmationEnabled": false, "ReviewBeforeSigningEnabled": false, "MobileNumber": "", "MobileCountry": "", "ShareUsers": [ { "IsDefault": false, "IsOwner": false, "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "ClientReference": "", "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "Fields": [ { "Label": "", "Value": "", "FieldType": "", "IsRequired": false, "ID": "", "Reference": "", "ReadOnly": false, "ClientField": false } ], "ClientReference": "" } ``` Response Content Type application/json #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | TemplateReference | | **Template reference** | path | string | #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 401 | Unauthorised: Check your api key | | | 404 | Form not found | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [get](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/FormFiller/FormFillerSignerRequest) [/FormFiller/GetSignerTemplate/{TemplateReference}](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/FormFiller/FormFillerSignerRequest) - [Gets all signer details in a single template](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/FormFiller/FormFillerSignerRequest) #### Implementation Notes Gets a single template. Returns a collection of signers required for signing the template. #### Response Class (Status ) - Model - Model Schema FormFillerTemplate { Name ( string): Template name, Reference ( string): Identifier, Signers ( Array\[Signer\]): List of signers required for the template, Fields ( Array\[FormFillerField\]): List of fields required for the template, ClientReference ( string, optional): client side referese; e.g. external id etc. } Signer { SignerReference ( string, optional): Signer reference, IsFaceToFaceSigning ( boolean), VideoConfirmationEnabled ( boolean), ReviewBeforeSigningEnabled ( boolean), MobileNumber ( string, optional): Mobile number of signer, for SMS secured forms. Must include the mobile carrier code e.g. Australia 04, New Zealand 027 or 021 etc, MobileCountry ( string, optional): Mobile Country code for phone number e.g. Australia 61, New Zealand 64 etc, ShareUsers ( Array\[ShareUser\], optional), ClientReference ( string, optional), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } ShareUser { IsDefault ( boolean), IsOwner ( boolean), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } FormFillerField { Label ( string): Field label, Value ( string): Field value, FieldType ( string) = \['Text' or 'MultiLineText' or 'CheckBox' or 'DropDownList' or 'DateInput'\]: Field type, IsRequired ( boolean): If field is mandatory, ID ( string): Field reference; Obsolated, use Reference instead., Reference ( string): Field reference;, ReadOnly ( boolean): If field is readonly, ClientField ( boolean): Field name on client side } ``` { "Name": "", "Reference": "", "Signers": [ { "SignerReference": "", "IsFaceToFaceSigning": false, "VideoConfirmationEnabled": false, "ReviewBeforeSigningEnabled": false, "MobileNumber": "", "MobileCountry": "", "ShareUsers": [ { "IsDefault": false, "IsOwner": false, "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "ClientReference": "", "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "Fields": [ { "Label": "", "Value": "", "FieldType": "", "IsRequired": false, "ID": "", "Reference": "", "ReadOnly": false, "ClientField": false } ], "ClientReference": "" } ``` Response Content Type application/json #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | TemplateReference | | **Template reference** | path | string | #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 401 | Unauthorised: Check your api key | | | 404 | Form not found | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [get](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/FormFiller/FormFillerRequest) [/FormFiller/GetTemplateList](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/FormFiller/FormFillerRequest) - [Gets form filler template list](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/FormFiller/FormFillerRequest) #### Implementation Notes Gets a list of templates available for an account. Returns a collection of templates required for sending. #### Response Class (Status ) - Model - Model Schema FormFillerTemplate { Name ( string): Template name, Reference ( string): Identifier, Signers ( Array\[Signer\]): List of signers required for the template, Fields ( Array\[FormFillerField\]): List of fields required for the template, ClientReference ( string, optional): client side referese; e.g. external id etc. } Signer { SignerReference ( string, optional): Signer reference, IsFaceToFaceSigning ( boolean), VideoConfirmationEnabled ( boolean), ReviewBeforeSigningEnabled ( boolean), MobileNumber ( string, optional): Mobile number of signer, for SMS secured forms. Must include the mobile carrier code e.g. Australia 04, New Zealand 027 or 021 etc, MobileCountry ( string, optional): Mobile Country code for phone number e.g. Australia 61, New Zealand 64 etc, ShareUsers ( Array\[ShareUser\], optional), ClientReference ( string, optional), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } ShareUser { IsDefault ( boolean), IsOwner ( boolean), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } FormFillerField { Label ( string): Field label, Value ( string): Field value, FieldType ( string) = \['Text' or 'MultiLineText' or 'CheckBox' or 'DropDownList' or 'DateInput'\]: Field type, IsRequired ( boolean): If field is mandatory, ID ( string): Field reference; Obsolated, use Reference instead., Reference ( string): Field reference;, ReadOnly ( boolean): If field is readonly, ClientField ( boolean): Field name on client side } ``` [ { "Name": "", "Reference": "", "Signers": [ { "SignerReference": "", "IsFaceToFaceSigning": false, "VideoConfirmationEnabled": false, "ReviewBeforeSigningEnabled": false, "MobileNumber": "", "MobileCountry": "", "ShareUsers": [ { "IsDefault": false, "IsOwner": false, "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "ClientReference": "", "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "Fields": [ { "Label": "", "Value": "", "FieldType": "", "IsRequired": false, "ID": "", "Reference": "", "ReadOnly": false, "ClientField": false } ], "ClientReference": "" } ] ``` Response Content Type application/json #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 401 | Unauthorised: Check your api key | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [post](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/FormFiller/SendFormFillerRequest) [/FormFiller/Send](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/FormFiller/SendFormFillerRequest) - [Send the template(s) to invitees to start a We Sign process](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/FormFiller/SendFormFillerRequest) #### Implementation Notes Send a template for filling and signing #### Response Class (Status ) - Model - Model Schema PackageResponse { PackageReference ( string, optional), PackageName ( string, optional), PackageStatus ( string, optional), Documents ( Array\[DocumentResponse\], optional) } DocumentResponse { Name ( string): File Name, FormDirectReference ( string, optional): Form reference, Signers ( Array\[SignerStatusResponse\]): List of signers, Status ( string, optional) = \['Complete' or 'Declined' or 'Expired' or 'Rejected' or 'Signed' or 'Filling' or 'Filling Form' or 'InProgress' or 'Signing' or 'NotStart' or '# of # Signed'\]: Document signing status, DueDate ( Date, optional): Due Date of document, GMT ( string, optional): GMT Offset, LastSignedDate ( Date, optional): Date of latest signature, Folder ( Date, optional) = \['InBox' or 'Progress' or 'Signed'\]: The folder of the document, Logs ( Array\[DocumentLog\], optional): Document logs, HasFileUploaded ( boolean): Whether invitee uploaded any files during signing process., PackageReference ( string, optional): Package reference, ClientReference ( string, optional): client side referese; e.g. external id etc., EditUrl ( string, optional), IDVerificationRequested ( boolean): ID Verification requested., Reference ( string): Document reference, used for document access } SignerStatusResponse { HasSigned ( boolean): User signing status, DeclinedReason ( string, optional): Declined reason. Return only when invitee declined to sign., VideoConfirmationDetail ( VideoConfirmationDetail, optional), IDCheckStatus ( string, optional), IDVerificationStatus ( string, optional), IDVerificationResult ( string, optional), IDVerificationFaceMatchResult ( string, optional), IDVerificationLivenessResult ( string, optional), SigningKey ( string, optional): Url for access to signing; Only when this is an embedded signer, SignerReference ( string, optional): Signer reference, IsFaceToFaceSigning ( boolean), VideoConfirmationEnabled ( boolean), ReviewBeforeSigningEnabled ( boolean), MobileNumber ( string, optional): Mobile number of signer, for SMS secured forms. Must include the mobile carrier code e.g. Australia 04, New Zealand 027 or 021 etc, MobileCountry ( string, optional): Mobile Country code for phone number e.g. Australia 61, New Zealand 64 etc, ShareUsers ( Array\[ShareUser\], optional), ClientReference ( string, optional), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } VideoConfirmationDetail { Name ( string, optional), ShortUrl ( string, optional), IsVideoReady ( boolean), Password ( string, optional), Email ( string, optional), IsWitness ( boolean), IsVideoDisabled ( boolean), IsVideoOptOut ( boolean), WitnessOwner ( string, optional) } ShareUser { IsDefault ( boolean), IsOwner ( boolean), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } DocumentLog { Name ( string, optional): Name of user responsible for action, Action ( string, optional): Log entry, Date ( date, optional): Date of log entry, GMT ( string, optional): GMT Offset, Role ( string, optional): Role of user responsible for action } ``` { "PackageReference": "", "PackageName": "", "PackageStatus": "", "Documents": [ { "Name": "", "FormDirectReference": "", "Signers": [ { "HasSigned": false, "DeclinedReason": "", "VideoConfirmationDetail": { "Name": "", "ShortUrl": "", "IsVideoReady": false, "Password": "", "Email": "", "IsWitness": false, "IsVideoDisabled": false, "IsVideoOptOut": false, "WitnessOwner": "" }, "IDCheckStatus": "", "IDVerificationStatus": "", "IDVerificationResult": "", "IDVerificationFaceMatchResult": "", "IDVerificationLivenessResult": "", "SigningKey": "", "SignerReference": "", "IsFaceToFaceSigning": false, "VideoConfirmationEnabled": false, "ReviewBeforeSigningEnabled": false, "MobileNumber": "", "MobileCountry": "", "ShareUsers": [ { "IsDefault": false, "IsOwner": false, "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "ClientReference": "", "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "Status": "", "DueDate": "Date", "GMT": "", "LastSignedDate": "Date", "Folder": "Date", "Logs": [ { "Name": "", "Action": "", "Date": "date", "GMT": "", "Role": "" } ], "HasFileUploaded": false, "PackageReference": "", "ClientReference": "", "EditUrl": "", "IDVerificationRequested": false, "Reference": "" } ] } ``` Response Content Type application/json #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | body | Parameter content type: application/json | | body | - Model - Model Schema SendFormFillerRequest { Templates ( Array\[FormFillerTemplate\]): Collection of forms to be sent, if an account reference is not supplied for the forms, the forms will be associated with your api account., DueDate ( Date, optional): Due date that forms are to be signed by. If not set, +14 days is the default, GMT ( string, optional): GMT Offset, Embedded ( boolean): Shows if embedded signing, ReturnUrl ( string, optional): Return Url, Sequential ( boolean): If all signers need to sign one by one with the order in template.signers , NotifyUrl ( string, optional): Notify Url } FormFillerTemplate { Name ( string): Template name, Reference ( string): Identifier, Signers ( Array\[Signer\]): List of signers required for the template, Fields ( Array\[FormFillerField\]): List of fields required for the template, ClientReference ( string, optional): client side referese; e.g. external id etc. } Signer { SignerReference ( string, optional): Signer reference, IsFaceToFaceSigning ( boolean), VideoConfirmationEnabled ( boolean), ReviewBeforeSigningEnabled ( boolean), MobileNumber ( string, optional): Mobile number of signer, for SMS secured forms. Must include the mobile carrier code e.g. Australia 04, New Zealand 027 or 021 etc, MobileCountry ( string, optional): Mobile Country code for phone number e.g. Australia 61, New Zealand 64 etc, ShareUsers ( Array\[ShareUser\], optional), ClientReference ( string, optional), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } ShareUser { IsDefault ( boolean), IsOwner ( boolean), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } FormFillerField { Label ( string): Field label, Value ( string): Field value, FieldType ( string) = \['Text' or 'MultiLineText' or 'CheckBox' or 'DropDownList' or 'DateInput'\]: Field type, IsRequired ( boolean): If field is mandatory, ID ( string): Field reference; Obsolated, use Reference instead., Reference ( string): Field reference;, ReadOnly ( boolean): If field is readonly, ClientField ( boolean): Field name on client side } ``` { "Templates": [ { "Name": "", "Reference": "", "Signers": [ { "SignerReference": "", "IsFaceToFaceSigning": false, "VideoConfirmationEnabled": false, "ReviewBeforeSigningEnabled": false, "MobileNumber": "", "MobileCountry": "", "ShareUsers": [ { "IsDefault": false, "IsOwner": false, "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "ClientReference": "", "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "Fields": [ { "Label": "", "Value": "", "FieldType": "", "IsRequired": false, "ID": "", "Reference": "", "ReadOnly": false, "ClientField": false } ], "ClientReference": "" } ], "DueDate": "Date", "GMT": "", "Embedded": false, "ReturnUrl": "", "Sequential": false, "NotifyUrl": "" } ``` Click to set as parameter value | #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Forms sent successfully | | | 401 | Unauthorised: Check your api key | | | 402 | Account on hold, payment required | | | 404 | Form not found | | | 426 | Not enough documents left in plan | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - ## [Notary](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Notary) - [Show/Hide](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Notary) - List Operations - Expand Operations - Raw - - ### [get](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Notary/QueueRequest) [/Notary/Queue](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Notary/QueueRequest) - [Get notary queue information](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Notary/QueueRequest) #### Implementation Notes Get notary queue information. #### Response Class (Status ) - Model - Model Schema QueueInfo { Reference ( string): Notary Queue's reference., Name ( string, optional): The name of the notary queue, Description ( string, optional): The description of the notary queue } ``` [ { "Reference": "", "Name": "", "Description": "" } ] ``` Response Content Type application/json #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 404 | Unable to find user or api key | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [post](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Notary/SendToQueueRequest) [/Notary/SendToQueue](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Notary/SendToQueueRequest) - [Send documents to queue](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Notary/SendToQueueRequest) #### Implementation Notes Send documents to queue. #### Response Class (Status ) - Model - Model Schema SendToQueueResponse { PackageReference ( string, optional), PackageName ( string, optional), PackageStatus ( string, optional), DocumentIDs ( Array\[string\], optional) } ``` { "PackageReference": "", "PackageName": "", "PackageStatus": "", "DocumentIDs": [ "" ] } ``` Response Content Type application/json #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | body | Parameter content type: application/json | | body | - Model - Model Schema SendToQueueRequest { QueueReference ( string, optional), MISMO ( boolean), VideoScheduleDate ( string, optional), Invitees ( Array\[NotaryInvitee\], optional), Documents ( Array\[NotaryDocument\], optional), TemplateIDs ( Array\[string\], optional) } NotaryInvitee { Email ( string): Invitee Email, FirstName ( string): Invitee First Name, MiddleName ( string, optional): Invitee Middle Name, LastName ( string): Invitee Last Name, Role ( string) = \['Signer' or 'Guest' or 'Witness' or 'CredibleWitnessSign' or 'CredibleWitnessNoSign' or 'Notary'\]: Invitee Role, SecurityType ( string) = \['Default' or 'SMS' or 'IDVerification' or 'KBA' or 'KBA\_IDVerification' or 'SMS\_IDVerification' or 'SMS\_KBA' or 'SMS\_KBA\_IDVerification' or 'PersonalKnowledge' or 'CredibleWitness\_PassCode'\]: Authentication Type, Address ( string): Invitee Address, City ( string): Invitee City, State ( string): Invitee State, Zipcode ( string): Invitee Zipcode, Note ( string): Invitee Note } NotaryDocument { DocumentReference ( string): Document reference, used for document access, NotarizationType ( string, optional): Type of Notarization, NotaryFee ( string, optional): Notary Fee } ``` { "QueueReference": "", "MISMO": false, "VideoScheduleDate": "", "Invitees": [ { "Email": "", "FirstName": "", "MiddleName": "", "LastName": "", "Role": "", "SecurityType": "", "Address": "", "City": "", "State": "", "Zipcode": "", "Note": "" } ], "Documents": [ { "DocumentReference": "", "NotarizationType": "", "NotaryFee": "" } ], "TemplateIDs": [ "" ] } ``` Click to set as parameter value | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - ## [Package](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Package) - [Show/Hide](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Package) - List Operations - Expand Operations - Raw - - ### [delete](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Package/PackageDeleteRequest) [/Package/{PackageReference}](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Package/PackageDeleteRequest) - [Delete the package](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Package/PackageDeleteRequest) #### Implementation Notes Delete the package #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | PackageReference | | **Package reference** | path | string | #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 401 | Unauthorised: Check your api key | | | 404 | Unable to find package, please check reference | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [post](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Package/PackageDeleteRequest_0) [/Package/Delete/{PackageReference}](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Package/PackageDeleteRequest_0) - [Delete the package](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Package/PackageDeleteRequest_0) #### Implementation Notes Delete the package #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | PackageReference | | **Package reference** | path | string | | body | Parameter content type: application/json | | body | - Model - Model Schema PackageDeleteRequest { PackageReference ( string): Package reference } ``` { "PackageReference": "" } ``` Click to set as parameter value | #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 401 | Unauthorised: Check your api key | | | 404 | Unable to find package, please check reference | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [post](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Package/PackageExtendRequest) [/Package/Extend](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Package/PackageExtendRequest) - [Extend the package due date](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Package/PackageExtendRequest) #### Implementation Notes Extend the package due date #### Response Class (Status ) - Model - Model Schema PackageResponse { PackageReference ( string, optional), PackageName ( string, optional), PackageStatus ( string, optional), Documents ( Array\[DocumentResponse\], optional) } DocumentResponse { Name ( string): File Name, FormDirectReference ( string, optional): Form reference, Signers ( Array\[SignerStatusResponse\]): List of signers, Status ( string, optional) = \['Complete' or 'Declined' or 'Expired' or 'Rejected' or 'Signed' or 'Filling' or 'Filling Form' or 'InProgress' or 'Signing' or 'NotStart' or '# of # Signed'\]: Document signing status, DueDate ( Date, optional): Due Date of document, GMT ( string, optional): GMT Offset, LastSignedDate ( Date, optional): Date of latest signature, Folder ( Date, optional) = \['InBox' or 'Progress' or 'Signed'\]: The folder of the document, Logs ( Array\[DocumentLog\], optional): Document logs, HasFileUploaded ( boolean): Whether invitee uploaded any files during signing process., PackageReference ( string, optional): Package reference, ClientReference ( string, optional): client side referese; e.g. external id etc., EditUrl ( string, optional), IDVerificationRequested ( boolean): ID Verification requested., Reference ( string): Document reference, used for document access } SignerStatusResponse { HasSigned ( boolean): User signing status, DeclinedReason ( string, optional): Declined reason. Return only when invitee declined to sign., VideoConfirmationDetail ( VideoConfirmationDetail, optional), IDCheckStatus ( string, optional), IDVerificationStatus ( string, optional), IDVerificationResult ( string, optional), IDVerificationFaceMatchResult ( string, optional), IDVerificationLivenessResult ( string, optional), SigningKey ( string, optional): Url for access to signing; Only when this is an embedded signer, SignerReference ( string, optional): Signer reference, IsFaceToFaceSigning ( boolean), VideoConfirmationEnabled ( boolean), ReviewBeforeSigningEnabled ( boolean), MobileNumber ( string, optional): Mobile number of signer, for SMS secured forms. Must include the mobile carrier code e.g. Australia 04, New Zealand 027 or 021 etc, MobileCountry ( string, optional): Mobile Country code for phone number e.g. Australia 61, New Zealand 64 etc, ShareUsers ( Array\[ShareUser\], optional), ClientReference ( string, optional), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } VideoConfirmationDetail { Name ( string, optional), ShortUrl ( string, optional), IsVideoReady ( boolean), Password ( string, optional), Email ( string, optional), IsWitness ( boolean), IsVideoDisabled ( boolean), IsVideoOptOut ( boolean), WitnessOwner ( string, optional) } ShareUser { IsDefault ( boolean), IsOwner ( boolean), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } DocumentLog { Name ( string, optional): Name of user responsible for action, Action ( string, optional): Log entry, Date ( date, optional): Date of log entry, GMT ( string, optional): GMT Offset, Role ( string, optional): Role of user responsible for action } ``` { "PackageReference": "", "PackageName": "", "PackageStatus": "", "Documents": [ { "Name": "", "FormDirectReference": "", "Signers": [ { "HasSigned": false, "DeclinedReason": "", "VideoConfirmationDetail": { "Name": "", "ShortUrl": "", "IsVideoReady": false, "Password": "", "Email": "", "IsWitness": false, "IsVideoDisabled": false, "IsVideoOptOut": false, "WitnessOwner": "" }, "IDCheckStatus": "", "IDVerificationStatus": "", "IDVerificationResult": "", "IDVerificationFaceMatchResult": "", "IDVerificationLivenessResult": "", "SigningKey": "", "SignerReference": "", "IsFaceToFaceSigning": false, "VideoConfirmationEnabled": false, "ReviewBeforeSigningEnabled": false, "MobileNumber": "", "MobileCountry": "", "ShareUsers": [ { "IsDefault": false, "IsOwner": false, "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "ClientReference": "", "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "Status": "", "DueDate": "Date", "GMT": "", "LastSignedDate": "Date", "Folder": "Date", "Logs": [ { "Name": "", "Action": "", "Date": "date", "GMT": "", "Role": "" } ], "HasFileUploaded": false, "PackageReference": "", "ClientReference": "", "EditUrl": "", "IDVerificationRequested": false, "Reference": "" } ] } ``` Response Content Type application/json #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | body | Parameter content type: application/json | | body | - Model - Model Schema PackageExtendRequest { PackageReference ( string): Package reference, DueDate ( Date): The ISO 8601 formats is the better way to pass the due date to API; otherwise API will try to parse the date string according to user's settings. If it can not be identified, an error will return, GMT ( string, optional): The total minutes of the offset between your local time to UTC time. If it's not specified, user's settings will be applied. If the date is UTC time already, set it as 0. } ``` { "PackageReference": "", "DueDate": "Date", "GMT": "" } ``` Click to set as parameter value | #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 401 | Unauthorised: Check your api key | | | 404 | Unable to find package, please check reference | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [get](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Package/PackageStatusRequest) [/Package/Status/{PackageReference}](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Package/PackageStatusRequest) - [Return current package status](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Package/PackageStatusRequest) #### Implementation Notes Returns a object containing the current status of a package #### Response Class (Status ) - Model - Model Schema PackageResponse { PackageReference ( string, optional), PackageName ( string, optional), PackageStatus ( string, optional), Documents ( Array\[DocumentResponse\], optional) } DocumentResponse { Name ( string): File Name, FormDirectReference ( string, optional): Form reference, Signers ( Array\[SignerStatusResponse\]): List of signers, Status ( string, optional) = \['Complete' or 'Declined' or 'Expired' or 'Rejected' or 'Signed' or 'Filling' or 'Filling Form' or 'InProgress' or 'Signing' or 'NotStart' or '# of # Signed'\]: Document signing status, DueDate ( Date, optional): Due Date of document, GMT ( string, optional): GMT Offset, LastSignedDate ( Date, optional): Date of latest signature, Folder ( Date, optional) = \['InBox' or 'Progress' or 'Signed'\]: The folder of the document, Logs ( Array\[DocumentLog\], optional): Document logs, HasFileUploaded ( boolean): Whether invitee uploaded any files during signing process., PackageReference ( string, optional): Package reference, ClientReference ( string, optional): client side referese; e.g. external id etc., EditUrl ( string, optional), IDVerificationRequested ( boolean): ID Verification requested., Reference ( string): Document reference, used for document access } SignerStatusResponse { HasSigned ( boolean): User signing status, DeclinedReason ( string, optional): Declined reason. Return only when invitee declined to sign., VideoConfirmationDetail ( VideoConfirmationDetail, optional), IDCheckStatus ( string, optional), IDVerificationStatus ( string, optional), IDVerificationResult ( string, optional), IDVerificationFaceMatchResult ( string, optional), IDVerificationLivenessResult ( string, optional), SigningKey ( string, optional): Url for access to signing; Only when this is an embedded signer, SignerReference ( string, optional): Signer reference, IsFaceToFaceSigning ( boolean), VideoConfirmationEnabled ( boolean), ReviewBeforeSigningEnabled ( boolean), MobileNumber ( string, optional): Mobile number of signer, for SMS secured forms. Must include the mobile carrier code e.g. Australia 04, New Zealand 027 or 021 etc, MobileCountry ( string, optional): Mobile Country code for phone number e.g. Australia 61, New Zealand 64 etc, ShareUsers ( Array\[ShareUser\], optional), ClientReference ( string, optional), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } VideoConfirmationDetail { Name ( string, optional), ShortUrl ( string, optional), IsVideoReady ( boolean), Password ( string, optional), Email ( string, optional), IsWitness ( boolean), IsVideoDisabled ( boolean), IsVideoOptOut ( boolean), WitnessOwner ( string, optional) } ShareUser { IsDefault ( boolean), IsOwner ( boolean), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } DocumentLog { Name ( string, optional): Name of user responsible for action, Action ( string, optional): Log entry, Date ( date, optional): Date of log entry, GMT ( string, optional): GMT Offset, Role ( string, optional): Role of user responsible for action } ``` { "PackageReference": "", "PackageName": "", "PackageStatus": "", "Documents": [ { "Name": "", "FormDirectReference": "", "Signers": [ { "HasSigned": false, "DeclinedReason": "", "VideoConfirmationDetail": { "Name": "", "ShortUrl": "", "IsVideoReady": false, "Password": "", "Email": "", "IsWitness": false, "IsVideoDisabled": false, "IsVideoOptOut": false, "WitnessOwner": "" }, "IDCheckStatus": "", "IDVerificationStatus": "", "IDVerificationResult": "", "IDVerificationFaceMatchResult": "", "IDVerificationLivenessResult": "", "SigningKey": "", "SignerReference": "", "IsFaceToFaceSigning": false, "VideoConfirmationEnabled": false, "ReviewBeforeSigningEnabled": false, "MobileNumber": "", "MobileCountry": "", "ShareUsers": [ { "IsDefault": false, "IsOwner": false, "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "ClientReference": "", "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "Status": "", "DueDate": "Date", "GMT": "", "LastSignedDate": "Date", "Folder": "Date", "Logs": [ { "Name": "", "Action": "", "Date": "date", "GMT": "", "Role": "" } ], "HasFileUploaded": false, "PackageReference": "", "ClientReference": "", "EditUrl": "", "IDVerificationRequested": false, "Reference": "" } ] } ``` Response Content Type application/json #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | PackageReference | | **Package reference** | path | string | | DocumentLog | true false | wheather return with documeng log | query | boolean | #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 401 | Unauthorised: Check your api key | | | 404 | Unable to find package, please check reference | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - ## [Recipient](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Recipient) - [Show/Hide](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Recipient) - List Operations - Expand Operations - Raw - - ### [get](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Recipient/GetRecipientsRequest) [/Recipient/GetRecipients](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Recipient/GetRecipientsRequest) - [Returns account user's recipients](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Recipient/GetRecipientsRequest) #### Implementation Notes Returns an array of all notification and completion recipients #### Response Class (Status ) - Model - Model Schema RecipientsResponse { NotificationRecipients ( Array\[NotificationRecipient\], optional), CompletionRecipients ( Array\[CompletionRecipient\], optional) } NotificationRecipient { IsReviewer ( boolean), IsDefaultReviewer ( boolean), RecipientReference ( string, optional), IsDefault ( boolean), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } CompletionRecipient { RecipientReference ( string, optional), IsDefault ( boolean), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } ``` [ { "NotificationRecipients": [ { "IsReviewer": false, "IsDefaultReviewer": false, "RecipientReference": "", "IsDefault": false, "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "CompletionRecipients": [ { "RecipientReference": "", "IsDefault": false, "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ] } ] ``` Response Content Type application/json #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 401 | Unauthorised: Check your api key | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [get](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Recipient/GetRecipientsRequest_0) [/Recipient/Recipients](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Recipient/GetRecipientsRequest_0) - [Returns account user's recipients](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/Recipient/GetRecipientsRequest_0) #### Implementation Notes Returns an array of all notification and completion recipients #### Response Class (Status ) - Model - Model Schema RecipientsResponse { NotificationRecipients ( Array\[NotificationRecipient\], optional), CompletionRecipients ( Array\[CompletionRecipient\], optional) } NotificationRecipient { IsReviewer ( boolean), IsDefaultReviewer ( boolean), RecipientReference ( string, optional), IsDefault ( boolean), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } CompletionRecipient { RecipientReference ( string, optional), IsDefault ( boolean), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } ``` [ { "NotificationRecipients": [ { "IsReviewer": false, "IsDefaultReviewer": false, "RecipientReference": "", "IsDefault": false, "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "CompletionRecipients": [ { "RecipientReference": "", "IsDefault": false, "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ] } ] ``` Response Content Type application/json #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 401 | Unauthorised: Check your api key | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - ## [SmartTag](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/SmartTag) - [Show/Hide](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/SmartTag) - List Operations - Expand Operations - Raw - - ### [post](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/SmartTag/MailMergeRequest) [/SmartTag/MailMerge/](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/SmartTag/MailMergeRequest) - [Merge mail merge list with the document](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/SmartTag/MailMergeRequest) #### Implementation Notes Send a smart tag document. #### Response Class (Status ) - Model - Model Schema ProcessDocumentResponse { Reference ( string): Document reference, used for document access, ProcessingStatus ( string): Processing status of mail merge, Documents ( Array\[DocumentResponse\]): List of documents for mail merge process } DocumentResponse { Name ( string): File Name, FormDirectReference ( string, optional): Form reference, Signers ( Array\[SignerStatusResponse\]): List of signers, Status ( string, optional) = \['Complete' or 'Declined' or 'Expired' or 'Rejected' or 'Signed' or 'Filling' or 'Filling Form' or 'InProgress' or 'Signing' or 'NotStart' or '# of # Signed'\]: Document signing status, DueDate ( Date, optional): Due Date of document, GMT ( string, optional): GMT Offset, LastSignedDate ( Date, optional): Date of latest signature, Folder ( Date, optional) = \['InBox' or 'Progress' or 'Signed'\]: The folder of the document, Logs ( Array\[DocumentLog\], optional): Document logs, HasFileUploaded ( boolean): Whether invitee uploaded any files during signing process., PackageReference ( string, optional): Package reference, ClientReference ( string, optional): client side referese; e.g. external id etc., EditUrl ( string, optional), IDVerificationRequested ( boolean): ID Verification requested., Reference ( string): Document reference, used for document access } SignerStatusResponse { HasSigned ( boolean): User signing status, DeclinedReason ( string, optional): Declined reason. Return only when invitee declined to sign., VideoConfirmationDetail ( VideoConfirmationDetail, optional), IDCheckStatus ( string, optional), IDVerificationStatus ( string, optional), IDVerificationResult ( string, optional), IDVerificationFaceMatchResult ( string, optional), IDVerificationLivenessResult ( string, optional), SigningKey ( string, optional): Url for access to signing; Only when this is an embedded signer, SignerReference ( string, optional): Signer reference, IsFaceToFaceSigning ( boolean), VideoConfirmationEnabled ( boolean), ReviewBeforeSigningEnabled ( boolean), MobileNumber ( string, optional): Mobile number of signer, for SMS secured forms. Must include the mobile carrier code e.g. Australia 04, New Zealand 027 or 021 etc, MobileCountry ( string, optional): Mobile Country code for phone number e.g. Australia 61, New Zealand 64 etc, ShareUsers ( Array\[ShareUser\], optional), ClientReference ( string, optional), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } VideoConfirmationDetail { Name ( string, optional), ShortUrl ( string, optional), IsVideoReady ( boolean), Password ( string, optional), Email ( string, optional), IsWitness ( boolean), IsVideoDisabled ( boolean), IsVideoOptOut ( boolean), WitnessOwner ( string, optional) } ShareUser { IsDefault ( boolean), IsOwner ( boolean), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } DocumentLog { Name ( string, optional): Name of user responsible for action, Action ( string, optional): Log entry, Date ( date, optional): Date of log entry, GMT ( string, optional): GMT Offset, Role ( string, optional): Role of user responsible for action } ``` { "Reference": "", "ProcessingStatus": "", "Documents": [ { "Name": "", "FormDirectReference": "", "Signers": [ { "HasSigned": false, "DeclinedReason": "", "VideoConfirmationDetail": { "Name": "", "ShortUrl": "", "IsVideoReady": false, "Password": "", "Email": "", "IsWitness": false, "IsVideoDisabled": false, "IsVideoOptOut": false, "WitnessOwner": "" }, "IDCheckStatus": "", "IDVerificationStatus": "", "IDVerificationResult": "", "IDVerificationFaceMatchResult": "", "IDVerificationLivenessResult": "", "SigningKey": "", "SignerReference": "", "IsFaceToFaceSigning": false, "VideoConfirmationEnabled": false, "ReviewBeforeSigningEnabled": false, "MobileNumber": "", "MobileCountry": "", "ShareUsers": [ { "IsDefault": false, "IsOwner": false, "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "ClientReference": "", "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "Status": "", "DueDate": "Date", "GMT": "", "LastSignedDate": "Date", "Folder": "Date", "Logs": [ { "Name": "", "Action": "", "Date": "date", "GMT": "", "Role": "" } ], "HasFileUploaded": false, "PackageReference": "", "ClientReference": "", "EditUrl": "", "IDVerificationRequested": false, "Reference": "" } ] } ``` Response Content Type application/json #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | body | Parameter content type: application/json | | body | - Model - Model Schema MailMergeRequest { DocumentReference ( string): Mail merge document reference, MailMergeListFileType ( string) = \['csv' or 'xlsx' or 'xls'\]: File type of file, MailMergeListFileData ( string): Base64 encoded mail merge list file for the document, DueDate ( Date): Due date that document are to be signed by., EmailTemplateReference ( string, optional): Email template reference, Embedded ( boolean): Shows if embedded signing, ReturnUrl ( string, optional): Url to return after document signed } ``` { "DocumentReference": "", "MailMergeListFileType": "", "MailMergeListFileData": "", "DueDate": "Date", "EmailTemplateReference": "", "Embedded": false, "ReturnUrl": "" } ``` Click to set as parameter value | #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 401 | Unauthorised: Check your api key | | | 404 | Unable to find document, please check reference | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [get](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/SmartTag/ProcessDocumentRequest) [/SmartTag/MailMergeDocuments/{ProcessDocumentReference}](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/SmartTag/ProcessDocumentRequest) - [Returns status of mail merge processing along with documents.](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/SmartTag/ProcessDocumentRequest) #### Implementation Notes Returns status of mail merge processing along with documents. #### Response Class (Status ) - Model - Model Schema ProcessDocumentResponse { Reference ( string): Document reference, used for document access, ProcessingStatus ( string): Processing status of mail merge, Documents ( Array\[DocumentResponse\]): List of documents for mail merge process } DocumentResponse { Name ( string): File Name, FormDirectReference ( string, optional): Form reference, Signers ( Array\[SignerStatusResponse\]): List of signers, Status ( string, optional) = \['Complete' or 'Declined' or 'Expired' or 'Rejected' or 'Signed' or 'Filling' or 'Filling Form' or 'InProgress' or 'Signing' or 'NotStart' or '# of # Signed'\]: Document signing status, DueDate ( Date, optional): Due Date of document, GMT ( string, optional): GMT Offset, LastSignedDate ( Date, optional): Date of latest signature, Folder ( Date, optional) = \['InBox' or 'Progress' or 'Signed'\]: The folder of the document, Logs ( Array\[DocumentLog\], optional): Document logs, HasFileUploaded ( boolean): Whether invitee uploaded any files during signing process., PackageReference ( string, optional): Package reference, ClientReference ( string, optional): client side referese; e.g. external id etc., EditUrl ( string, optional), IDVerificationRequested ( boolean): ID Verification requested., Reference ( string): Document reference, used for document access } SignerStatusResponse { HasSigned ( boolean): User signing status, DeclinedReason ( string, optional): Declined reason. Return only when invitee declined to sign., VideoConfirmationDetail ( VideoConfirmationDetail, optional), IDCheckStatus ( string, optional), IDVerificationStatus ( string, optional), IDVerificationResult ( string, optional), IDVerificationFaceMatchResult ( string, optional), IDVerificationLivenessResult ( string, optional), SigningKey ( string, optional): Url for access to signing; Only when this is an embedded signer, SignerReference ( string, optional): Signer reference, IsFaceToFaceSigning ( boolean), VideoConfirmationEnabled ( boolean), ReviewBeforeSigningEnabled ( boolean), MobileNumber ( string, optional): Mobile number of signer, for SMS secured forms. Must include the mobile carrier code e.g. Australia 04, New Zealand 027 or 021 etc, MobileCountry ( string, optional): Mobile Country code for phone number e.g. Australia 61, New Zealand 64 etc, ShareUsers ( Array\[ShareUser\], optional), ClientReference ( string, optional), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } VideoConfirmationDetail { Name ( string, optional), ShortUrl ( string, optional), IsVideoReady ( boolean), Password ( string, optional), Email ( string, optional), IsWitness ( boolean), IsVideoDisabled ( boolean), IsVideoOptOut ( boolean), WitnessOwner ( string, optional) } ShareUser { IsDefault ( boolean), IsOwner ( boolean), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } DocumentLog { Name ( string, optional): Name of user responsible for action, Action ( string, optional): Log entry, Date ( date, optional): Date of log entry, GMT ( string, optional): GMT Offset, Role ( string, optional): Role of user responsible for action } ``` { "Reference": "", "ProcessingStatus": "", "Documents": [ { "Name": "", "FormDirectReference": "", "Signers": [ { "HasSigned": false, "DeclinedReason": "", "VideoConfirmationDetail": { "Name": "", "ShortUrl": "", "IsVideoReady": false, "Password": "", "Email": "", "IsWitness": false, "IsVideoDisabled": false, "IsVideoOptOut": false, "WitnessOwner": "" }, "IDCheckStatus": "", "IDVerificationStatus": "", "IDVerificationResult": "", "IDVerificationFaceMatchResult": "", "IDVerificationLivenessResult": "", "SigningKey": "", "SignerReference": "", "IsFaceToFaceSigning": false, "VideoConfirmationEnabled": false, "ReviewBeforeSigningEnabled": false, "MobileNumber": "", "MobileCountry": "", "ShareUsers": [ { "IsDefault": false, "IsOwner": false, "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "ClientReference": "", "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "Status": "", "DueDate": "Date", "GMT": "", "LastSignedDate": "Date", "Folder": "Date", "Logs": [ { "Name": "", "Action": "", "Date": "date", "GMT": "", "Role": "" } ], "HasFileUploaded": false, "PackageReference": "", "ClientReference": "", "EditUrl": "", "IDVerificationRequested": false, "Reference": "" } ] } ``` Response Content Type application/json #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | ProcessDocumentReference | | **Mail merge process document reference** | path | string | #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 401 | Unauthorised: Check your api key | | | 404 | Unable to find document, please check reference | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [post](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/SmartTag/SmartTagRequest) [/SmartTag/Send/](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/SmartTag/SmartTagRequest) - [Send smart tag document. See](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/SmartTag/SmartTagRequest)[detailed documentation for Smart Tag](https://blog.securedsigning.com/documentation/developer/smarttag-api). #### Implementation Notes Send a smart tag document. See [detailed documentation for Smart Tag](https://blog.securedsigning.com/documentation/developer/smarttag-api). #### Response Class (Status ) - Model - Model Schema DocumentResponse { Name ( string): File Name, FormDirectReference ( string, optional): Form reference, Signers ( Array\[SignerStatusResponse\]): List of signers, Status ( string, optional) = \['Complete' or 'Declined' or 'Expired' or 'Rejected' or 'Signed' or 'Filling' or 'Filling Form' or 'InProgress' or 'Signing' or 'NotStart' or '# of # Signed'\]: Document signing status, DueDate ( Date, optional): Due Date of document, GMT ( string, optional): GMT Offset, LastSignedDate ( Date, optional): Date of latest signature, Folder ( Date, optional) = \['InBox' or 'Progress' or 'Signed'\]: The folder of the document, Logs ( Array\[DocumentLog\], optional): Document logs, HasFileUploaded ( boolean): Whether invitee uploaded any files during signing process., PackageReference ( string, optional): Package reference, ClientReference ( string, optional): client side referese; e.g. external id etc., EditUrl ( string, optional), IDVerificationRequested ( boolean): ID Verification requested., Reference ( string): Document reference, used for document access } SignerStatusResponse { HasSigned ( boolean): User signing status, DeclinedReason ( string, optional): Declined reason. Return only when invitee declined to sign., VideoConfirmationDetail ( VideoConfirmationDetail, optional), IDCheckStatus ( string, optional), IDVerificationStatus ( string, optional), IDVerificationResult ( string, optional), IDVerificationFaceMatchResult ( string, optional), IDVerificationLivenessResult ( string, optional), SigningKey ( string, optional): Url for access to signing; Only when this is an embedded signer, SignerReference ( string, optional): Signer reference, IsFaceToFaceSigning ( boolean), VideoConfirmationEnabled ( boolean), ReviewBeforeSigningEnabled ( boolean), MobileNumber ( string, optional): Mobile number of signer, for SMS secured forms. Must include the mobile carrier code e.g. Australia 04, New Zealand 027 or 021 etc, MobileCountry ( string, optional): Mobile Country code for phone number e.g. Australia 61, New Zealand 64 etc, ShareUsers ( Array\[ShareUser\], optional), ClientReference ( string, optional), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } VideoConfirmationDetail { Name ( string, optional), ShortUrl ( string, optional), IsVideoReady ( boolean), Password ( string, optional), Email ( string, optional), IsWitness ( boolean), IsVideoDisabled ( boolean), IsVideoOptOut ( boolean), WitnessOwner ( string, optional) } ShareUser { IsDefault ( boolean), IsOwner ( boolean), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } DocumentLog { Name ( string, optional): Name of user responsible for action, Action ( string, optional): Log entry, Date ( date, optional): Date of log entry, GMT ( string, optional): GMT Offset, Role ( string, optional): Role of user responsible for action } ``` [ { "Name": "", "FormDirectReference": "", "Signers": [ { "HasSigned": false, "DeclinedReason": "", "VideoConfirmationDetail": { "Name": "", "ShortUrl": "", "IsVideoReady": false, "Password": "", "Email": "", "IsWitness": false, "IsVideoDisabled": false, "IsVideoOptOut": false, "WitnessOwner": "" }, "IDCheckStatus": "", "IDVerificationStatus": "", "IDVerificationResult": "", "IDVerificationFaceMatchResult": "", "IDVerificationLivenessResult": "", "SigningKey": "", "SignerReference": "", "IsFaceToFaceSigning": false, "VideoConfirmationEnabled": false, "ReviewBeforeSigningEnabled": false, "MobileNumber": "", "MobileCountry": "", "ShareUsers": [ { "IsDefault": false, "IsOwner": false, "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "ClientReference": "", "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "Status": "", "DueDate": "Date", "GMT": "", "LastSignedDate": "Date", "Folder": "Date", "Logs": [ { "Name": "", "Action": "", "Date": "date", "GMT": "", "Role": "" } ], "HasFileUploaded": false, "PackageReference": "", "ClientReference": "", "EditUrl": "", "IDVerificationRequested": false, "Reference": "" } ] ``` Response Content Type application/json #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | body | Parameter content type: application/json | | body | - Model - Model Schema SmartTagRequest { DocumentReferences ( Array\[string\]): document reference, Embedded ( boolean): Shows if embedded signing, DueDate ( Date): Due date that document are to be signed by., GMT ( string, optional): GMT Offset, InvitationEmailTemplateReference ( string, optional): Invitation Email template reference, if not set, use the user default one., CompletionEmailTemplateReference ( string, optional): Completion Email template reference, if not set, use the user default one., ReturnUrl ( string, optional): Return Url, Signers ( Array\[SmartTagInvitee\], optional): Signer details, overwrite details populated in document, ListItems ( Array\[DropDownListItem\], optional): The list options for drop down list field smart tag, NoPackage ( boolean): Whether all documents are in a package (by default) or sent separately, SingleDocumentAsPackage ( boolean): Create a package even if only one document, NotifyUrl ( string, optional): Notify Url, PackageName ( string, optional): The name of the package; if empty and only one document in package, the name will be document name., ShareUsers ( Array\[ShareUser\], optional): Share user details, if no share user specified in document, NoInvitationEmailTemplate ( boolean): if true, use Secured Signing default template instead, ignore any template settings, Supervising ( boolean) } SmartTagInvitee { Embedded ( boolean, optional): Shows if embedded signing only for this invitee, ReturnUrl ( string, optional): Return Url only for this invitee, EmailTemplateReference ( string, optional): Invitation email template reference only for this invitee; Obsolete, use InvitationEmailTemplateReference instead;, InvitationEmailTemplateReference ( string, optional): Invitation email template reference only for this invitee, CompletionEmailTemplateReference ( string, optional): Completion email template reference only for this invitee, IsPersonalMessage ( boolean): Tell if the InvitationText is for personal message or customized email template, InvitationText ( string, optional): Customized email invitation text, EmailSubject ( string, optional): Customized email subject, Attachments ( Array\[string\], optional): The reference of attachments, NoInvitationEmailTemplate ( boolean): if true, use Secured Signing default template instead, ignore any template settings, MobileNumber ( string, optional): Mobile number of signer, for SMS secured forms. Must include the mobile carrier code e.g. Australia 04, New Zealand 027 or 021 etc, MobileCountry ( string, optional): Mobile Country code for phone number e.g. Australia 61, New Zealand 64 etc, ShareUsers ( Array\[ShareUser\], optional), ClientReference ( string, optional), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } ShareUser { IsDefault ( boolean), IsOwner ( boolean), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } DropDownListItem { ClientField ( string): The field name on client side, Item ( string): Item name, Value ( string): Item value } ``` { "DocumentReferences": [ "" ], "Embedded": false, "DueDate": "Date", "GMT": "", "InvitationEmailTemplateReference": "", "CompletionEmailTemplateReference": "", "ReturnUrl": "", "Signers": [ { "Embedded": false, "ReturnUrl": "", "EmailTemplateReference": "", "InvitationEmailTemplateReference": "", "CompletionEmailTemplateReference": "", "IsPersonalMessage": false, "InvitationText": "", "EmailSubject": "", "Attachments": [ "" ], "NoInvitationEmailTemplate": false, "MobileNumber": "", "MobileCountry": "", "ShareUsers": [ { "IsDefault": false, "IsOwner": false, "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "ClientReference": "", "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "ListItems": [ { "ClientField": "", "Item": "", "Value": "" } ], "NoPackage": false, "SingleDocumentAsPackage": false, "NotifyUrl": "", "PackageName": "", "ShareUsers": [ { "IsDefault": false, "IsOwner": false, "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "NoInvitationEmailTemplate": false, "Supervising": false } ``` Click to set as parameter value | #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 401 | Unauthorised: Check your api key | | | 404 | Unable to find document, please check reference | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [post](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/SmartTag/SmartTag2Request) [/SmartTag/Send2/](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/SmartTag/SmartTag2Request) - [Send smart tag document. See](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/SmartTag/SmartTag2Request)[detailed documentation for Smart Tag](https://blog.securedsigning.com/documentation/developer/smarttag-api). #### Implementation Notes Send a smart tag document. See [detailed documentation for Smart Tag](https://blog.securedsigning.com/documentation/developer/smarttag-api). #### Response Class (Status ) - Model - Model Schema PackageResponse { PackageReference ( string, optional), PackageName ( string, optional), PackageStatus ( string, optional), Documents ( Array\[DocumentResponse\], optional) } DocumentResponse { Name ( string): File Name, FormDirectReference ( string, optional): Form reference, Signers ( Array\[SignerStatusResponse\]): List of signers, Status ( string, optional) = \['Complete' or 'Declined' or 'Expired' or 'Rejected' or 'Signed' or 'Filling' or 'Filling Form' or 'InProgress' or 'Signing' or 'NotStart' or '# of # Signed'\]: Document signing status, DueDate ( Date, optional): Due Date of document, GMT ( string, optional): GMT Offset, LastSignedDate ( Date, optional): Date of latest signature, Folder ( Date, optional) = \['InBox' or 'Progress' or 'Signed'\]: The folder of the document, Logs ( Array\[DocumentLog\], optional): Document logs, HasFileUploaded ( boolean): Whether invitee uploaded any files during signing process., PackageReference ( string, optional): Package reference, ClientReference ( string, optional): client side referese; e.g. external id etc., EditUrl ( string, optional), IDVerificationRequested ( boolean): ID Verification requested., Reference ( string): Document reference, used for document access } SignerStatusResponse { HasSigned ( boolean): User signing status, DeclinedReason ( string, optional): Declined reason. Return only when invitee declined to sign., VideoConfirmationDetail ( VideoConfirmationDetail, optional), IDCheckStatus ( string, optional), IDVerificationStatus ( string, optional), IDVerificationResult ( string, optional), IDVerificationFaceMatchResult ( string, optional), IDVerificationLivenessResult ( string, optional), SigningKey ( string, optional): Url for access to signing; Only when this is an embedded signer, SignerReference ( string, optional): Signer reference, IsFaceToFaceSigning ( boolean), VideoConfirmationEnabled ( boolean), ReviewBeforeSigningEnabled ( boolean), MobileNumber ( string, optional): Mobile number of signer, for SMS secured forms. Must include the mobile carrier code e.g. Australia 04, New Zealand 027 or 021 etc, MobileCountry ( string, optional): Mobile Country code for phone number e.g. Australia 61, New Zealand 64 etc, ShareUsers ( Array\[ShareUser\], optional), ClientReference ( string, optional), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } VideoConfirmationDetail { Name ( string, optional), ShortUrl ( string, optional), IsVideoReady ( boolean), Password ( string, optional), Email ( string, optional), IsWitness ( boolean), IsVideoDisabled ( boolean), IsVideoOptOut ( boolean), WitnessOwner ( string, optional) } ShareUser { IsDefault ( boolean), IsOwner ( boolean), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } DocumentLog { Name ( string, optional): Name of user responsible for action, Action ( string, optional): Log entry, Date ( date, optional): Date of log entry, GMT ( string, optional): GMT Offset, Role ( string, optional): Role of user responsible for action } ``` { "PackageReference": "", "PackageName": "", "PackageStatus": "", "Documents": [ { "Name": "", "FormDirectReference": "", "Signers": [ { "HasSigned": false, "DeclinedReason": "", "VideoConfirmationDetail": { "Name": "", "ShortUrl": "", "IsVideoReady": false, "Password": "", "Email": "", "IsWitness": false, "IsVideoDisabled": false, "IsVideoOptOut": false, "WitnessOwner": "" }, "IDCheckStatus": "", "IDVerificationStatus": "", "IDVerificationResult": "", "IDVerificationFaceMatchResult": "", "IDVerificationLivenessResult": "", "SigningKey": "", "SignerReference": "", "IsFaceToFaceSigning": false, "VideoConfirmationEnabled": false, "ReviewBeforeSigningEnabled": false, "MobileNumber": "", "MobileCountry": "", "ShareUsers": [ { "IsDefault": false, "IsOwner": false, "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "ClientReference": "", "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "Status": "", "DueDate": "Date", "GMT": "", "LastSignedDate": "Date", "Folder": "Date", "Logs": [ { "Name": "", "Action": "", "Date": "date", "GMT": "", "Role": "" } ], "HasFileUploaded": false, "PackageReference": "", "ClientReference": "", "EditUrl": "", "IDVerificationRequested": false, "Reference": "" } ] } ``` Response Content Type application/json #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | body | Parameter content type: application/json | | body | - Model - Model Schema SmartTag2Request { DocumentReferences ( Array\[string\]): document reference, Embedded ( boolean): Shows if embedded signing, DueDate ( Date): Due date that document are to be signed by., GMT ( string, optional): GMT Offset, InvitationEmailTemplateReference ( string, optional): Invitation Email template reference, if not set, use the user default one., CompletionEmailTemplateReference ( string, optional): Completion Email template reference, if not set, use the user default one., ReturnUrl ( string, optional): Return Url, Signers ( Array\[SmartTagInvitee\], optional): Signer details, overwrite details populated in document, ListItems ( Array\[DropDownListItem\], optional): The list options for drop down list field smart tag, NoPackage ( boolean): Whether all documents are in a package (by default) or sent separately, SingleDocumentAsPackage ( boolean): Create a package even if only one document, NotifyUrl ( string, optional): Notify Url, PackageName ( string, optional): The name of the package; if empty and only one document in package, the name will be document name., ShareUsers ( Array\[ShareUser\], optional): Share user details, if no share user specified in document, NoInvitationEmailTemplate ( boolean): if true, use Secured Signing default template instead, ignore any template settings, Supervising ( boolean) } SmartTagInvitee { Embedded ( boolean, optional): Shows if embedded signing only for this invitee, ReturnUrl ( string, optional): Return Url only for this invitee, EmailTemplateReference ( string, optional): Invitation email template reference only for this invitee; Obsolete, use InvitationEmailTemplateReference instead;, InvitationEmailTemplateReference ( string, optional): Invitation email template reference only for this invitee, CompletionEmailTemplateReference ( string, optional): Completion email template reference only for this invitee, IsPersonalMessage ( boolean): Tell if the InvitationText is for personal message or customized email template, InvitationText ( string, optional): Customized email invitation text, EmailSubject ( string, optional): Customized email subject, Attachments ( Array\[string\], optional): The reference of attachments, NoInvitationEmailTemplate ( boolean): if true, use Secured Signing default template instead, ignore any template settings, MobileNumber ( string, optional): Mobile number of signer, for SMS secured forms. Must include the mobile carrier code e.g. Australia 04, New Zealand 027 or 021 etc, MobileCountry ( string, optional): Mobile Country code for phone number e.g. Australia 61, New Zealand 64 etc, ShareUsers ( Array\[ShareUser\], optional), ClientReference ( string, optional), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } ShareUser { IsDefault ( boolean), IsOwner ( boolean), FirstName ( string): First name of user, MiddleName ( string, optional): Middle name of user, LastName ( string): Last name of user, Email ( string): Email address of user } DropDownListItem { ClientField ( string): The field name on client side, Item ( string): Item name, Value ( string): Item value } ``` { "DocumentReferences": [ "" ], "Embedded": false, "DueDate": "Date", "GMT": "", "InvitationEmailTemplateReference": "", "CompletionEmailTemplateReference": "", "ReturnUrl": "", "Signers": [ { "Embedded": false, "ReturnUrl": "", "EmailTemplateReference": "", "InvitationEmailTemplateReference": "", "CompletionEmailTemplateReference": "", "IsPersonalMessage": false, "InvitationText": "", "EmailSubject": "", "Attachments": [ "" ], "NoInvitationEmailTemplate": false, "MobileNumber": "", "MobileCountry": "", "ShareUsers": [ { "IsDefault": false, "IsOwner": false, "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "ClientReference": "", "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "ListItems": [ { "ClientField": "", "Item": "", "Value": "" } ], "NoPackage": false, "SingleDocumentAsPackage": false, "NotifyUrl": "", "PackageName": "", "ShareUsers": [ { "IsDefault": false, "IsOwner": false, "FirstName": "", "MiddleName": "", "LastName": "", "Email": "" } ], "NoInvitationEmailTemplate": false, "Supervising": false } ``` Click to set as parameter value | #### Response Messages | HTTP Status Code | Reason | Response Model | | --- | --- | --- | | 200 | Request successful | | | 401 | Unauthorised: Check your api key | | | 404 | Unable to find document, please check reference | | | 500 | Unhandled error: Please contact Secured Signing | | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - ## [UI](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/UI) - [Show/Hide](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/UI) - List Operations - Expand Operations - Raw - - ### [get](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/UI/UIResourceRequest) [/UI/Resource](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/UI/UIResourceRequest) - [Gets a resource by type](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/UI/UIResourceRequest) #### Implementation Notes Gets a resource type #### Response Class (Status ) - Model - Model Schema HttpResult { ResponseText ( string, optional), ResponseStream ( Stream, optional), FileInfo ( FileInfo, optional), ContentType ( string, optional), Headers ( Dictionary , optional), Cookies ( Array\[Cookie\], optional), ETag ( string, optional), Age ( string, optional), MaxAge ( string, optional), Expires ( Date, optional), LastModified ( Date, optional), CacheControl ( long) = \['0 (None)' or '1 (Public)' or '2 (Private)' or '4 (MustRevalidate)' or '8 (NoCache)' or '16 (NoStore)' or '32 (NoTransform)' or '64 (ProxyRevalidate)'\], ResultScope ( Func , optional), AllowsPartialResponse ( boolean), Location ( string, optional), Options ( IDictionary , optional), Status ( int), StatusCode ( string) = \['Continue' or 'SwitchingProtocols' or 'OK' or 'Created' or 'Accepted' or 'NonAuthoritativeInformation' or 'NoContent' or 'ResetContent' or 'PartialContent' or 'MultipleChoices' or 'Ambiguous' or 'MovedPermanently' or 'Moved' or 'Found' or 'Redirect' or 'SeeOther' or 'RedirectMethod' or 'NotModified' or 'UseProxy' or 'Unused' or 'TemporaryRedirect' or 'RedirectKeepVerb' or 'BadRequest' or 'Unauthorized' or 'PaymentRequired' or 'Forbidden' or 'NotFound' or 'MethodNotAllowed' or 'NotAcceptable' or 'ProxyAuthenticationRequired' or 'RequestTimeout' or 'Conflict' or 'Gone' or 'LengthRequired' or 'PreconditionFailed' or 'RequestEntityTooLarge' or 'RequestUriTooLong' or 'UnsupportedMediaType' or 'RequestedRangeNotSatisfiable' or 'ExpectationFailed' or 'UpgradeRequired' or 'InternalServerError' or 'NotImplemented' or 'BadGateway' or 'ServiceUnavailable' or 'GatewayTimeout' or 'HttpVersionNotSupported'\], StatusDescription ( string, optional), Response ( Object, optional), ResponseFilter ( IContentTypeWriter, optional), RequestContext ( IRequest, optional), View ( string, optional), Template ( string, optional), PaddingLength ( int), IsPartialRequest ( boolean) } Stream { } FileInfo { ClientReference ( string, optional): The reference of the document on client side, Name ( string): File Name, FileType ( string) = \['pdf' or 'doc' or 'docx' or 'rtf'\]: File type of file, FileUrl ( string): Url to download retrieve file data } Dictionary { } Cookie { } Func { } IDictionary { } Object { } IContentTypeWriter { } IRequest { } ``` { "ResponseText": "", "ResponseStream": {}, "FileInfo": { "ClientReference": "", "Name": "", "FileType": "", "FileUrl": "" }, "ContentType": "", "Headers": {}, "Cookies": [ {} ], "ETag": "", "Age": "", "MaxAge": "", "Expires": "Date", "LastModified": "Date", "CacheControl": "long", "ResultScope": {}, "AllowsPartialResponse": false, "Location": "", "Options": {}, "Status": "int", "StatusCode": "", "StatusDescription": "", "Response": {}, "ResponseFilter": {}, "RequestContext": {}, "View": "", "Template": "", "PaddingLength": "int", "IsPartialRequest": false } ``` Response Content Type application/json #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | ResourceType | 14 16 | Resource type: 14 for I Sign and 16 for We Sign | query | int | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [get](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/UI/UIResourceRequest_0) [/UI/Resource/{ResourceType}](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/UI/UIResourceRequest_0) - [Gets a resource by type](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/UI/UIResourceRequest_0) #### Implementation Notes Gets a resource type #### Response Class (Status ) - Model - Model Schema HttpResult { ResponseText ( string, optional), ResponseStream ( Stream, optional), FileInfo ( FileInfo, optional), ContentType ( string, optional), Headers ( Dictionary , optional), Cookies ( Array\[Cookie\], optional), ETag ( string, optional), Age ( string, optional), MaxAge ( string, optional), Expires ( Date, optional), LastModified ( Date, optional), CacheControl ( long) = \['0 (None)' or '1 (Public)' or '2 (Private)' or '4 (MustRevalidate)' or '8 (NoCache)' or '16 (NoStore)' or '32 (NoTransform)' or '64 (ProxyRevalidate)'\], ResultScope ( Func , optional), AllowsPartialResponse ( boolean), Location ( string, optional), Options ( IDictionary , optional), Status ( int), StatusCode ( string) = \['Continue' or 'SwitchingProtocols' or 'OK' or 'Created' or 'Accepted' or 'NonAuthoritativeInformation' or 'NoContent' or 'ResetContent' or 'PartialContent' or 'MultipleChoices' or 'Ambiguous' or 'MovedPermanently' or 'Moved' or 'Found' or 'Redirect' or 'SeeOther' or 'RedirectMethod' or 'NotModified' or 'UseProxy' or 'Unused' or 'TemporaryRedirect' or 'RedirectKeepVerb' or 'BadRequest' or 'Unauthorized' or 'PaymentRequired' or 'Forbidden' or 'NotFound' or 'MethodNotAllowed' or 'NotAcceptable' or 'ProxyAuthenticationRequired' or 'RequestTimeout' or 'Conflict' or 'Gone' or 'LengthRequired' or 'PreconditionFailed' or 'RequestEntityTooLarge' or 'RequestUriTooLong' or 'UnsupportedMediaType' or 'RequestedRangeNotSatisfiable' or 'ExpectationFailed' or 'UpgradeRequired' or 'InternalServerError' or 'NotImplemented' or 'BadGateway' or 'ServiceUnavailable' or 'GatewayTimeout' or 'HttpVersionNotSupported'\], StatusDescription ( string, optional), Response ( Object, optional), ResponseFilter ( IContentTypeWriter, optional), RequestContext ( IRequest, optional), View ( string, optional), Template ( string, optional), PaddingLength ( int), IsPartialRequest ( boolean) } Stream { } FileInfo { ClientReference ( string, optional): The reference of the document on client side, Name ( string): File Name, FileType ( string) = \['pdf' or 'doc' or 'docx' or 'rtf'\]: File type of file, FileUrl ( string): Url to download retrieve file data } Dictionary { } Cookie { } Func { } IDictionary { } Object { } IContentTypeWriter { } IRequest { } ``` { "ResponseText": "", "ResponseStream": {}, "FileInfo": { "ClientReference": "", "Name": "", "FileType": "", "FileUrl": "" }, "ContentType": "", "Headers": {}, "Cookies": [ {} ], "ETag": "", "Age": "", "MaxAge": "", "Expires": "Date", "LastModified": "Date", "CacheControl": "long", "ResultScope": {}, "AllowsPartialResponse": false, "Location": "", "Options": {}, "Status": "int", "StatusCode": "", "StatusDescription": "", "Response": {}, "ResponseFilter": {}, "RequestContext": {}, "View": "", "Template": "", "PaddingLength": "int", "IsPartialRequest": false } ``` Response Content Type application/json #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | ResourceType | 14 16 | Resource type: 14 for I Sign and 16 for We Sign | query | int | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [get](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/UI/UIResource2Request) [/UI/Resource2](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/UI/UIResource2Request) - [Gets a resource by type](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/UI/UIResource2Request) #### Implementation Notes Gets a resource type #### Response Class (Status ) - Model - Model Schema HttpResult { ResponseText ( string, optional), ResponseStream ( Stream, optional), FileInfo ( FileInfo, optional), ContentType ( string, optional), Headers ( Dictionary , optional), Cookies ( Array\[Cookie\], optional), ETag ( string, optional), Age ( string, optional), MaxAge ( string, optional), Expires ( Date, optional), LastModified ( Date, optional), CacheControl ( long) = \['0 (None)' or '1 (Public)' or '2 (Private)' or '4 (MustRevalidate)' or '8 (NoCache)' or '16 (NoStore)' or '32 (NoTransform)' or '64 (ProxyRevalidate)'\], ResultScope ( Func , optional), AllowsPartialResponse ( boolean), Location ( string, optional), Options ( IDictionary , optional), Status ( int), StatusCode ( string) = \['Continue' or 'SwitchingProtocols' or 'OK' or 'Created' or 'Accepted' or 'NonAuthoritativeInformation' or 'NoContent' or 'ResetContent' or 'PartialContent' or 'MultipleChoices' or 'Ambiguous' or 'MovedPermanently' or 'Moved' or 'Found' or 'Redirect' or 'SeeOther' or 'RedirectMethod' or 'NotModified' or 'UseProxy' or 'Unused' or 'TemporaryRedirect' or 'RedirectKeepVerb' or 'BadRequest' or 'Unauthorized' or 'PaymentRequired' or 'Forbidden' or 'NotFound' or 'MethodNotAllowed' or 'NotAcceptable' or 'ProxyAuthenticationRequired' or 'RequestTimeout' or 'Conflict' or 'Gone' or 'LengthRequired' or 'PreconditionFailed' or 'RequestEntityTooLarge' or 'RequestUriTooLong' or 'UnsupportedMediaType' or 'RequestedRangeNotSatisfiable' or 'ExpectationFailed' or 'UpgradeRequired' or 'InternalServerError' or 'NotImplemented' or 'BadGateway' or 'ServiceUnavailable' or 'GatewayTimeout' or 'HttpVersionNotSupported'\], StatusDescription ( string, optional), Response ( Object, optional), ResponseFilter ( IContentTypeWriter, optional), RequestContext ( IRequest, optional), View ( string, optional), Template ( string, optional), PaddingLength ( int), IsPartialRequest ( boolean) } Stream { } FileInfo { ClientReference ( string, optional): The reference of the document on client side, Name ( string): File Name, FileType ( string) = \['pdf' or 'doc' or 'docx' or 'rtf'\]: File type of file, FileUrl ( string): Url to download retrieve file data } Dictionary { } Cookie { } Func { } IDictionary { } Object { } IContentTypeWriter { } IRequest { } ``` { "ResponseText": "", "ResponseStream": {}, "FileInfo": { "ClientReference": "", "Name": "", "FileType": "", "FileUrl": "" }, "ContentType": "", "Headers": {}, "Cookies": [ {} ], "ETag": "", "Age": "", "MaxAge": "", "Expires": "Date", "LastModified": "Date", "CacheControl": "long", "ResultScope": {}, "AllowsPartialResponse": false, "Location": "", "Options": {}, "Status": "int", "StatusCode": "", "StatusDescription": "", "Response": {}, "ResponseFilter": {}, "RequestContext": {}, "View": "", "Template": "", "PaddingLength": "int", "IsPartialRequest": false } ``` Response Content Type application/json #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | ResourceType | 14 16 | Resource type: 14 for I Sign and 16 for We Sign | query | int | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [get](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/UI/UIResource2Request_0) [/UI/Resource2/{ResourceType}](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/UI/UIResource2Request_0) - [Gets a resource by type](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/UI/UIResource2Request_0) #### Implementation Notes Gets a resource type #### Response Class (Status ) - Model - Model Schema HttpResult { ResponseText ( string, optional), ResponseStream ( Stream, optional), FileInfo ( FileInfo, optional), ContentType ( string, optional), Headers ( Dictionary , optional), Cookies ( Array\[Cookie\], optional), ETag ( string, optional), Age ( string, optional), MaxAge ( string, optional), Expires ( Date, optional), LastModified ( Date, optional), CacheControl ( long) = \['0 (None)' or '1 (Public)' or '2 (Private)' or '4 (MustRevalidate)' or '8 (NoCache)' or '16 (NoStore)' or '32 (NoTransform)' or '64 (ProxyRevalidate)'\], ResultScope ( Func , optional), AllowsPartialResponse ( boolean), Location ( string, optional), Options ( IDictionary , optional), Status ( int), StatusCode ( string) = \['Continue' or 'SwitchingProtocols' or 'OK' or 'Created' or 'Accepted' or 'NonAuthoritativeInformation' or 'NoContent' or 'ResetContent' or 'PartialContent' or 'MultipleChoices' or 'Ambiguous' or 'MovedPermanently' or 'Moved' or 'Found' or 'Redirect' or 'SeeOther' or 'RedirectMethod' or 'NotModified' or 'UseProxy' or 'Unused' or 'TemporaryRedirect' or 'RedirectKeepVerb' or 'BadRequest' or 'Unauthorized' or 'PaymentRequired' or 'Forbidden' or 'NotFound' or 'MethodNotAllowed' or 'NotAcceptable' or 'ProxyAuthenticationRequired' or 'RequestTimeout' or 'Conflict' or 'Gone' or 'LengthRequired' or 'PreconditionFailed' or 'RequestEntityTooLarge' or 'RequestUriTooLong' or 'UnsupportedMediaType' or 'RequestedRangeNotSatisfiable' or 'ExpectationFailed' or 'UpgradeRequired' or 'InternalServerError' or 'NotImplemented' or 'BadGateway' or 'ServiceUnavailable' or 'GatewayTimeout' or 'HttpVersionNotSupported'\], StatusDescription ( string, optional), Response ( Object, optional), ResponseFilter ( IContentTypeWriter, optional), RequestContext ( IRequest, optional), View ( string, optional), Template ( string, optional), PaddingLength ( int), IsPartialRequest ( boolean) } Stream { } FileInfo { ClientReference ( string, optional): The reference of the document on client side, Name ( string): File Name, FileType ( string) = \['pdf' or 'doc' or 'docx' or 'rtf'\]: File type of file, FileUrl ( string): Url to download retrieve file data } Dictionary { } Cookie { } Func { } IDictionary { } Object { } IContentTypeWriter { } IRequest { } ``` { "ResponseText": "", "ResponseStream": {}, "FileInfo": { "ClientReference": "", "Name": "", "FileType": "", "FileUrl": "" }, "ContentType": "", "Headers": {}, "Cookies": [ {} ], "ETag": "", "Age": "", "MaxAge": "", "Expires": "Date", "LastModified": "Date", "CacheControl": "long", "ResultScope": {}, "AllowsPartialResponse": false, "Location": "", "Options": {}, "Status": "int", "StatusCode": "", "StatusDescription": "", "Response": {}, "ResponseFilter": {}, "RequestContext": {}, "View": "", "Template": "", "PaddingLength": "int", "IsPartialRequest": false } ``` Response Content Type application/json #### Parameters | Parameter | Value | Description | Parameter Type | Data Type | | --- | --- | --- | --- | --- | | ResourceType | 14 16 | Resource type: 14 for I Sign and 16 for We Sign | query | int | Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers - - ### [get](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/UI/UISetupRequest) [/UI/Setup](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/UI/UISetupRequest) - [Gets a setup resource](https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out#!/UI/UISetupRequest) #### Implementation Notes Gets a setup resource like html page. #### Response Class (Status ) - Model - Model Schema HttpResult { ResponseText ( string, optional), ResponseStream ( Stream, optional), FileInfo ( FileInfo, optional), ContentType ( string, optional), Headers ( Dictionary , optional), Cookies ( Array\[Cookie\], optional), ETag ( string, optional), Age ( string, optional), MaxAge ( string, optional), Expires ( Date, optional), LastModified ( Date, optional), CacheControl ( long) = \['0 (None)' or '1 (Public)' or '2 (Private)' or '4 (MustRevalidate)' or '8 (NoCache)' or '16 (NoStore)' or '32 (NoTransform)' or '64 (ProxyRevalidate)'\], ResultScope ( Func , optional), AllowsPartialResponse ( boolean), Location ( string, optional), Options ( IDictionary , optional), Status ( int), StatusCode ( string) = \['Continue' or 'SwitchingProtocols' or 'OK' or 'Created' or 'Accepted' or 'NonAuthoritativeInformation' or 'NoContent' or 'ResetContent' or 'PartialContent' or 'MultipleChoices' or 'Ambiguous' or 'MovedPermanently' or 'Moved' or 'Found' or 'Redirect' or 'SeeOther' or 'RedirectMethod' or 'NotModified' or 'UseProxy' or 'Unused' or 'TemporaryRedirect' or 'RedirectKeepVerb' or 'BadRequest' or 'Unauthorized' or 'PaymentRequired' or 'Forbidden' or 'NotFound' or 'MethodNotAllowed' or 'NotAcceptable' or 'ProxyAuthenticationRequired' or 'RequestTimeout' or 'Conflict' or 'Gone' or 'LengthRequired' or 'PreconditionFailed' or 'RequestEntityTooLarge' or 'RequestUriTooLong' or 'UnsupportedMediaType' or 'RequestedRangeNotSatisfiable' or 'ExpectationFailed' or 'UpgradeRequired' or 'InternalServerError' or 'NotImplemented' or 'BadGateway' or 'ServiceUnavailable' or 'GatewayTimeout' or 'HttpVersionNotSupported'\], StatusDescription ( string, optional), Response ( Object, optional), ResponseFilter ( IContentTypeWriter, optional), RequestContext ( IRequest, optional), View ( string, optional), Template ( string, optional), PaddingLength ( int), IsPartialRequest ( boolean) } Stream { } FileInfo { ClientReference ( string, optional): The reference of the document on client side, Name ( string): File Name, FileType ( string) = \['pdf' or 'doc' or 'docx' or 'rtf'\]: File type of file, FileUrl ( string): Url to download retrieve file data } Dictionary { } Cookie { } Func { } IDictionary { } Object { } IContentTypeWriter { } IRequest { } ``` { "ResponseText": "", "ResponseStream": {}, "FileInfo": { "ClientReference": "", "Name": "", "FileType": "", "FileUrl": "" }, "ContentType": "", "Headers": {}, "Cookies": [ {} ], "ETag": "", "Age": "", "MaxAge": "", "Expires": "Date", "LastModified": "Date", "CacheControl": "long", "ResultScope": {}, "AllowsPartialResponse": false, "Location": "", "Options": {}, "Status": "int", "StatusCode": "", "StatusDescription": "", "Response": {}, "ResponseFilter": {}, "RequestContext": {}, "View": "", "Template": "", "PaddingLength": "int", "IsPartialRequest": false } ``` Response Content Type application/json Hide Response #### Request URL #### Response Body #### Response Code #### Response Headers #### \[ base url: https://api.securedsigning.com/web/v1.4 \] [Features & Updates](https://blog.securedsigning.com/tag/features-updates), [News](https://blog.securedsigning.com/tag/news), [Integrations News](https://blog.securedsigning.com/tag/integrations-news), [News & Updates](https://blog.securedsigning.com/tag/news-updates) ## Read On [![](https://blog.securedsigning.com/hs-fs/hubfs/Imported_Blog_Media/Enable-auto-top-with-Secured-Signing.png?width=352&name=Enable-auto-top-with-Secured-Signing.png)](https://blog.securedsigning.com/support/how-to-top-up-secured-signing-credits) ### [Notary: How to top up your account with Secured Signing Credits](https://blog.securedsigning.com/support/how-to-top-up-secured-signing-credits) If you have selected Auto TopUp (under My Account > My settings) and your account credits... [![](https://blog.securedsigning.com/hs-fs/hubfs/Imported_Blog_Media/Home-Page-Hero-Image-01-Hero-8-3.png?width=352&name=Home-Page-Hero-Image-01-Hero-8-3.png)](https://blog.securedsigning.com/support/what-is-an-electronic-signature) ### [What is an Electronic Signature?](https://blog.securedsigning.com/support/what-is-an-electronic-signature) Electronic signatures are defined as an electronic sound (e.g., audio files of a person’s... [![](https://blog.securedsigning.com/hs-fs/hubfs/Imported_Blog_Media/jobadder-we-sign-1.png?width=352&name=jobadder-we-sign-1.png)](https://blog.securedsigning.com/support/jobadder-invite-yourself-and-other-to-sign-with-we-sign) ### [JobAdder: Invite Yourself and Other to Sign With We Sign](https://blog.securedsigning.com/support/jobadder-invite-yourself-and-other-to-sign-with-we-sign) ### **Step 1: Open Secured Signing** Open a record where Secured Signing is integrated. Click... ##### Secured Signing [Terms & Use](https://www.securedsigning.com/terms/)[Privacy Policy](https://www.securedsigning.com/privacy-and-data/) [Visit Our Website](https://www.securedsigning.com) ```json { "@context" : "https://schema.org", "@type" : "BlogPosting", "author" : { "@type" : "Person", "name" : "Admin", "url" : "https://blog.securedsigning.com/author/admin" }, "datePublished" : "2023-08-22T12:00:00.000Z", "headline" : "Secured Signing API Without OAuth 2 - Secured Signing", "image" : [ "https://blog.securedsigning.com/hubfs/Imported_Blog_Media/Home-Page-Hero-Image-01-Hero-8-3.png" ], "mainEntityOfPage" : { "@id" : "https://blog.securedsigning.com/support/secured-signing-api-without-oauth-2/attachmentreferencecommittry-it-out", "@type" : "WebPage" }, "publisher" : { "@type" : "Organization", "logo" : { "@type" : "ImageObject", "url" : "https://blog.securedsigning.com/hubfs/Logos/Secured%20Signing%20Blue%20Logo%20-%20SVG.svg" }, "name" : "Secured Signing" } } ```