Conga Sign API Integration

{ "x-generator": "NSwag v13.15.5.0 (NJsonSchema v10.6.6.0 (Newtonsoft.Json v13.0.0.0))", "openapi": "3.0.0", "info": { "title": "", "version": "1.0.0" }, "servers": [ { "url": "https://coreapps-rls.congacloud.com/api/ingress" } ], "paths": { "/v1/Merge": { "post": { "tags": [ "Merge" ], "summary": "Initiate the merge workflow", "description": "Translates your merge request into data sets and then initiates the merge. For more information, see [Conga Composer API Use Cases.](https://documentation.conga.com/composer/latest/conga-composer-api-use-cases-203496246.html)", "operationId": "Merge_Post", "requestBody": { "x-name": "composerMergeRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComposerMergeRequest" } } }, "required": true, "x-position": 1 }, "responses": { "400": { "description": "Invalid Data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComposerMergeResponseModel" } } } } }, "security": [ { "JWT": [] } ] } } }, "components": { "schemas": { "ProblemDetails": { "type": "object", "additionalProperties": { "nullable": true }, "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true }, "extensions": { "type": "object", "additionalProperties": {} } } }, "HttpResponse": { "type": "object", "x-abstract": true, "additionalProperties": false, "properties": { "bodyWriter": { "$ref": "#/components/schemas/PipeWriter" } } }, "PipeWriter": { "type": "object", "x-abstract": true, "additionalProperties": false, "properties": { "canGetUnflushedBytes": { "type": "boolean" }, "unflushedBytes": { "type": "integer", "format": "int64" } } }, "FileRetrievalRequest": { "type": "object", "description": "FileRetrievalRequest.", "additionalProperties": false, "properties": { "fileId": { "type": "string", "description": "File Id" }, "includeMetadata": { "type": "boolean", "description": "Include Metadata" }, "orgId": { "type": "string", "description": "Org Id" } } }, "ComposerMergeResponseModel": { "type": "object", "additionalProperties": false, "properties": { "correlationId": { "type": "string" }, "status": { "type": "string" }, "result": { "$ref": "#/components/schemas/Result" } } }, "Result": { "type": "object", "additionalProperties": false, "properties": { "statusCode": { "$ref": "#/components/schemas/StatusCodes" }, "statusMessage": { "type": "array", "items": { "$ref": "#/components/schemas/StatusMessage" } } } }, "StatusCodes": { "type": "string", "description": "", "x-enumNames": [ "Success", "InternalHostError", "NotFound", "BusinessRuleViolation", "FailedValidation", "SecurityException", "InvalidRequestdata", "ServiceUnavailable" ], "enum": [ "Success", "InternalHostError", "NotFound", "BusinessRuleViolation", "FailedValidation", "SecurityException", "InvalidRequestdata", "ServiceUnavailable" ] }, "StatusMessage": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string" }, "description": { "type": "string" } } }, "ComposerMergeRequest": { "type": "object", "additionalProperties": false, "properties": { "salesforceRequest": { "$ref": "#/components/schemas/SalesforceRequest" }, "activity": { "$ref": "#/components/schemas/Activity" }, "adaptation": { "$ref": "#/components/schemas/Adaptation" }, "signCommands": { "$ref": "#/components/schemas/SignCommands" }, "saveCopy": { "$ref": "#/components/schemas/SaveCopy" }, "legacyOptions": { "type": "object", "description": "Control the behavior of document generation by including parameter name and value. For more information on supported parameters for API, click [here](https://documentation.conga.com/composer/latest/supported-parameters-for-composer-api-195691044.html).", "additionalProperties": { "type": "string" } }, "templateSources": { "type": "array", "description": "Template source details to get the template from your cloud storage provider.", "items": { "$ref": "#/components/schemas/TemplateSourceRequest" } }, "jsonData": { "type": "string", "description": "JSON payload. For more information on JSON payload use case, click [here](https://documentation.conga.com/composer/latest/generate-document-using-json-data-203491745.html)" }, "destinations": { "type": "array", "description": "Destination details to send the generated document to your cloud storage provider.", "items": { "$ref": "#/components/schemas/DestinationRequest" } }, "output": { "$ref": "#/components/schemas/OutputRequest" } } }, "SalesforceRequest": { "type": "object", "additionalProperties": false, "properties": { "sessionId": { "type": "string", "description": "Salesforce access token." }, "templateId": { "type": "string", "description": "Salesforce template ID." }, "masterId": { "type": "string", "description": "Salesforce master object record ID." }, "queryId": { "type": "string", "description": "Salesforce query ID." }, "emailTemplateId": { "type": "string", "description": "Salesforce email template ID." }, "instanceUrl": { "type": "string", "description": "Salesforce instance URL. You can get this while retiriving Salesforce access token." }, "serverUrl": { "type": "string", "description": "Salesforce server URL. For example: *{{instanceUrl}}/services/Soap/50.0/{{Salesforce org ID}}*." }, "targetOrigin": { "type": "string" }, "relatedContactId": { "type": "string" } } }, "Activity": { "type": "object", "additionalProperties": false, "properties": { "attachOperation": { "type": "string" }, "enabled": { "type": "boolean" }, "followUpDate": { "type": "string", "format": "date-time" }, "saveText": { "type": "string" }, "subject": { "type": "string" } } }, "Adaptation": { "type": "object", "additionalProperties": false, "properties": { "pdfCommands": { "type": "boolean" }, "convertToPDF": { "type": "boolean" } } }, "SignCommands": { "type": "object", "additionalProperties": false, "properties": { "provider": { "type": "string" }, "payload": { "type": "string" } } }, "SaveCopy": { "type": "object", "additionalProperties": false, "properties": { "enabled": { "type": "boolean", "nullable": true }, "saveTo": { "type": "string" } } }, "TemplateSourceRequest": { "type": "object", "additionalProperties": false, "properties": { "integrationName": { "type": "string" }, "fileId": { "type": "string" } } }, "DestinationRequest": { "type": "object", "additionalProperties": false, "properties": { "integrationName": { "type": "string", "description": "gdrive, dropbox, box, sharepoint, onedrive, s3, sftp, or salesforce." }, "folderId": { "type": "string", "description": "Folder ID that correspond to the cloud service provider's actual folder ID. For more information on how to get the folder ID, click [here](https://documentation.conga.com/composer/latest/how-to-get-file-id-for-composer-api-request-193698978.html)" }, "options": { "$ref": "#/components/schemas/DestinationOptionsRequest" } } }, "DestinationOptionsRequest": { "type": "object", "additionalProperties": false, "properties": { "generateLink": { "type": "boolean", "nullable": true }, "notificationEmailTemplateId": { "type": "string" }, "salesforceContentWorkspaceId": { "type": "string" } } }, "OutputRequest": { "type": "object", "additionalProperties": false, "properties": { "generateDocumentDownload": { "type": "boolean", "description": "Set this to **true** to enable document download for the merged document." } } }, "InitiateMultiPartResponse": { "type": "object", "description": "Defines the response from a MultiPart file upload initiation.", "additionalProperties": false, "properties": { "correlationId": { "type": "string", "description": "Correlation Id." }, "transactionId": { "type": "string", "description": "Transaction Id." }, "key": { "type": "string", "description": "Key." }, "dataObjectInitiateMultiPartResponse": { "description": "Data Object Initiate Multi Part Response.", "oneOf": [ { "$ref": "#/components/schemas/DataObjectInitiateMultiPartResponse" } ] } } }, "DataObjectInitiateMultiPartResponse": { "type": "object", "additionalProperties": false, "properties": { "isSuccessful": { "type": "boolean" }, "statusCode": { "type": "integer", "format": "int32" }, "uploadId": { "type": "string", "nullable": true }, "uri": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true } } }, "UploadPartResponse": { "type": "object", "description": "Defines the response object for a single part of a MultiPart upload.", "additionalProperties": false, "properties": { "correlationId": { "type": "string", "description": "Correlation Id." }, "transactionId": { "type": "string", "description": "Transaction Id." }, "dataObjectUploadMultiPartResponse": { "description": "Data Object Upload Multi Part Response", "oneOf": [ { "$ref": "#/components/schemas/DataObjectUploadMultiPartResponse" } ] } } }, "DataObjectUploadMultiPartResponse": { "type": "object", "additionalProperties": false, "properties": { "isSuccessful": { "type": "boolean" }, "statusCode": { "type": "integer", "format": "int32" }, "part": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Part" } ] }, "message": { "type": "string", "nullable": true } } }, "Part": { "type": "object", "additionalProperties": false, "properties": { "partNumber": { "type": "integer", "format": "int32" }, "tag": { "type": "string", "nullable": true } } }, "CompleteMultiPartResponse": { "type": "object", "description": "Defines the response object for completing a MultiPart upload.", "additionalProperties": false, "properties": { "correlationId": { "type": "string", "description": "Correlation Id." }, "transactionId": { "type": "string", "description": "Transaction Id." }, "dataObjectCompleteMultiPartResponse": { "description": "Data Object Upload Multi Part Response", "oneOf": [ { "$ref": "#/components/schemas/DataObjectCompleteMultiPartResponse" } ] } } }, "DataObjectCompleteMultiPartResponse": { "type": "object", "additionalProperties": false, "properties": { "isSuccessful": { "type": "boolean" }, "statusCode": { "type": "integer", "format": "int32" }, "uri": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "sharedUri": { "type": "string", "nullable": true } } }, "CompleteMultiFileRequest": { "type": "object", "description": "Defines the request object for completing a MultiPart upload.", "additionalProperties": false, "properties": { "correlationId": { "type": "string", "description": "Correlation Id." }, "transactionId": { "type": "string", "description": "Transaction Id." }, "uploadInfoList": { "type": "array", "items": { "$ref": "#/components/schemas/UploadInfo" } } } }, "UploadInfo": { "type": "object", "description": "UploadInfo", "additionalProperties": false, "properties": { "filename": { "type": "string" }, "key": { "type": "string" }, "uploadId": { "type": "string" }, "parts": { "type": "array", "items": { "$ref": "#/components/schemas/Part2" } }, "label": { "type": "string", "nullable": true } } }, "Part2": { "type": "object", "description": "Part.", "additionalProperties": false, "properties": { "partNumber": { "type": "integer", "description": "PartNumber", "format": "int32" }, "tag": { "type": "string", "description": "Tag." } } }, "AbortMultiFileRequest": { "type": "object", "description": "Defines the request object for abort a MultiPart upload.", "additionalProperties": false, "properties": { "correlationId": { "type": "string", "description": "Correlation Id." }, "transactionId": { "type": "string", "description": "Transaction Id." }, "abortFileInfoList": { "type": "array", "description": "List of Filename/Key/UploadId info", "items": { "$ref": "#/components/schemas/AbortFileInfo" } } } }, "AbortFileInfo": { "type": "object", "description": "AbortFileInfo.", "additionalProperties": false, "properties": { "key": { "type": "string" }, "uploadId": { "type": "string" } } }, "CompleteMultiPartRequest": { "type": "object", "description": "Defines the request object for completing a MultiPart upload.", "additionalProperties": false, "properties": { "correlationId": { "type": "string", "description": "Correlation Id." }, "transactionId": { "type": "string", "description": "Transaction Id." }, "batchId": { "type": "string", "description": "Final filename for file" }, "key": { "type": "string", "description": "The location in the underlying storing mechanism where the file will be stored." }, "uploadId": { "type": "string", "description": "Identifies an upload." }, "parts": { "type": "array", "description": "A list of ETags ordered by each part.", "items": { "$ref": "#/components/schemas/Part2" } } } }, "AbortMultiPartRequest": { "type": "object", "description": "Defines the request object for abort a MultiPart upload.", "additionalProperties": false, "properties": { "correlationId": { "type": "string", "description": "Correlation Id." }, "transactionId": { "type": "string", "description": "Transaction Id." }, "batchId": { "type": "string", "description": "Storage Prefix" }, "key": { "type": "string", "description": "The location in the underlying storing mechanism where the file will be stored." }, "uploadId": { "type": "string", "description": "Identifies an upload." } } }, "GrabModel": { "type": "object", "additionalProperties": false, "properties": { "congaOrgId": { "type": "string", "description": "Organizational identifier that is found when you deserialize your JWT token." }, "externalLoginGuid": { "type": "string", "description": "Added in support for document delivery 2. It is not required if you are using the Conga token." }, "serviceName": { "type": "string", "description": "gdrive, dropbox, box, sharepoint, onedrive, s3, sftp, or salesforce." }, "fileIds": { "type": "array", "description": "An array of file IDs that correspond to the cloud service provider's actual file IDs. For more information on how to get the file ID, click [here](https://documentation.conga.com/composer/latest/how-to-get-file-id-for-composer-api-request-193698978.html)", "items": { "type": "string" } } } }, "DocGenResponseModel": { "type": "object", "description": "DocGenResponseModel", "additionalProperties": false, "properties": { "correlationId": { "type": "string", "description": "CorrelationId" }, "status": { "type": "string", "description": "Status" }, "result": { "description": "Result", "oneOf": [ { "$ref": "#/components/schemas/Result" } ] } } }, "DocumentWorkflowRequest": { "type": "object", "additionalProperties": false, "properties": { "dataSource": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/DataSource" } }, "templateSource": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/TemplateSource" } }, "documentSource": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/DocumentSource" } }, "destination": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/DocumentDestination" } }, "outputFormat": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DocumentOutputOptions" } ] }, "hasSource": { "type": "boolean" }, "hasData": { "type": "boolean" }, "hasTemplate": { "type": "boolean" }, "hasDocument": { "type": "boolean" }, "isMergeAction": { "type": "boolean" }, "hasMultipleSources": { "type": "boolean" }, "documentActionType": { "type": "string", "nullable": true } } }, "DataSource": { "allOf": [ { "$ref": "#/components/schemas/BaseRequestMetaData" }, { "type": "object", "additionalProperties": false } ] }, "BaseRequestMetaData": { "type": "object", "x-abstract": true, "additionalProperties": false, "properties": { "type": { "type": "string", "nullable": true }, "details": { "type": "object", "nullable": true, "additionalProperties": { "type": "string" } } } }, "TemplateSource": { "allOf": [ { "$ref": "#/components/schemas/BaseRequestMetaData" }, { "type": "object", "additionalProperties": false } ] }, "DocumentSource": { "allOf": [ { "$ref": "#/components/schemas/BaseRequestMetaData" }, { "type": "object", "additionalProperties": false } ] }, "DocumentDestination": { "allOf": [ { "$ref": "#/components/schemas/BaseRequestMetaData" }, { "type": "object", "additionalProperties": false, "properties": { "uris": { "type": "array", "nullable": true, "items": { "type": "string" } } } } ] }, "DocumentOutputOptions": { "type": "object", "additionalProperties": false, "properties": { "fileName": { "type": "string", "nullable": true }, "convertToPdf": { "type": "boolean" }, "customDocumentId": { "type": "string", "nullable": true }, "documentPassword": { "type": "string", "nullable": true }, "pdfProtection": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PdfProtectionOptions" } ] }, "wordProtection": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/WordProtectionOptions" } ] }, "joinDocumentOptions": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/JoinDocumentOptions" } ] }, "watermarkText": { "type": "string", "nullable": true }, "removeWatermark": { "type": "boolean" }, "headerFooter": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/HeaderFooterOptions" } ] }, "customDocumentMetadata": { "type": "object", "nullable": true, "additionalProperties": {} }, "pdfOutputCompliance": { "type": "integer", "format": "int32" } } }, "PdfProtectionOptions": { "type": "object", "additionalProperties": false, "properties": { "allowPrinting": { "type": "boolean" }, "allowCopying": { "type": "boolean" }, "allowCommenting": { "type": "boolean" }, "allowFormFilling": { "type": "boolean" }, "allowAssembling": { "type": "boolean" }, "allowChangingContent": { "type": "boolean" } } }, "WordProtectionOptions": { "type": "object", "additionalProperties": false, "properties": { "protectionLevel": { "type": "integer" }, "protectionLevelPassword": { "type": "string", "nullable": true } } }, "JoinDocumentOptions": { "type": "object", "additionalProperties": false, "properties": { "retainSectionBreak": { "type": "boolean" } } }, "HeaderFooterOptions": { "type": "object", "additionalProperties": false, "properties": { "headerStyle": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/HeaderFooterStyle" } ] }, "footerStyle": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/HeaderFooterStyle" } ] }, "headerText": { "type": "string", "nullable": true }, "footerText": { "type": "string", "nullable": true }, "isOverWrite": { "type": "boolean" }, "retainHeaderFooter": { "type": "boolean" } } }, "HeaderFooterStyle": { "type": "object", "additionalProperties": false, "properties": { "fontFamily": { "type": "string", "nullable": true }, "textColor": { "type": "string", "nullable": true }, "isBold": { "type": "boolean" }, "isItalic": { "type": "boolean" }, "fontSize": { "type": "number", "format": "double" }, "textAlignment": { "type": "string", "nullable": true } } } }, "securitySchemes": { "JWT": { "type": "apiKey", "description": "Provide oauth authentication", "name": "Authorization", "in": "header" } } }, "security": [ { "JWT": [] } ], "tags": [ { "name": "Merge", "description": "Initiate merge workflow" } ] }

{ "x-generator": "NSwag v13.15.0.0 (NJsonSchema v10.6.2.0 (Newtonsoft.Json v12.0.0.0))", "openapi": "3.0.0", "info": { "title": "", "version": "1.0.0" }, "servers": [ { "url": "https://coreapps-rlsprod.congacloud.com/api/sign" } ], "paths": { "/v1/cs-packages": { "post": { "tags": [ "Package" ], "summary": "Create a package with no attachments", "description": "Creates a new package or a template. To create a template, set Type to Template.", "operationId": "Package_CreatePackage", "requestBody": { "x-name": "package", "description": "Package initial information. It doesn't need to be fully filled. It\n should contains at least 'name' property", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Package" } } }, "required": true, "x-position": 1 }, "responses": { "401": { "description": "Not Authorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Package" } } } } }, "security": [ { "JWT": [] } ] } } }, "components": { "schemas": { "Error": { "type": "object", "description": "Object representing an error condition", "additionalProperties": false, "properties": { "code": { "type": "integer", "description": "The error code", "format": "int32", "nullable": true }, "entity": { "description": "The Microsoft Dynamics entity", "oneOf": [ { "$ref": "#/components/schemas/Entity" } ] }, "message": { "type": "string", "description": "The error message" }, "messageKey": { "type": "string", "description": "The error message key" }, "name": { "type": "string", "description": "The error name" }, "technical": { "type": "string", "description": "Technical information about the error" } } }, "Entity": { "type": "object", "description": "Object used to manage entities from Microsoft Dynamics", "additionalProperties": false, "properties": { "data": { "type": "object", "description": "Custom data for the entity", "additionalProperties": {} }, "id": { "type": "string", "description": "Unique id of the entity" }, "name": { "type": "string", "description": "Name of the entity" } } }, "ResultOfAccountRole": { "type": "object", "description": "Object used to manage Conga Sign powered by OneSpan list types", "additionalProperties": false, "properties": { "count": { "type": "integer", "description": "Count", "format": "int32" }, "results": { "type": "array", "description": "Results", "items": { "$ref": "#/components/schemas/AccountRole" } } } }, "AccountRole": { "type": "object", "additionalProperties": false, "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Automatically generated guid", "minLength": 1 }, "name": { "type": "string", "description": "Name" }, "enabled": { "type": "boolean", "description": "Enabled" }, "description": { "type": "string", "description": "Descriptions" }, "permissions": { "type": "array", "description": "[Permissions]", "items": { "type": "string" } }, "inherited": { "type": "boolean", "description": "True when the role was created in a parent sub-account." }, "predefined": { "type": "boolean", "description": "True when the role is defined by Conga Sign powered by OneSpan and uneditable. False when the role is managed by your account and editable (Role Management permission required for editing a role)." } } }, "AccountRoleWithoutId": { "type": "object", "additionalProperties": false, "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Name", "minLength": 1 }, "enabled": { "type": "boolean", "description": "Enabled" }, "description": { "type": "string", "description": "Descriptions" }, "permissions": { "type": "array", "description": "[Permissions]", "items": { "type": "string" } } } }, "UserAccountRole": { "type": "object", "description": "Object to manage user account roles", "additionalProperties": false, "required": [ "accountId", "accountRoles" ], "properties": { "userId": { "type": "string", "description": "The unique user id." }, "accountId": { "type": "string", "description": "The user's unique account id.", "minLength": 1 }, "accountRoles": { "type": "array", "description": "The user's account roles.", "items": { "$ref": "#/components/schemas/AccountRole" } } } }, "ResultOfSigningLogo": { "type": "object", "description": "Object used to manage OneSpan list types", "additionalProperties": false, "properties": { "count": { "type": "integer", "description": "Count", "format": "int32" }, "results": { "type": "array", "description": "Results", "items": { "$ref": "#/components/schemas/SigningLogo" } } } }, "SigningLogo": { "type": "object", "description": "Object to manage a signing logo", "additionalProperties": false, "properties": { "language": { "type": "string", "description": "Available options: en, fr, it, ru, es, pt, de, nl, da, el, zh-CN, zh-TW, ja, ko" }, "image": { "type": "string", "description": "Image" } } }, "SigningThemeConfig": { "type": "object", "description": "Signing theme configuration of colors to customize the signing experience.", "additionalProperties": { "$ref": "#/components/schemas/SigningTheme" } }, "SigningTheme": { "type": "object", "description": "Object to manage signing themes", "additionalProperties": false, "properties": { "color": { "description": "Color", "oneOf": [ { "$ref": "#/components/schemas/SigningColor" } ] } } }, "SigningColor": { "type": "object", "additionalProperties": {} }, "SigningUiOptions": { "type": "object", "description": "Signing interface options for involved signing parties.", "additionalProperties": false, "properties": { "completeSummaryOptions": { "description": "List of available Complete Summary options for signing interface.", "oneOf": [ { "$ref": "#/components/schemas/CompleteSummaryOptions" } ] }, "inpersonWelcomeOptions": { "description": "List of available In-person Welcome options for signing interface.", "oneOf": [ { "$ref": "#/components/schemas/InpersonWelcomeOptions" } ] }, "inpersonHostThankYouOptions": { "description": "List of available In-person Host Thank You options for signing interface.", "oneOf": [ { "$ref": "#/components/schemas/InpersonHostThankYouOptions" } ] }, "notaryWelcomeOptions": { "description": "List of available Notary Welcome options for signing interface.", "oneOf": [ { "$ref": "#/components/schemas/NotaryWelcomeOptions" } ] }, "notaryHostThankYouOptions": { "description": "List of available Notary Host Thank you options for signing interface.", "oneOf": [ { "$ref": "#/components/schemas/NotaryHostThankYouOptions" } ] }, "overviewOptions": { "description": "List of available Overview options for signing interface.", "oneOf": [ { "$ref": "#/components/schemas/OverviewOptions" } ] } } }, "CompleteSummaryOptions": { "type": "object", "description": "List of available Complete Summary options for a given interface.", "additionalProperties": false, "properties": { "title": { "type": "boolean", "description": "Check for Title option." }, "message": { "type": "boolean", "description": "Check for Message option." }, "download": { "type": "boolean", "description": "Check for Download option." }, "review": { "type": "boolean", "description": "Check for Review option." }, "continue": { "type": "boolean", "description": "Check for Continue option." }, "documentSection": { "type": "boolean", "description": "Check for Document Section option." }, "uploadSection": { "type": "boolean", "description": "Check for Upload Section option." } } }, "InpersonWelcomeOptions": { "type": "object", "description": "List of available In-Person Welcome options available for a given interface.", "additionalProperties": false, "properties": { "title": { "type": "boolean", "description": "Check for Title option." }, "body": { "type": "boolean", "description": "Check for a Body option." }, "recipientName": { "type": "boolean", "description": "Check for a Recipient Name option." }, "recipientEmail": { "type": "boolean", "description": "Check for Recipient Email option." }, "recipientActionRequired": { "type": "boolean", "description": "Check for Recipient Action Requried option." }, "recipientRole": { "type": "boolean", "description": "Check for Recipient Role option." }, "recipientStatus": { "type": "boolean", "description": "Check for Recipient Status option." } } }, "InpersonHostThankYouOptions": { "type": "object", "description": "List of available In-Person Host Thank You options for a given interface.", "additionalProperties": false, "properties": { "title": { "type": "boolean", "description": "Check for Title option." }, "body": { "type": "boolean", "description": "Check for Body option." }, "recipientName": { "type": "boolean", "description": "Check for Recipient Name option." }, "recipientEmail": { "type": "boolean", "description": "Check for Recipient Email option." }, "recipientRole": { "type": "boolean", "description": "Check for Recipient Role option." }, "recipientStatus": { "type": "boolean", "description": "Check for Recipient Status option." }, "downloadButton": { "type": "boolean", "description": "Check for Download Button option." }, "reviewDocumentsButton": { "type": "boolean", "description": "Check for Review Documents Button option." } } }, "NotaryWelcomeOptions": { "type": "object", "description": "List of Notary Welcome Options available for a given interface.", "additionalProperties": false, "properties": { "title": { "type": "boolean", "description": "Check for Title option." }, "body": { "type": "boolean", "description": "Check for Body option." }, "recipientName": { "type": "boolean", "description": "Check for Recipient Name option." }, "recipientEmail": { "type": "boolean", "description": "Check for Recipient Email option." }, "recipientActionRequired": { "type": "boolean", "description": "Check for Recipient Action Required option." }, "notaryTag": { "type": "boolean", "description": "Check for Notary Tag option." }, "recipientRole": { "type": "boolean", "description": "Check for Recipient Role option." }, "recipientStatus": { "type": "boolean", "description": "Check for Recipient Status option." } } }, "NotaryHostThankYouOptions": { "type": "object", "description": "List of available Notary Host Thank You options for a given interface.", "additionalProperties": false, "properties": { "title": { "type": "boolean", "description": "Check for Title option." }, "body": { "type": "boolean", "description": "Check for Body option." }, "recipientName": { "type": "boolean", "description": "Check for Recipient name option.\n " }, "recipientEmail": { "type": "boolean", "description": "Check for Recipient Email option." }, "recipientRole": { "type": "boolean", "description": "Check for Recipient Role option." }, "notaryTag": { "type": "boolean", "description": "Check for Notary Tag option." }, "recipientStatus": { "type": "boolean", "description": "Check for Recipient Status option." }, "downloadButton": { "type": "boolean", "description": "Check for Download Button option." }, "reviewDocumentsButton": { "type": "boolean", "description": "Check for Review Documents Button option." } } }, "OverviewOptions": { "type": "object", "description": "List of available Overview options for a given interface.", "additionalProperties": false, "properties": { "title": { "type": "boolean", "description": "Check for Title option." }, "body": { "type": "boolean", "description": "Check for Body option." }, "documentSection": { "type": "boolean", "description": "Check for Document Section option." }, "uploadSection": { "type": "boolean", "description": "Check for Upload Section option." } } }, "Approval": { "type": "object", "description": "Signing Approval object.", "additionalProperties": false, "properties": { "accepted": { "type": "string", "description": "Date of approval acceptance.", "format": "date-time", "nullable": true }, "data": { "type": "object", "description": "Additional approval ata properties.", "additionalProperties": {} }, "fields": { "type": "array", "description": "Approval Signature/Input fields.", "items": { "$ref": "#/components/schemas/Field" } }, "id": { "type": "string", "description": "The unique approval Id." }, "name": { "type": "string", "description": "The unique approval name." }, "role": { "type": "string", "description": "The approval role name." }, "signed": { "type": "string", "description": "The approval signed date.", "format": "date-time", "nullable": true }, "optional": { "type": "boolean", "description": "Check if for optional information." }, "enforceCaptureSignature": { "type": "boolean", "description": "Check if required on Capture Signature" } } }, "Field": { "type": "object", "description": "Approval fields object.", "additionalProperties": false, "properties": { "binding": { "type": "string", "description": "Binding" }, "data": { "type": "object", "description": "Custom data for the field", "additionalProperties": {} }, "extract": { "type": "boolean", "description": "Determines if field is to be extracted" }, "extractAnchor": { "description": "Field extraction anchor.", "oneOf": [ { "$ref": "#/components/schemas/ExtractAnchor" } ] }, "height": { "type": "number", "description": "Field height.", "format": "double" }, "id": { "type": "string", "description": "Field Id." }, "left": { "type": "number", "description": "X coordinate of the field", "format": "double" }, "name": { "type": "string", "description": "Field name." }, "page": { "type": "integer", "description": "The document page where the field is located", "format": "int32" }, "subtype": { "type": "string", "description": "Field subtype" }, "top": { "type": "number", "description": "Y coordinate of the field", "format": "double" }, "type": { "description": "Field type.", "oneOf": [ { "$ref": "#/components/schemas/FieldType" } ] }, "validation": { "description": "Field validation information", "oneOf": [ { "$ref": "#/components/schemas/FieldValidation" } ] }, "value": { "type": "string", "description": "The field value" }, "fontSize": { "type": "integer", "description": "Field font size.", "format": "int32", "nullable": true }, "width": { "type": "number", "description": "Field width.", "format": "double" } } }, "ExtractAnchor": { "type": "object", "description": "Text extraction anchor object.", "additionalProperties": false, "properties": { "anchorPoint": { "description": "Which corner of the specified character to use as the base for calculating position", "oneOf": [ { "$ref": "#/components/schemas/AnchorPointType" } ] }, "characterIndex": { "type": "integer", "description": "The index of the character within the Anchor Text that will be used to calculate position", "format": "int32" }, "height": { "type": "integer", "description": "The height of the field position to be calculated", "format": "int32" }, "index": { "type": "integer", "description": "The \"occurrence\" of the string. For example, if index = 2, the software will skip the first two occurrences of Anchor Text, and use the third occurrence to calculate position.", "format": "int32" }, "leftOffset": { "type": "integer", "description": "An absolute offset applied to the final x value", "format": "int32" }, "text": { "type": "string", "description": "The exact string that will be searched for in the uploaded document" }, "topOffset": { "type": "integer", "description": "An absolute offset applied to the final y value", "format": "int32" }, "width": { "type": "integer", "description": "The width of the field position to be calculated", "format": "int32" } } }, "AnchorPointType": { "type": "string", "description": "", "x-enumNames": [ "TOPLEFT", "BOTTOMLEFT", "TOPRIGHT", "BOTTOMRIGHT" ], "enum": [ "TOPLEFT", "BOTTOMLEFT", "TOPRIGHT", "BOTTOMRIGHT" ] }, "FieldType": { "type": "string", "description": "", "x-enumNames": [ "SIGNATURE", "INPUT", "IMAGE" ], "enum": [ "SIGNATURE", "INPUT", "IMAGE" ] }, "FieldValidation": { "type": "object", "description": "Field validation object", "additionalProperties": false, "properties": { "enum": { "type": "array", "items": { "type": "string" } }, "errorCode": { "type": "integer", "description": "Field validation error code.", "format": "int32", "nullable": true }, "errorMessage": { "type": "string", "description": "Field validation error message.\n " }, "maxLength": { "type": "integer", "description": "Field validation maximum length.", "format": "int32", "nullable": true }, "minLength": { "type": "integer", "description": "Field validation minimum length.", "format": "int32", "nullable": true }, "pattern": { "type": "string", "description": "Pattern" }, "required": { "type": "boolean", "description": "Determines if field is required" }, "group": { "type": "string", "description": "Field validation group." }, "minimumRequired": { "type": "integer", "description": "Minimum Required (Grouped Checkboxes)", "format": "int32", "nullable": true } } }, "ResultOfApproval": { "type": "object", "description": "Object used to manage OneSpan list types", "additionalProperties": false, "properties": { "count": { "type": "integer", "description": "Count", "format": "int32" }, "results": { "type": "array", "description": "Results", "items": { "$ref": "#/components/schemas/Approval" } } } }, "SenderAuthenticationToken": { "type": "object", "description": "Object to manage sender auth token", "additionalProperties": false, "properties": { "packageId": { "type": "string", "description": "Package id" }, "value": { "type": "string", "description": "Auth token value" } } }, "SignerAuthenticationToken": { "type": "object", "description": "Object to manage a signer authentication token", "additionalProperties": false, "properties": { "packageId": { "type": "string", "description": "Package id" }, "signerId": { "type": "string", "description": "Signer id" }, "sessionFields": { "type": "object", "description": "Session fields", "additionalProperties": { "type": "string" } }, "value": { "type": "string", "description": "The authentication token" } } }, "UserAuthenticationToken": { "type": "object", "description": "Object to manage a user authentication token", "additionalProperties": false, "properties": { "email": { "type": "string", "description": "Email" } } }, "ProblemDetails": { "type": "object", "additionalProperties": { "nullable": true }, "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } } }, "CustomerRegistrationResponse": { "type": "object", "additionalProperties": false, "properties": { "congaOrgId": { "type": "string", "description": "CongaOrgId" }, "clientId": { "type": "string", "description": "Client Id" }, "clientSecret": { "type": "string", "description": "Client Secret" } } }, "CustomerRegistrationRequest": { "type": "object", "additionalProperties": false, "properties": { "congaOrgId": { "type": "string", "description": "CongaOrgId" }, "clientId": { "type": "string", "description": "Client Id" }, "clientSecret": { "type": "string", "description": "Client Secret" } } }, "CustomField": { "type": "object", "description": "A custom field is one that, at the time of signing, is automatically populated with data that is specific\nto the signer. For instance, a signer might have an Agent Number, and that number may need to appear in the\nfinal document next to their signature. By using a custom field, the signer can specify their Agent Number,\nand that number will automatically appear in any other field that has been configured to receive it.\n \nMore info: https://community.onespan.com/documentation/onespan-sign/guides/admin-guides/user/custom-fields", "additionalProperties": false, "properties": { "data": { "type": "object", "description": "Custom field metadata.", "additionalProperties": {} }, "id": { "type": "string", "description": "The unique of id of the field" }, "name": { "type": "string", "description": "Custom field name." }, "required": { "type": "boolean", "description": "Flag that indicates if the custom field will be required for users when setting up their account profiles." }, "translations": { "type": "array", "description": "Custom field localization.", "items": { "$ref": "#/components/schemas/Translation" } }, "value": { "type": "string", "description": "Custom field default value." } } }, "Translation": { "type": "object", "description": "Field localization.", "additionalProperties": false, "properties": { "data": { "type": "object", "description": "Localization metadata.", "additionalProperties": {} }, "description": { "type": "string", "description": "Optionally provide a description of the selected language." }, "id": { "type": "string", "description": "Localization Id." }, "language": { "type": "string", "description": "Available options: en, fr, it, ru, es, pt, de, nl, da, el, zh-CN, zh-TW, ja, ko" }, "name": { "type": "string", "description": "Specify a Field Name for the selected language. This is a required field. This is the name of the field\nas your users see it in their account profiles and on transactions in which they participate." } } }, "DataManagementPolicy": { "type": "object", "description": "Object to manage transaction retention", "additionalProperties": false, "properties": { "transactionRetention": { "description": "Transaction retention", "oneOf": [ { "$ref": "#/components/schemas/TransactionRetention" } ] } } }, "TransactionRetention": { "type": "object", "description": "Object to manage number of days to retain transactions", "additionalProperties": false, "properties": { "draft": { "type": "integer", "description": "Number of days to keep drafts for", "format": "int32", "nullable": true }, "sent": { "type": "integer", "description": "Number of days to keep sent transactions for", "format": "int32", "nullable": true }, "completed": { "type": "integer", "description": "Number of days to keep completed transactions for", "format": "int32", "nullable": true }, "archived": { "type": "integer", "description": "Number of days to keep archived transactions for", "format": "int32", "nullable": true }, "declined": { "type": "integer", "description": "Number of days to keep declined transactions for", "format": "int32", "nullable": true }, "optedOut": { "type": "integer", "description": "Number of days to keep opted-out transactions for", "format": "int32", "nullable": true }, "expired": { "type": "integer", "description": "Number of days to keep expired transactions for", "format": "int32", "nullable": true } } }, "ExpiryTimeConfiguration": { "type": "object", "description": "Transaction expiry configuration", "additionalProperties": false, "properties": { "maximumRemainingDays": { "type": "integer", "description": "Maximum allowed value for expiry time for transactions in days", "format": "int32", "nullable": true }, "remainingDays": { "type": "integer", "description": "Default expiry time for transactions in days", "format": "int32", "nullable": true } } }, "Document": { "type": "object", "additionalProperties": false, "properties": { "status": { "type": "string", "description": "Status of the document" }, "approvals": { "type": "array", "description": "List of approvals for the document", "items": { "$ref": "#/components/schemas/Approval" } }, "data": { "type": "object", "description": "Custom data for the document", "additionalProperties": {} }, "description": { "type": "string", "description": "Document description" }, "external": { "description": "External integration provider settings", "oneOf": [ { "$ref": "#/components/schemas/External" } ] }, "extract": { "type": "boolean", "nullable": true }, "tagged": { "type": "boolean", "description": "Tagged", "nullable": true }, "extractionTypes": { "type": "array", "description": "ExtractionTypes", "items": { "type": "string" } }, "fields": { "type": "array", "description": "List of fields in the document", "items": { "$ref": "#/components/schemas/Field" } }, "id": { "type": "string", "description": "Unique id of the document" }, "index": { "type": "integer", "description": "Index of the document within the package", "format": "int32", "nullable": true }, "name": { "type": "string", "description": "The document name" }, "pages": { "type": "array", "description": "List of page objects within the document", "items": { "$ref": "#/components/schemas/Page" } }, "size": { "type": "integer", "description": "The size of the document in bytes", "format": "int32", "nullable": true }, "signedHash": { "type": "string", "description": "Signed hash" }, "signerVerificationToken": { "type": "string", "description": "SignerVerificationToken\n " } } }, "External": { "type": "object", "description": "External integration provider settings.", "additionalProperties": false, "properties": { "data": { "type": "object", "description": "Provider metadata.", "additionalProperties": {} }, "id": { "type": "string", "description": "External integration Id." }, "provider": { "type": "string", "description": "Provider method." }, "providerName": { "type": "string", "description": "Provider name." } } }, "Page": { "type": "object", "description": "Object representing a page in a document", "additionalProperties": false, "properties": { "height": { "type": "number", "description": "Page height", "format": "double", "nullable": true }, "id": { "type": "string", "description": "Unique page id" }, "index": { "type": "integer", "description": "Index of the page within the document", "format": "int32", "nullable": true }, "left": { "type": "number", "description": "Page left", "format": "double", "nullable": true }, "top": { "type": "number", "description": "Page top", "format": "double", "nullable": true }, "version": { "type": "integer", "description": "Version", "format": "int32", "nullable": true }, "width": { "type": "number", "description": "Page width", "format": "double", "nullable": true } } }, "DocumentVisibilityConfiguration": { "type": "object", "description": "Object to manage document visibility", "additionalProperties": false, "properties": { "documentUid": { "type": "string", "description": "Document Id" }, "roleUids": { "type": "array", "description": "List of Role Ids that can view the identified Document", "items": { "type": "string" } } } }, "SignedDocument": { "allOf": [ { "$ref": "#/components/schemas/Document" }, { "type": "object", "additionalProperties": false, "properties": { "status": { "type": "string", "description": "The status of the document" }, "fields": { "type": "array", "description": "The fields in the document", "items": { "$ref": "#/components/schemas/Field" } }, "name": { "type": "string", "description": "The document name" }, "size": { "type": "integer", "description": "The size of the document in bytes", "format": "int32" }, "description": { "type": "string", "description": "Document description" }, "index": { "type": "integer", "description": "Index", "format": "int32" }, "id": { "type": "string", "description": "Id" }, "data": { "type": "object", "description": "Custom meta data", "additionalProperties": {} }, "signedHash": { "type": "string", "description": "SignedHash" }, "extract": { "type": "boolean", "nullable": true }, "extractionTypes": { "type": "array", "description": "ExtractionTypes", "items": { "type": "string" } }, "tagged": { "type": "boolean", "description": "Tagged", "nullable": true }, "external": { "description": "External", "oneOf": [ { "$ref": "#/components/schemas/External" } ] }, "approvals": { "type": "array", "description": "Approvals", "items": { "$ref": "#/components/schemas/Approval" } }, "signerVerificationToken": { "type": "string", "description": "SignerVerificationToken" }, "pages": { "type": "array", "description": "Pages", "items": { "$ref": "#/components/schemas/Page" } }, "handdrawn": { "type": "string", "description": "Hand drawn signature string (base64)" } } } ] }, "SignedDocuments": { "type": "object", "description": "Object to manage signing documents via api", "additionalProperties": false, "properties": { "documents": { "type": "array", "description": "List of documents", "items": { "$ref": "#/components/schemas/Document" } }, "handdrawn": { "type": "string", "description": "Hand drawn signature string" } } }, "DocumentVisibility": { "type": "object", "description": "Object to manage document visibility", "additionalProperties": false, "properties": { "configurations": { "type": "array", "description": "List of DocumentVisibilityConfigurations", "items": { "$ref": "#/components/schemas/DocumentVisibilityConfiguration" } }, "id": { "type": "string", "description": "The id of the document" }, "data": { "type": "object", "description": "Custom data related to document", "additionalProperties": {} }, "name": { "type": "string", "description": "The name of the document" } } }, "AttachmentAvailability": { "type": "object", "additionalProperties": false, "properties": { "exists": { "type": "boolean" } } }, "ResultOfGroup": { "type": "object", "description": "Object used to manage OneSpan list types", "additionalProperties": false, "properties": { "count": { "type": "integer", "description": "Count", "format": "int32" }, "results": { "type": "array", "description": "Results", "items": { "$ref": "#/components/schemas/Group" } } } }, "Group": { "type": "object", "description": "Object to manage a group", "additionalProperties": false, "properties": { "account": { "description": "The account the group belongs to", "oneOf": [ { "$ref": "#/components/schemas/Account" } ] }, "created": { "type": "string", "description": "Created date", "format": "date-time", "nullable": true }, "data": { "type": "object", "description": "Custom data", "additionalProperties": {} }, "email": { "type": "string", "description": "Email address" }, "emailMembers": { "type": "boolean", "description": "EmailMembers" }, "id": { "type": "string", "description": "Unique id of the group" }, "members": { "type": "array", "description": "List of group members", "items": { "$ref": "#/components/schemas/GroupMember" } }, "name": { "type": "string", "description": "Name of the group" }, "updated": { "type": "string", "description": "Updated date", "format": "date-time", "nullable": true }, "reciprocalDelegation": { "type": "boolean", "description": "Reciprocal Delegation" } } }, "Account": { "type": "object", "description": "Account information.", "additionalProperties": false, "properties": { "company": { "description": "Company information.", "oneOf": [ { "$ref": "#/components/schemas/Company" } ] }, "created": { "type": "string", "description": "Account creation date.", "format": "date-time", "nullable": true }, "customFields": { "type": "array", "description": "Account custom fields.", "items": { "$ref": "#/components/schemas/CustomField" } }, "data": { "type": "object", "description": "Account metadata.", "additionalProperties": {} }, "id": { "type": "string", "description": "Account Id." }, "licenses": { "type": "array", "description": "Account license information.", "items": { "$ref": "#/components/schemas/License" } }, "logoUrl": { "type": "string", "description": "Account Logo URL." }, "name": { "type": "string", "description": "Account name." }, "owner": { "type": "string", "description": "Unique Owner Id." }, "providers": { "description": "External document sources.", "oneOf": [ { "$ref": "#/components/schemas/AccountProviders" } ] }, "updated": { "type": "string", "description": "Account update date.", "format": "date-time", "nullable": true } } }, "Company": { "type": "object", "description": "Company information.", "additionalProperties": false, "properties": { "address": { "description": "Company address.", "oneOf": [ { "$ref": "#/components/schemas/Address" } ] }, "data": { "type": "object", "description": "Company metadata.", "additionalProperties": {} }, "id": { "type": "string", "description": "Unique company Id." }, "name": { "type": "string", "description": "Company name." } } }, "Address": { "type": "object", "additionalProperties": false, "properties": { "address1": { "type": "string", "description": "Address1" }, "address2": { "type": "string", "description": "Address2" }, "city": { "type": "string", "description": "City" }, "country": { "type": "string", "description": "Country" }, "state": { "type": "string", "description": "State" }, "zipcode": { "type": "string", "description": "Zipcode" } } }, "License": { "type": "object", "description": "License information.", "additionalProperties": false, "properties": { "created": { "type": "string", "description": "License creation date.", "format": "date-time", "nullable": true }, "paidUntil": { "type": "string", "description": "Paid license expiration.", "format": "date-time", "nullable": true }, "plan": { "description": "License plan.", "oneOf": [ { "$ref": "#/components/schemas/Plan" } ] }, "status": { "description": "License status.", "oneOf": [ { "$ref": "#/components/schemas/LicenseStatus" } ] }, "transactions": { "type": "array", "description": "Transactions associated with this license", "items": { "$ref": "#/components/schemas/Transaction" } } } }, "Plan": { "type": "object", "additionalProperties": false, "properties": { "contract": { "type": "string" }, "cycle": { "$ref": "#/components/schemas/Cycle" }, "data": { "type": "object", "additionalProperties": {} }, "description": { "type": "string" }, "features": { "type": "object", "additionalProperties": {} }, "freeCycles": { "$ref": "#/components/schemas/CycleCount" }, "group": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "original": { "type": "string" }, "price": { "$ref": "#/components/schemas/Price" }, "quotas": { "type": "array", "items": { "$ref": "#/components/schemas/Quota" } } } }, "Cycle": { "type": "string", "description": "", "x-enumNames": [ "DAY", "MONTH", "YEAR" ], "enum": [ "DAY", "MONTH", "YEAR" ] }, "CycleCount": { "type": "object", "additionalProperties": false, "properties": { "count": { "type": "integer", "format": "int32" }, "cycle": { "$ref": "#/components/schemas/CycleCount" } } }, "Price": { "type": "object", "description": "Object to manage price", "additionalProperties": false, "properties": { "amount": { "type": "integer", "description": "Amount", "format": "int32" }, "currency": { "description": "Currency", "oneOf": [ { "$ref": "#/components/schemas/Currency" } ] } } }, "Currency": { "type": "object", "description": "The currency used for the Price object", "additionalProperties": false, "properties": { "data": { "type": "object", "description": "Data", "additionalProperties": {} }, "id": { "type": "string", "description": "Id" }, "name": { "type": "string", "description": "Name" } } }, "Quota": { "type": "object", "additionalProperties": false, "properties": { "cycle": { "type": "string" }, "limit": { "type": "integer", "format": "int32" }, "scope": { "type": "string" }, "target": { "$ref": "#/components/schemas/Target" } } }, "Target": { "type": "string", "description": "", "x-enumNames": [ "SIGNER", "SENDER", "DOCUMENT", "PACKAGE", "STORAGE" ], "enum": [ "SIGNER", "SENDER", "DOCUMENT", "PACKAGE", "STORAGE" ] }, "LicenseStatus": { "type": "string", "description": "", "x-enumNames": [ "ACTIVE", "PENDING", "GRACE" ], "enum": [ "ACTIVE", "PENDING", "GRACE" ] }, "Transaction": { "type": "object", "additionalProperties": false, "properties": { "created": { "type": "string", "format": "date-time", "nullable": true }, "creditCard": { "$ref": "#/components/schemas/CreditCard" }, "price": { "$ref": "#/components/schemas/Price" } } }, "CreditCard": { "type": "object", "additionalProperties": false, "properties": { "cvv": { "type": "string" }, "expiration": { "$ref": "#/components/schemas/CcExpiration" }, "name": { "type": "string" }, "number": { "type": "string" }, "type": { "type": "string" } } }, "CcExpiration": { "type": "object", "additionalProperties": false, "properties": { "month": { "type": "integer", "format": "int32" }, "year": { "type": "integer", "format": "int32" } } }, "AccountProviders": { "type": "object", "additionalProperties": false, "properties": { "documents": { "type": "array", "description": "List of external sources for documents", "items": { "$ref": "#/components/schemas/Provider" } }, "users": { "type": "array", "description": "List of external sources for users", "items": { "$ref": "#/components/schemas/Provider" } } } }, "Provider": { "type": "object", "description": "Object to manage account providers for documents and users", "additionalProperties": false, "properties": { "data": { "type": "object", "description": "Custom meta data", "additionalProperties": {} }, "id": { "type": "string", "description": "Id" }, "name": { "type": "string", "description": "Name" }, "provides": { "type": "string", "description": "Provides" } } }, "GroupMember": { "type": "object", "description": "Object to manage a group member", "additionalProperties": false, "properties": { "email": { "type": "string", "description": "Email string" }, "firstName": { "type": "string", "description": "First name" }, "lastName": { "type": "string", "description": "Last name" }, "memberType": { "description": "MemberType", "oneOf": [ { "$ref": "#/components/schemas/MemberType" } ] }, "pending": { "type": "boolean", "description": "Pending", "nullable": true }, "userId": { "type": "string", "description": "UserId" } } }, "MemberType": { "type": "string", "description": "", "x-enumNames": [ "REGULAR", "MANAGER" ], "enum": [ "REGULAR", "MANAGER" ] }, "User": { "type": "object", "description": "User information.", "additionalProperties": false, "properties": { "address": { "description": "User address.", "oneOf": [ { "$ref": "#/components/schemas/Address" } ] }, "company": { "type": "string", "description": "User company." }, "created": { "type": "string", "description": "User creation date.", "format": "date-time", "nullable": true }, "data": { "type": "object", "description": "User metadata.", "additionalProperties": {} }, "email": { "type": "string", "description": "User email." }, "external": { "description": "External provider information.", "oneOf": [ { "$ref": "#/components/schemas/External" } ] }, "firstName": { "type": "string", "description": "User first name." }, "id": { "type": "string", "description": "Unique user Id." }, "language": { "type": "string", "description": "Available options: en, fr, it, ru, es, pt, de, nl, da, el, zh-CN, zh-TW, ja, ko" }, "lastName": { "type": "string", "description": "User last name." }, "name": { "type": "string", "description": "User name." }, "phone": { "type": "string", "description": "User phone number." }, "professionalIdentityFields": { "type": "array", "description": "ProfessionalIdentityFields", "items": { "$ref": "#/components/schemas/ProfessionalIdentityField" } }, "signature": { "description": "User signature information.", "oneOf": [ { "$ref": "#/components/schemas/SignatureStyle" } ] }, "specialTypes": { "type": "array", "description": "Special User Types. Currently only NOTARY is supported.", "items": { "type": "string" } }, "title": { "type": "string", "description": "User title." }, "updated": { "type": "string", "description": "User information updated date.", "format": "date-time", "nullable": true }, "timezoneId": { "type": "string", "description": "User timezone Id." }, "userCustomFields": { "type": "array", "description": "User custom fields.", "items": { "$ref": "#/components/schemas/UserCustomField" } } } }, "ProfessionalIdentityField": { "type": "object", "description": "Object to manage professional identity field", "additionalProperties": false, "properties": { "category": { "type": "string", "description": "Category" }, "data": { "type": "object", "description": "Custom data", "additionalProperties": {} }, "id": { "type": "string", "description": "Id" }, "name": { "type": "string", "description": "Name" }, "translations": { "type": "array", "description": "List of translations", "items": { "$ref": "#/components/schemas/Translation" } }, "type": { "type": "string", "description": "Type" }, "value": { "type": "string", "description": "Value" } } }, "SignatureStyle": { "type": "object", "additionalProperties": false, "properties": { "handdrawn": { "type": "string", "description": "Hand drawn signature image (base 64 encoding)." }, "textual": { "description": "Textual signature style", "oneOf": [ { "$ref": "#/components/schemas/TextualSignatureStyle" } ] } } }, "TextualSignatureStyle": { "type": "object", "description": "Object to manage a text signature", "additionalProperties": false, "properties": { "color": { "type": "string", "description": "Signature color." }, "font": { "type": "string", "description": "Signature font." } } }, "UserCustomField": { "type": "object", "description": "Object to manage a user custom field", "additionalProperties": false, "properties": { "data": { "type": "object", "description": "Custom data", "additionalProperties": {} }, "id": { "type": "string", "description": "Id" }, "name": { "type": "string", "description": "Name" }, "translations": { "type": "array", "description": "List of translations", "items": { "$ref": "#/components/schemas/Translation" } }, "value": { "type": "string", "description": "Value" } } }, "IdvWorkflowConfiguration": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "description": "The unique Id of the Id verification workflow configuration." }, "type": { "type": "string", "description": "The Id verification workflow type." }, "tenant": { "type": "string", "description": "The customer alias." }, "desc": { "type": "string", "description": "Id verification workflow description." }, "skipWhenAccessingSignedDocuments": { "type": "boolean", "description": "To skip the identity verification workflow for accessing signed documents." } } }, "ReportData": { "type": "object", "description": "Report data, including modification date, size, uri, and type of content.", "additionalProperties": false, "properties": { "lastModified": { "type": "string", "description": "Date of last modification for report.", "format": "date-time", "nullable": true }, "size": { "type": "integer", "description": "Report size (in bytes).", "format": "int32" }, "uri": { "type": "string", "description": "The report URI." }, "contentType": { "type": "string", "description": "The report content type." } } }, "ResultOfPackage": { "type": "object", "description": "Object used to manage OneSpan list types", "additionalProperties": false, "properties": { "count": { "type": "integer", "description": "Count", "format": "int32" }, "results": { "type": "array", "description": "Results", "items": { "$ref": "#/components/schemas/Package" } } } }, "Package": { "type": "object", "description": "Object to manage a package", "additionalProperties": false, "properties": { "autocomplete": { "type": "boolean", "description": "Determines if \"Review Before Completion\" is enabled" }, "completed": { "type": "string", "description": "The date the transaction was completed", "format": "date-time", "nullable": true }, "consent": { "type": "string", "description": "Consent" }, "data": { "type": "object", "description": "Custom meta data", "additionalProperties": {} }, "description": { "type": "string", "description": "Package description" }, "documents": { "type": "array", "description": "List of package documents", "items": { "$ref": "#/components/schemas/Document" } }, "due": { "type": "string", "description": "The date the package will expire", "format": "date-time", "nullable": true }, "emailMessage": { "type": "string", "description": "Message to be included emails to signers" }, "id": { "type": "string", "description": "Unique package Id" }, "language": { "type": "string", "description": "Available options: en, fr, it, ru, es, pt, de, nl, da, el, zh-CN, zh-TW, ja, ko" }, "limits": { "description": "Limits", "oneOf": [ { "$ref": "#/components/schemas/PackageArtifactsLimits" } ] }, "messages": { "type": "array", "description": "Messages", "items": { "$ref": "#/components/schemas/Message" } }, "name": { "type": "string", "description": "Package name" }, "notarized": { "type": "boolean", "description": "Notarized" }, "notaryRoleId": { "type": "string", "description": "NotaryRoleId" }, "roles": { "type": "array", "description": "List of roles in the package", "items": { "$ref": "#/components/schemas/Role" } }, "conditions": { "type": "array", "description": "List of field conditions for the package", "items": { "$ref": "#/components/schemas/FieldCondition" } }, "sender": { "description": "The package sender", "oneOf": [ { "$ref": "#/components/schemas/Sender" } ] }, "settings": { "description": "Package settings", "oneOf": [ { "$ref": "#/components/schemas/PackageSettings" } ] }, "signedDocumentDelivery": { "description": "SignedDocumentDelivery", "oneOf": [ { "$ref": "#/components/schemas/SignedDocumentDelivery" } ] }, "status": { "description": "Package status", "oneOf": [ { "$ref": "#/components/schemas/PackageStatus" } ] }, "trashed": { "type": "boolean", "description": "Determines if package has been deleted" }, "type": { "description": "Type", "oneOf": [ { "$ref": "#/components/schemas/BasePackageType" } ] }, "updated": { "type": "string", "description": "The date the package was last updated", "format": "date-time", "nullable": true }, "visibility": { "description": "Determines package visibility", "oneOf": [ { "$ref": "#/components/schemas/Visibility" } ] }, "timezoneId": { "type": "string", "description": "The timezone id specified for the package" }, "created": { "type": "string", "description": "The date the package was created", "format": "date-time", "nullable": true }, "virtualRoom": { "type": "boolean", "description": "Determines if a virtual room has been created for the package signing", "nullable": true } } }, "PackageArtifactsLimits": { "type": "object", "description": " ", "additionalProperties": false, "properties": { "documents": { "type": "integer", "description": "Documents", "format": "int32" }, "roles": { "type": "integer", "description": "Roles", "format": "int32" } } }, "Message": { "type": "object", "description": " ", "additionalProperties": false, "properties": { "content": { "type": "string", "description": "The content of the message" }, "created": { "type": "string", "description": "The date the message was created", "format": "date-time", "nullable": true }, "documents": { "type": "array", "description": "The list of documents associated with the message", "items": { "$ref": "#/components/schemas/Document" } }, "from": { "description": "The user that created the message", "oneOf": [ { "$ref": "#/components/schemas/User" } ] }, "status": { "description": "The message status", "oneOf": [ { "$ref": "#/components/schemas/MessageStatus" } ] }, "to": { "type": "array", "description": "The users that should receive the message", "items": { "$ref": "#/components/schemas/User" } } } }, "MessageStatus": { "type": "string", "description": "", "x-enumNames": [ "NEW", "READ", "TRASHED" ], "enum": [ "NEW", "READ", "TRASHED" ] }, "Role": { "type": "object", "additionalProperties": false, "properties": { "attachmentRequirements": { "type": "array", "description": "Signer attachment requirements.", "items": { "$ref": "#/components/schemas/AttachmentRequirement" } }, "data": { "type": "object", "description": "Role metadata.", "additionalProperties": {} }, "emailMessage": { "description": "Role email message.", "oneOf": [ { "$ref": "#/components/schemas/BaseMessage" } ] }, "id": { "type": "string", "description": "Role Id." }, "index": { "type": "integer", "description": "Role signing order index.", "format": "int32" }, "locked": { "type": "boolean", "description": "Is role locked. Role will be locked after failing to sign in multiple times." }, "name": { "type": "string", "description": "Role name." }, "reassign": { "type": "boolean", "description": "Is the role able to reassign." }, "signers": { "type": "array", "description": "Signers associated with the role.", "items": { "$ref": "#/components/schemas/Signer" } }, "specialTypes": { "type": "array", "description": "Special signer features. Currently only NOTARY is supported.", "items": { "type": "string" } }, "type": { "description": "Role type. Currently there are two types, SIGNER and SENDER.", "oneOf": [ { "$ref": "#/components/schemas/RoleType" } ] } } }, "AttachmentRequirement": { "type": "object", "description": "Attachment requirements and settings.", "additionalProperties": false, "properties": { "comment": { "type": "string", "description": "Attachment comment." }, "data": { "type": "object", "description": "Attachment metadata.", "additionalProperties": {} }, "description": { "type": "string", "description": "Attachment description." }, "files": { "type": "array", "description": "Attachment files.", "items": { "$ref": "#/components/schemas/AttachmentFile" } }, "id": { "type": "string", "description": "The attachment Id." }, "name": { "type": "string", "description": "The attachment name." }, "required": { "type": "boolean", "description": "Is attachment required." }, "status": { "description": "Attachment status.", "oneOf": [ { "$ref": "#/components/schemas/RequirementStatus" } ] } } }, "AttachmentFile": { "type": "object", "description": "Attachment file information.", "additionalProperties": false, "properties": { "id": { "type": "integer", "description": "Attachment file Id.", "format": "int32" }, "insertDate": { "type": "integer", "description": "Attachment creation date in epoch format.", "format": "int64" }, "name": { "type": "string", "description": "Attachment file name." }, "preview": { "type": "boolean", "description": "Can see attachment previews." } } }, "RequirementStatus": { "type": "string", "description": "", "x-enumNames": [ "INCOMPLETE", "REJECTED", "COMPLETE" ], "enum": [ "INCOMPLETE", "REJECTED", "COMPLETE" ] }, "BaseMessage": { "type": "object", "additionalProperties": false, "properties": { "content": { "type": "string", "description": "Message text content." } } }, "Signer": { "type": "object", "description": "Object to manage a signer", "additionalProperties": false, "properties": { "address": { "description": "Signer address.", "oneOf": [ { "$ref": "#/components/schemas/Address" } ] }, "auth": { "description": "Auth settings.", "oneOf": [ { "$ref": "#/components/schemas/Auth" } ] }, "company": { "type": "string", "description": "Signer's company name." }, "created": { "type": "string", "description": "Signer creation date.", "format": "date-time", "nullable": true }, "data": { "type": "object", "description": "Signer metadata.", "additionalProperties": {} }, "delivery": { "description": "Signer delivery settings.", "oneOf": [ { "$ref": "#/components/schemas/Delivery" } ] }, "email": { "type": "string", "description": "Signer email." }, "external": { "description": "External provider information.", "oneOf": [ { "$ref": "#/components/schemas/External" } ] }, "firstName": { "type": "string", "description": "Signer's first name." }, "group": { "description": "Signer's group.", "oneOf": [ { "$ref": "#/components/schemas/Group" } ] }, "id": { "type": "string", "description": "Signer Id." }, "knowledgeBasedAuthentication": { "description": "Knowledge base authentication through Equifax.", "oneOf": [ { "$ref": "#/components/schemas/KnowledgeBasedAuthentication" } ] }, "language": { "type": "string", "description": "Available options: en, fr, it, ru, es, pt, de, nl, da, el, zh-CN, zh-TW, ja, ko" }, "lastName": { "type": "string", "description": "Signer's lastname." }, "name": { "type": "string", "description": "Signer's name." }, "phone": { "type": "string", "description": "Signer's phone." }, "professionalIdentityFields": { "type": "array", "description": " ", "items": { "$ref": "#/components/schemas/ProfessionalIdentityField" } }, "signature": { "description": "Signer's signature style.", "oneOf": [ { "$ref": "#/components/schemas/SignatureStyle" } ] }, "signerType": { "description": "Type of signer", "oneOf": [ { "$ref": "#/components/schemas/SignerType" } ] }, "specialTypes": { "type": "array", "description": "Special User Types. Currently only NOTARY is supported.", "items": { "type": "string" } }, "title": { "type": "string", "description": "Signer's title." }, "updated": { "type": "string", "description": "Last time signer was updated.", "format": "date-time", "nullable": true }, "userCustomFields": { "type": "array", "description": "Signer's custom fields.", "items": { "$ref": "#/components/schemas/UserCustomField" } } } }, "Auth": { "type": "object", "description": "Signer auth settings.", "additionalProperties": false, "properties": { "challenges": { "type": "array", "description": "List of auth secret question challenges.", "items": { "$ref": "#/components/schemas/AuthChallenge" } }, "scheme": { "description": "The auth scheme. Can be CHALLENGE, SMS, or NONE", "oneOf": [ { "$ref": "#/components/schemas/AuthScheme" } ] }, "idvWorkflow": { "description": "The Id verification workflow.", "oneOf": [ { "$ref": "#/components/schemas/IdvWorkflow" } ] } } }, "AuthChallenge": { "type": "object", "additionalProperties": false, "properties": { "answer": { "type": "string", "description": "Secret question answer." }, "maskInput": { "type": "boolean", "description": "To hide the user input." }, "question": { "type": "string", "description": "Secret question." } } }, "AuthScheme": { "type": "string", "description": "", "x-enumNames": [ "NONE", "PROVIDER", "CHALLENGE", "SMS", "SSO", "KBA", "SAA" ], "enum": [ "NONE", "PROVIDER", "CHALLENGE", "SMS", "SSO", "KBA", "SAA" ] }, "IdvWorkflow": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "description": "The unique Id of the Id verification workflow configuration." }, "type": { "type": "string", "description": "The Id verification workflow type." }, "tenant": { "type": "string", "description": "The customer alias." }, "desc": { "type": "string", "description": "Id verification workflow description." } } }, "Delivery": { "type": "object", "description": "Object to manage delivery of completed documents", "additionalProperties": false, "properties": { "download": { "type": "boolean", "description": "Is download delivery enabled." }, "email": { "type": "boolean", "description": "Is email delivery enabled." }, "provider": { "type": "boolean", "description": "Is external integration delivery enabled." } } }, "KnowledgeBasedAuthentication": { "type": "object", "description": "Object to manage KBA", "additionalProperties": false, "properties": { "knowledgeBasedAuthenticationStatus": { "description": "The status of the KBA", "oneOf": [ { "$ref": "#/components/schemas/KnowledgeBasedAuthenticationStatus" } ] }, "signerInformationForEquifaxCanada": { "description": "SignerInformationForEquifaxCanada", "oneOf": [ { "$ref": "#/components/schemas/SignerInformationForEquifaxCanada" } ] }, "signerInformationForEquifaxUSA": { "description": "SignerInformationForEquifaxUSA", "oneOf": [ { "$ref": "#/components/schemas/SignerInformationForEquifaxUSA" } ] } } }, "KnowledgeBasedAuthenticationStatus": { "type": "string", "description": "", "x-enumNames": [ "NOT_YET_ATTEMPTED", "PASSED", "FAILED", "INVALID_SIGNER", "UPDATED" ], "enum": [ "NOT_YET_ATTEMPTED", "PASSED", "FAILED", "INVALID_SIGNER", "UPDATED" ] }, "SignerInformationForEquifaxCanada": { "type": "object", "description": "Object to manage Equifax Canada information", "additionalProperties": false, "properties": { "city": { "type": "string", "description": "City" }, "dateOfBirth": { "type": "string", "description": "Date of birth", "format": "date-time", "nullable": true }, "driversLicenseNumber": { "type": "string", "description": "Drivers license number" }, "firstName": { "type": "string", "description": "First name" }, "homePhoneNumber": { "type": "string", "description": "Home phone number" }, "lastName": { "type": "string", "description": "Last name" }, "socialInsuranceNumber": { "type": "string", "description": "Social insurance number" }, "province": { "type": "string", "description": "Province" }, "streetAddress": { "type": "string", "description": "Street address" }, "timeAtAddress": { "type": "integer", "description": "Time at address", "format": "int32", "nullable": true }, "postalCode": { "type": "string", "description": "Postal code" } } }, "SignerInformationForEquifaxUSA": { "type": "object", "description": "Object to manage Equifax USA information", "additionalProperties": false, "properties": { "city": { "type": "string", "description": "City" }, "dateOfBirth": { "type": "string", "description": "Date of birth", "format": "date-time", "nullable": true }, "driversLicenseNumber": { "type": "string", "description": "Drivers license number" }, "firstName": { "type": "string", "description": "First name" }, "homePhoneNumber": { "type": "string", "description": "Home phone number" }, "lastName": { "type": "string", "description": "Last name" }, "socialSecurityNumber": { "type": "string", "description": "Social security number" }, "state": { "type": "string", "description": "State" }, "streetAddress": { "type": "string", "description": "Street address" }, "timeAtAddress": { "type": "integer", "description": "Time at address", "format": "int32", "nullable": true }, "zip": { "type": "string", "description": "Zip code" } } }, "SignerType": { "type": "string", "description": "", "x-enumNames": [ "ACCOUNT_SENDER", "EXTERNAL_SENDER", "EXTERNAL_SIGNER", "GROUP_SIGNER" ], "enum": [ "ACCOUNT_SENDER", "EXTERNAL_SENDER", "EXTERNAL_SIGNER", "GROUP_SIGNER" ] }, "RoleType": { "type": "string", "description": "", "x-enumNames": [ "SIGNER", "SENDER" ], "enum": [ "SIGNER", "SENDER" ] }, "FieldCondition": { "type": "object", "description": "Object to manage field conditions", "additionalProperties": false, "properties": { "id": { "type": "string", "description": "The id of the field condition" }, "condition": { "type": "string", "description": "The condition that determines if action is needed" }, "action": { "type": "string", "description": "The action to take when the condition is true" } } }, "Sender": { "type": "object", "description": "Sender", "additionalProperties": false, "properties": { "type": { "description": "Type", "oneOf": [ { "$ref": "#/components/schemas/SenderType" } ] }, "status": { "description": "Status", "oneOf": [ { "$ref": "#/components/schemas/SenderStatus" } ] }, "specialTypes": { "type": "array", "description": "Special User Types. Currently only NOTARY is supported.", "items": { "type": "string" } }, "name": { "type": "string", "description": "Name" }, "signature": { "description": "Gets or Sets Signature", "oneOf": [ { "$ref": "#/components/schemas/SignatureStyle" } ] }, "account": { "description": "Gets or Sets Account", "oneOf": [ { "$ref": "#/components/schemas/Account" } ] }, "address": { "description": "Gets or Sets Address", "oneOf": [ { "$ref": "#/components/schemas/Address" } ] }, "created": { "type": "string", "description": "Created", "format": "date-time", "nullable": true }, "id": { "type": "string", "description": "Id" }, "data": { "type": "object", "description": "Data", "additionalProperties": {} }, "language": { "type": "string", "description": "Available options: en, fr, it, ru, es, pt, de, nl, da, el, zh-CN, zh-TW, ja, ko" }, "timezoneId": { "type": "string", "description": "TimezoneId" }, "external": { "description": "Gets or Sets External", "oneOf": [ { "$ref": "#/components/schemas/External" } ] }, "company": { "type": "string", "description": "Company" }, "updated": { "type": "string", "description": "Updated", "format": "date-time", "nullable": true }, "phone": { "type": "string", "description": "Phone" }, "userCustomFields": { "type": "array", "description": "UserCustomFields", "items": { "$ref": "#/components/schemas/UserCustomField" } }, "professionalIdentityFields": { "type": "array", "description": "ProfessionalIdentityFields", "items": { "$ref": "#/components/schemas/ProfessionalIdentityField" } }, "title": { "type": "string", "description": "Title" }, "firstName": { "type": "string", "description": "FirstName" }, "lastName": { "type": "string", "description": "LastName" }, "email": { "type": "string", "description": "Email" }, "locked": { "type": "string", "description": "Locked", "format": "date-time", "nullable": true }, "activated": { "type": "string", "description": "Activated", "format": "date-time", "nullable": true }, "memberships": { "type": "array", "description": "Memberships", "items": { "$ref": "#/components/schemas/GroupMembership" } }, "hasDelegates": { "type": "boolean", "description": "Has Delegates", "nullable": true } } }, "SenderType": { "type": "string", "description": "", "x-enumNames": [ "REGULAR", "MANAGER" ], "enum": [ "REGULAR", "MANAGER" ] }, "SenderStatus": { "type": "string", "description": "", "x-enumNames": [ "INVITED", "ACTIVE", "LOCKED" ], "enum": [ "INVITED", "ACTIVE", "LOCKED" ] }, "GroupMembership": { "type": "object", "description": "Object to manage group membership", "additionalProperties": false, "properties": { "groupId": { "type": "string", "description": "GroupId" }, "groupName": { "type": "string", "description": "GroupName" }, "memberType": { "description": "MemberType", "oneOf": [ { "$ref": "#/components/schemas/MemberType" } ] } } }, "PackageSettings": { "type": "object", "description": "Object to manage package settings", "additionalProperties": false, "properties": { "ceremony": { "description": "CeremonySettings", "oneOf": [ { "$ref": "#/components/schemas/CeremonySettings" } ] } } }, "CeremonySettings": { "type": "object", "description": "Settings to manage the signing ceremony", "additionalProperties": false, "properties": { "declineButton": { "type": "boolean", "description": "Decline button", "nullable": true }, "declineReasons": { "type": "array", "description": "List of decline reasons", "items": { "type": "string" } }, "disableDeclineOther": { "type": "boolean", "description": "DisableDeclineOther", "nullable": true }, "disableDownloadForUncompletedPackage": { "type": "boolean", "description": "DisableDownloadForUncompletedPackage", "nullable": true }, "disableFirstInPersonAffidavit": { "type": "boolean", "description": "DisableFirstInPersonAffidavit", "nullable": true }, "disableInPersonAffidavit": { "type": "boolean", "description": "DisableInPersonAffidavit", "nullable": true }, "disableOptOutOther": { "type": "boolean", "description": "DisableOptOutOther", "nullable": true }, "disableSecondInPersonAffidavit": { "type": "boolean", "description": "DisableSecondInPersonAffidavit", "nullable": true }, "ada": { "type": "boolean", "description": "Ada", "nullable": true }, "fontSize": { "type": "integer", "description": "FontSize", "format": "int32", "nullable": true }, "defaultTimeBasedExpiry": { "type": "boolean", "description": "DefaultTimeBasedExpiry", "nullable": true }, "remainingDays": { "type": "integer", "description": "RemainingDays", "format": "int32", "nullable": true }, "enforceCaptureSignature": { "type": "boolean", "description": "EnforceCaptureSignature", "nullable": true }, "documentToolbarOptions": { "description": "DocumentToolbarOptions", "oneOf": [ { "$ref": "#/components/schemas/DocumentToolbarOptions" } ] }, "events": { "description": "Ceremony events", "oneOf": [ { "$ref": "#/components/schemas/CeremonyEvents" } ] }, "handOver": { "description": "A Link that specifies where to redirect the signer after completing transaction", "oneOf": [ { "$ref": "#/components/schemas/Link" } ] }, "hideCaptureText": { "type": "boolean", "description": "HideCaptureText", "nullable": true }, "hideLanguageDropdown": { "type": "boolean", "description": "HideLanguageDropdown", "nullable": true }, "hidePackageOwnerInPerson": { "type": "boolean", "description": "HidePackageOwnerInPerson", "nullable": true }, "hideWatermark": { "type": "boolean", "description": "HideWatermark", "nullable": true }, "inPerson": { "type": "boolean", "description": "InPerson", "nullable": true }, "layout": { "description": "Layout options", "oneOf": [ { "$ref": "#/components/schemas/LayoutOptions" } ] }, "maxAuthFailsAllowed": { "type": "integer", "description": "MaxAuthFailsAllowed", "format": "int32", "nullable": true }, "optOutButton": { "type": "boolean", "description": "OptOutButton", "nullable": true }, "optOutReasons": { "type": "array", "description": "OptOutReasons", "items": { "type": "string" } }, "style": { "description": "The layout style", "oneOf": [ { "$ref": "#/components/schemas/LayoutStyle" } ] } } }, "DocumentToolbarOptions": { "type": "object", "description": "Object to manage the document toolbar", "additionalProperties": false, "properties": { "downloadButton": { "type": "boolean", "description": "Determines if download button is available on document toolbar", "nullable": true } } }, "CeremonyEvents": { "type": "object", "description": "Ceremony events", "additionalProperties": false, "properties": { "complete": { "description": " ", "oneOf": [ { "$ref": "#/components/schemas/CeremonyEventComplete" } ] } } }, "CeremonyEventComplete": { "type": "object", "description": " ", "additionalProperties": false, "properties": { "dialog": { "type": "boolean", "description": " ", "nullable": true }, "redirect": { "type": "string", "description": " " } } }, "Link": { "allOf": [ { "$ref": "#/components/schemas/Handover" }, { "type": "object", "description": "Object used to manage link in Handover objects", "additionalProperties": false, "properties": { "autoRedirect": { "type": "boolean", "description": "AutoRedirect", "nullable": true }, "parameters": { "type": "array", "description": "List of parameters for link url", "items": { "type": "string" } } } } ] }, "Handover": { "type": "object", "description": "Object used to manage a redirect url when signing is completed", "additionalProperties": false, "properties": { "href": { "type": "string", "description": "The href of the handover url" }, "text": { "type": "string", "description": "The text displayed on the button" }, "title": { "type": "string", "description": "The hover text displayed on the button" } } }, "LayoutOptions": { "type": "object", "description": "Object to manage layout options", "additionalProperties": false, "properties": { "brandingBar": { "description": "Branding bar options", "oneOf": [ { "$ref": "#/components/schemas/BrandingBarOptions" } ] }, "footer": { "description": "Footer options", "oneOf": [ { "$ref": "#/components/schemas/FooterOptions" } ] }, "header": { "description": "Header options", "oneOf": [ { "$ref": "#/components/schemas/HeaderOptions" } ] }, "iframe": { "type": "boolean", "description": "Determines if the page is iframed", "nullable": true }, "navigator": { "type": "boolean", "description": "Navigator", "nullable": true } } }, "BrandingBarOptions": { "type": "object", "description": "Branding bar options", "additionalProperties": false, "properties": { "logo": { "description": "Logo to display on branding bar", "oneOf": [ { "$ref": "#/components/schemas/Image" } ] } } }, "Image": { "type": "object", "additionalProperties": false, "properties": { "link": { "type": "string", "description": "Link" }, "src": { "type": "string", "description": "Src" } } }, "FooterOptions": { "type": "object", "additionalProperties": false }, "HeaderOptions": { "type": "object", "description": "Object to manage header options", "additionalProperties": false, "properties": { "breadcrumbs": { "type": "boolean", "description": "Breadcrumbs", "nullable": true }, "feedback": { "type": "boolean", "description": "Feedback", "nullable": true }, "globalActions": { "description": "GlobalActions options", "oneOf": [ { "$ref": "#/components/schemas/GlobalActionsOptions" } ] }, "globalNavigation": { "type": "boolean", "description": "GlobalNavigation", "nullable": true }, "sessionBar": { "type": "boolean", "description": "SessionBar", "nullable": true }, "titleBar": { "description": "TitleBar options", "oneOf": [ { "$ref": "#/components/schemas/TitleBarOptions" } ] } } }, "GlobalActionsOptions": { "type": "object", "description": "Object to manage global actions on header object", "additionalProperties": false, "properties": { "confirm": { "type": "boolean", "description": "Confirm", "nullable": true }, "download": { "type": "boolean", "description": "Download", "nullable": true }, "hideEvidenceSummary": { "type": "boolean", "description": "HideEvidenceSummary", "nullable": true }, "saveAsLayout": { "type": "boolean", "description": "SaveAsLayout", "nullable": true } } }, "TitleBarOptions": { "type": "object", "description": "Object to manage title bar options", "additionalProperties": false, "properties": { "progressBar": { "type": "boolean", "description": "ProgressBar", "nullable": true }, "title": { "type": "boolean", "description": "Title", "nullable": true } } }, "LayoutStyle": { "type": "object", "description": "Object to manage layout styles", "additionalProperties": false, "properties": { "brandingBar": { "description": "Image that represents the branding bar", "oneOf": [ { "$ref": "#/components/schemas/Image" } ] }, "dialog": { "description": "Style for the dialog", "oneOf": [ { "$ref": "#/components/schemas/Style" } ] }, "titleBar": { "description": "Style for the title bar", "oneOf": [ { "$ref": "#/components/schemas/Style" } ] }, "toolbar": { "description": "Style for the toolbar", "oneOf": [ { "$ref": "#/components/schemas/Style" } ] } } }, "Style": { "type": "object", "additionalProperties": false, "properties": { "backgroundColor": { "type": "string", "description": "Background color" }, "color": { "type": "string", "description": "Color" } } }, "SignedDocumentDelivery": { "type": "object", "description": "Object to manage signed document delivery", "additionalProperties": false, "properties": { "destinations": { "type": "array", "description": "List of provider destinations for document delivery", "items": { "$ref": "#/components/schemas/External" } }, "excludedDocuments": { "type": "array", "description": "List of documents to exclude", "items": { "$ref": "#/components/schemas/Document" } }, "filePrefix": { "type": "string", "description": "File prefix" }, "fileSuffix": { "type": "string", "description": "File suffix" } } }, "PackageStatus": { "type": "string", "description": "", "x-enumNames": [ "DRAFT", "SENT", "COMPLETED", "ARCHIVED", "DECLINED", "OPTED_OUT", "EXPIRED" ], "enum": [ "DRAFT", "SENT", "COMPLETED", "ARCHIVED", "DECLINED", "OPTED_OUT", "EXPIRED" ] }, "BasePackageType": { "type": "string", "description": "The type of package", "x-enumNames": [ "PACKAGE", "TEMPLATE", "LAYOUT" ], "enum": [ "PACKAGE", "TEMPLATE", "LAYOUT" ] }, "Visibility": { "type": "string", "description": "", "x-enumNames": [ "ACCOUNT", "SENDER" ], "enum": [ "ACCOUNT", "SENDER" ] }, "PackageLayout": { "type": "object", "description": "A layout enables you to save a prepared document for future reuse. After at\nleast one Signature Field has been placed in a document, and a layout of the\ndocument has been saved, that layout can be applied to any other document\ncreated thereafter.", "additionalProperties": false, "required": [ "documents", "id", "name", "type", "visibility" ], "properties": { "description": { "type": "string", "description": "Description of the layout." }, "documents": { "type": "array", "description": "Documents from the layout.", "items": { "$ref": "#/components/schemas/Document" } }, "id": { "type": "string", "description": "The id of the layout.", "minLength": 1 }, "name": { "type": "string", "description": "Name of the layout.", "minLength": 1 }, "type": { "description": "The layout type.", "oneOf": [ { "$ref": "#/components/schemas/PackageLayoutType" } ] }, "visibility": { "description": "Access level for the layout", "oneOf": [ { "$ref": "#/components/schemas/Visibility" } ] } } }, "PackageLayoutType": { "type": "string", "description": "", "x-enumNames": [ "LAYOUT" ], "enum": [ "LAYOUT" ] }, "NotificationRequest": { "type": "object", "description": "Object to manage resending notifications to signers", "additionalProperties": false, "properties": { "email": { "type": "string", "description": "E-Mail Address for Signer receiving re-sent notification." }, "message": { "type": "string", "description": "Notification Message to be sent to Signer." } } }, "PackageReadiness": { "type": "object", "description": "PackageRadiness", "additionalProperties": false, "properties": { "data": { "type": "object", "description": "Data", "additionalProperties": {} }, "errorKeys": { "type": "array", "description": "Error Keys", "items": { "type": "string" } }, "id": { "type": "string", "description": "Id" }, "name": { "type": "string", "description": "Name" }, "stageType": { "type": "string", "description": "Stage Type" }, "status": { "type": "boolean", "description": "Status" } } }, "ExportedAuditTrail": { "type": "object", "additionalProperties": false, "properties": { "packageId": { "type": "string", "description": "The unique package id.", "example": "9xZvSoqg-ksfWUMGUDjmt1D4tzA=" }, "auditEvents": { "type": "array", "description": "Audit events.", "items": { "$ref": "#/components/schemas/AuditEvent" } } } }, "AuditEvent": { "type": "object", "description": "Object representing and audit event", "additionalProperties": false, "properties": { "target-type": { "description": "The target type.", "oneOf": [ { "$ref": "#/components/schemas/TargetType" } ] }, "date-time": { "type": "string", "description": "The time the event happened.", "format": "date-time" }, "type": { "description": "The audit type.", "oneOf": [ { "$ref": "#/components/schemas/AuditType" } ] }, "target": { "type": "string", "description": "The audit target." }, "user": { "type": "string", "description": "The signer full name.", "example": "John Smith" }, "user-email": { "type": "string", "description": "The signer email.", "example": "john.smith@myemail.com" }, "user-ip": { "type": "string", "description": "The signer ip.", "example": "10.85.37.250" }, "data": { "type": "string", "description": "The data signer enters." } } }, "TargetType": { "type": "string", "description": "", "x-enumNames": [ "Document", "Package", "AuthMethod", "Account", "CHALLENGE", "SMS", "SSO", "EMAIL_LINK", "KnowledgeBasedAuthentication" ], "enum": [ "Document", "Package", "AuthMethod", "Account", "CHALLENGE", "SMS", "SSO", "EMAIL_LINK", "KnowledgeBasedAuthentication" ] }, "AuditType": { "type": "string", "description": "", "x-enumNames": [ "Accept", "ClickToSign", "ClickToInitial", "CaptureSignature", "Confirm", "Download", "DownloadZip", "FormField", "Login", "View", "OptOut", "SigningSessionForRecipient", "Decline" ], "enum": [ "Accept", "ClickToSign", "ClickToInitial", "CaptureSignature", "Confirm", "Download", "DownloadZip", "FormField", "Login", "View", "OptOut", "SigningSessionForRecipient", "Decline" ] }, "FieldSummary": { "type": "object", "description": "Object to manage field summaries", "additionalProperties": false, "properties": { "signerId": { "type": "string", "description": "Signer Id" }, "documentId": { "type": "string", "description": "Document Id" }, "fieldId": { "type": "string", "description": "Field Id." }, "fieldName": { "type": "string", "description": "Field Name" }, "fieldValue": { "type": "string", "description": "Field Value" } } }, "ReferencedConditions": { "type": "object", "description": "Package details", "additionalProperties": false, "properties": { "packageId": { "type": "string", "description": "The package id" }, "documents": { "type": "array", "description": "List of referenced documents in the package", "items": { "$ref": "#/components/schemas/ReferencedDocument" } } } }, "ReferencedDocument": { "type": "object", "description": "Object to manage a referenced document", "additionalProperties": false, "properties": { "documentId": { "type": "string", "description": "DocumentId" }, "fields": { "type": "array", "description": "List of referenced fields", "items": { "$ref": "#/components/schemas/ReferencedField" } } } }, "ReferencedField": { "type": "object", "description": "Object to manage a referenced field", "additionalProperties": false, "properties": { "fieldId": { "type": "string", "description": "FieldId" }, "conditions": { "description": "List of referenced field conditions", "oneOf": [ { "$ref": "#/components/schemas/ReferencedFieldConditions" } ] } } }, "ReferencedFieldConditions": { "type": "object", "description": "Object to manage a referenced field condition", "additionalProperties": false, "properties": { "referencedInCondition": { "type": "array", "description": "List of fields referenced in conditions", "items": { "$ref": "#/components/schemas/FieldCondition" } }, "referencedInAction": { "type": "array", "description": "List of fields referenced in actions", "items": { "$ref": "#/components/schemas/FieldCondition" } } } }, "ResultOfRole": { "type": "object", "description": "Object used to manage OneSpan list types", "additionalProperties": false, "properties": { "count": { "type": "integer", "description": "Count", "format": "int32" }, "results": { "type": "array", "description": "Results", "items": { "$ref": "#/components/schemas/Role" } } } }, "SigningStatus": { "type": "object", "additionalProperties": false, "properties": { "status": { "type": "string", "description": "The package status.\n\nCOMPLETED" } } }, "SigningUrl": { "type": "object", "description": "Object representing a signing url", "additionalProperties": false, "properties": { "packageId": { "type": "string", "description": "Package Id" }, "roleId": { "type": "string", "description": "Role Id" }, "url": { "type": "string", "description": "Url" } } }, "ResultOfPackageReminderSchedule": { "type": "object", "description": "Object used to manage Conga Sign powered by OneSpan list types", "additionalProperties": false, "properties": { "count": { "type": "integer", "description": "Count", "format": "int32" }, "results": { "type": "array", "description": "Results", "items": { "$ref": "#/components/schemas/PackageReminderSchedule" } } } }, "PackageReminderSchedule": { "type": "object", "description": "By setting a reminder schedule, a sender can choose when and how often to notify a signer about a pending signature,\nin addition to the initial notification sent the moment the transaction is sent for signing. In other words,\nassuming the transaction is not yet completed, a customizable number of notifications can be sent with a specified\ninterval between each to remind your signer that a signature is required.", "additionalProperties": false, "properties": { "intervalInDays": { "type": "integer", "description": "Reminder interval (in days).", "format": "int32" }, "packageId": { "type": "string", "description": "The unique package Id." }, "reminders": { "type": "array", "description": "List of Reminders.", "items": { "$ref": "#/components/schemas/PackageReminder" } }, "repetitionsCount": { "type": "integer", "description": "Number of repetitive counts.", "format": "int32" }, "startInDaysDelay": { "type": "integer", "description": "Reminder delay (in days).", "format": "int32" } } }, "PackageReminder": { "type": "object", "description": "Dates of package reminder, including transaction and reminder sent dates.", "additionalProperties": false, "properties": { "date": { "type": "string", "description": "Transaction sent date.", "format": "date-time", "nullable": true }, "sentDate": { "type": "string", "description": "Reminder sent date.", "format": "date-time", "nullable": true } } }, "UsageReport": { "type": "object", "description": "The Usage Report displays, for each sender, the number of packages that are in each possible state\n(for example, DRAFT, SENT, COMPLETED).", "additionalProperties": false, "properties": { "from": { "type": "string", "description": "The first usage record to be returned.", "format": "date-time", "nullable": true }, "senders": { "type": "array", "description": "List of senders and their usage packages.", "items": { "$ref": "#/components/schemas/SenderUsageReport" } }, "to": { "type": "string", "description": "The last usage record to be returned.", "format": "date-time", "nullable": true } } }, "SenderUsageReport": { "type": "object", "description": "The report of sender usages.", "additionalProperties": false, "properties": { "packages": { "type": "object", "description": "The list of packages.", "additionalProperties": {} }, "sender": { "description": "Sender information.", "oneOf": [ { "$ref": "#/components/schemas/Sender" } ] } } }, "CompletionReport": { "type": "object", "description": "A Completion Report contains information about your senders, their associated packages, and their package status.", "additionalProperties": false, "properties": { "from": { "type": "string", "description": "The first completion report that will be returned", "format": "date-time", "nullable": true }, "senders": { "type": "array", "description": "The list of senders and their packages.", "items": { "$ref": "#/components/schemas/SenderCompletionReport" } }, "to": { "type": "string", "description": "The last completion report that will be returned", "format": "date-time", "nullable": true } } }, "SenderCompletionReport": { "type": "object", "description": "A Sender Completion Report contains information about your senders, their associated packages,\nand their package status.", "additionalProperties": false, "properties": { "packages": { "type": "array", "description": "The list of packages.", "items": { "$ref": "#/components/schemas/PackageCompletionReport" } }, "sender": { "description": "The sender information.", "oneOf": [ { "$ref": "#/components/schemas/Sender" } ] } } }, "PackageCompletionReport": { "type": "object", "description": "A Completion Report contains information about your senders, signers, their associated packages, and their package status.", "additionalProperties": false, "properties": { "created": { "type": "string", "description": "The time package report is created.", "format": "date-time", "nullable": true }, "data": { "type": "object", "description": "The package completion metadata.", "additionalProperties": {} }, "documents": { "type": "array", "description": "The list of completed documents.", "items": { "$ref": "#/components/schemas/DocumentCompletionReport" } }, "id": { "type": "string", "description": "The unique package completion Id." }, "name": { "type": "string", "description": "The package name." }, "signers": { "type": "array", "description": "The list of package signers.", "items": { "$ref": "#/components/schemas/SignersCompletionReport" } }, "status": { "description": "The package status.", "oneOf": [ { "$ref": "#/components/schemas/PackageStatus" } ] }, "trashed": { "type": "boolean", "description": "Check if package is trashed." }, "updated": { "type": "string", "description": "The date of package update.", "format": "date-time", "nullable": true } } }, "DocumentCompletionReport": { "type": "object", "description": "A report for a document", "additionalProperties": false, "properties": { "completed": { "type": "boolean", "description": "Indicates if the document has been completed" }, "firstSigned": { "type": "string", "description": "Date the first approval was signed", "format": "date-time", "nullable": true }, "id": { "type": "string", "description": "Unique id of the document" }, "lastSigned": { "type": "string", "description": "Date the last approval was signed", "format": "date-time", "nullable": true }, "name": { "type": "string", "description": "Name of the document" } } }, "SignersCompletionReport": { "type": "object", "description": "Object to manage signers for a package completion report", "additionalProperties": false, "properties": { "completed": { "type": "boolean", "description": "Completed" }, "email": { "type": "string", "description": "Email" }, "firstName": { "type": "string", "description": "First name" }, "firstSigned": { "type": "string", "description": "Date of first signing", "format": "date-time", "nullable": true }, "id": { "type": "string", "description": "Signer Id" }, "lastName": { "type": "string", "description": "Last name" }, "lastSigned": { "type": "string", "description": "Date of last signing", "format": "date-time", "nullable": true } } }, "TransactionSummaryReport": { "type": "object", "description": "The report of transaction summaries, including content and the total number of packages.", "additionalProperties": false, "properties": { "content": { "type": "array", "description": "The transaction package contents.", "items": { "$ref": "#/components/schemas/Package" } }, "totalElements": { "type": "integer", "description": "The total number of transactions.", "format": "int32" } } }, "DelegationReport": { "type": "object", "description": "Retrieve an extensive delegation audit trail for an account. This audit trail provides a complete\nhistory of any changes occurring in the account regarding delegation.", "additionalProperties": false, "properties": { "delegationEvents": { "type": "object", "description": "List of delegation events and delegated users.", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/DelegationEventReport" } } }, "from": { "type": "string", "description": "The first delegation report that will be returned.", "format": "date-time", "nullable": true }, "to": { "type": "string", "description": "The last delegation report that will be returned.", "format": "date-time", "nullable": true } } }, "DelegationEventReport": { "type": "object", "description": "The report of delegation events for signers. Delegates can sign documents on behalf of the delegator,\nand they can access the delegator's inbox, drafts, layouts, and templates.", "additionalProperties": false, "properties": { "eventDate": { "type": "string", "description": "Date of delegation creation.", "format": "date-time", "nullable": true }, "eventDescription": { "type": "string", "description": "Description of delegation." }, "eventType": { "type": "string", "description": "Type of delegation event." }, "eventUser": { "type": "string", "description": "The delegation event user information." } } }, "RoleReordering": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "description": "Role Id." }, "index": { "type": "integer", "description": "New index of the role.", "format": "int32" } } }, "Verification": { "type": "object", "description": "Object to manage verification on roles", "additionalProperties": false, "properties": { "typeId": { "type": "string", "description": "Type Id" }, "payload": { "type": "string", "description": "Payload" } } }, "ResultOfSender": { "type": "object", "description": "Object used to manage Conga Sign powered by OneSpan list types", "additionalProperties": false, "properties": { "count": { "type": "integer", "description": "Count", "format": "int32" }, "results": { "type": "array", "description": "Results", "items": { "$ref": "#/components/schemas/Sender" } } } }, "SignatureImage": { "type": "object", "description": "Object to manage a senders signature image", "additionalProperties": false, "properties": { "fileName": { "type": "string", "description": "File name" }, "mediaType": { "type": "string", "description": "Media type" }, "content": { "type": "string", "description": "Base64 encoded image" } } }, "IHeaderDictionary": { "type": "object", "x-abstract": true, "additionalProperties": false, "properties": { "Item": { "type": "array", "items": {} }, "ContentLength": { "type": "integer", "format": "int64", "nullable": true }, "Accept": { "type": "array", "items": {} }, "AcceptCharset": { "type": "array", "items": {} }, "AcceptEncoding": { "type": "array", "items": {} }, "AcceptLanguage": { "type": "array", "items": {} }, "AcceptRanges": { "type": "array", "items": {} }, "AccessControlAllowCredentials": { "type": "array", "items": {} }, "AccessControlAllowHeaders": { "type": "array", "items": {} }, "AccessControlAllowMethods": { "type": "array", "items": {} }, "AccessControlAllowOrigin": { "type": "array", "items": {} }, "AccessControlExposeHeaders": { "type": "array", "items": {} }, "AccessControlMaxAge": { "type": "array", "items": {} }, "AccessControlRequestHeaders": { "type": "array", "items": {} }, "AccessControlRequestMethod": { "type": "array", "items": {} }, "Age": { "type": "array", "items": {} }, "Allow": { "type": "array", "items": {} }, "AltSvc": { "type": "array", "items": {} }, "Authorization": { "type": "array", "items": {} }, "Baggage": { "type": "array", "items": {} }, "CacheControl": { "type": "array", "items": {} }, "Connection": { "type": "array", "items": {} }, "ContentDisposition": { "type": "array", "items": {} }, "ContentEncoding": { "type": "array", "items": {} }, "ContentLanguage": { "type": "array", "items": {} }, "ContentLocation": { "type": "array", "items": {} }, "ContentMD5": { "type": "array", "items": {} }, "ContentRange": { "type": "array", "items": {} }, "ContentSecurityPolicy": { "type": "array", "items": {} }, "ContentSecurityPolicyReportOnly": { "type": "array", "items": {} }, "ContentType": { "type": "array", "items": {} }, "CorrelationContext": { "type": "array", "items": {} }, "Cookie": { "type": "array", "items": {} }, "Date": { "type": "array", "items": {} }, "ETag": { "type": "array", "items": {} }, "Expires": { "type": "array", "items": {} }, "Expect": { "type": "array", "items": {} }, "From": { "type": "array", "items": {} }, "GrpcAcceptEncoding": { "type": "array", "items": {} }, "GrpcEncoding": { "type": "array", "items": {} }, "GrpcMessage": { "type": "array", "items": {} }, "GrpcStatus": { "type": "array", "items": {} }, "GrpcTimeout": { "type": "array", "items": {} }, "Host": { "type": "array", "items": {} }, "KeepAlive": { "type": "array", "items": {} }, "IfMatch": { "type": "array", "items": {} }, "IfModifiedSince": { "type": "array", "items": {} }, "IfNoneMatch": { "type": "array", "items": {} }, "IfRange": { "type": "array", "items": {} }, "IfUnmodifiedSince": { "type": "array", "items": {} }, "LastModified": { "type": "array", "items": {} }, "Link": { "type": "array", "items": {} }, "Location": { "type": "array", "items": {} }, "MaxForwards": { "type": "array", "items": {} }, "Origin": { "type": "array", "items": {} }, "Pragma": { "type": "array", "items": {} }, "ProxyAuthenticate": { "type": "array", "items": {} }, "ProxyAuthorization": { "type": "array", "items": {} }, "ProxyConnection": { "type": "array", "items": {} }, "Range": { "type": "array", "items": {} }, "Referer": { "type": "array", "items": {} }, "RetryAfter": { "type": "array", "items": {} }, "RequestId": { "type": "array", "items": {} }, "SecWebSocketAccept": { "type": "array", "items": {} }, "SecWebSocketKey": { "type": "array", "items": {} }, "SecWebSocketProtocol": { "type": "array", "items": {} }, "SecWebSocketVersion": { "type": "array", "items": {} }, "SecWebSocketExtensions": { "type": "array", "items": {} }, "Server": { "type": "array", "items": {} }, "SetCookie": { "type": "array", "items": {} }, "StrictTransportSecurity": { "type": "array", "items": {} }, "TE": { "type": "array", "items": {} }, "Trailer": { "type": "array", "items": {} }, "TransferEncoding": { "type": "array", "items": {} }, "Translate": { "type": "array", "items": {} }, "TraceParent": { "type": "array", "items": {} }, "TraceState": { "type": "array", "items": {} }, "Upgrade": { "type": "array", "items": {} }, "UpgradeInsecureRequests": { "type": "array", "items": {} }, "UserAgent": { "type": "array", "items": {} }, "Vary": { "type": "array", "items": {} }, "Via": { "type": "array", "items": {} }, "Warning": { "type": "array", "items": {} }, "WebSocketSubProtocols": { "type": "array", "items": {} }, "WWWAuthenticate": { "type": "array", "items": {} }, "XContentTypeOptions": { "type": "array", "items": {} }, "XFrameOptions": { "type": "array", "items": {} }, "XPoweredBy": { "type": "array", "items": {} }, "XRequestedWith": { "type": "array", "items": {} }, "XUACompatible": { "type": "array", "items": {} }, "XXSSProtection": { "type": "array", "items": {} } } }, "Session": { "type": "object", "additionalProperties": false, "properties": { "account": { "description": "Account information.", "oneOf": [ { "$ref": "#/components/schemas/Account" } ] }, "delegationUser": { "description": "Delegated user information.", "oneOf": [ { "$ref": "#/components/schemas/DelegationUser" } ] }, "features": { "description": "Features in current account. True if enabled, false if disabled.", "oneOf": [ { "$ref": "#/components/schemas/Features" } ] }, "inPerson": { "type": "boolean" }, "packages": { "type": "array", "items": { "type": "string" } }, "restricted": { "type": "boolean" }, "support": { "description": "Support contact information.", "oneOf": [ { "$ref": "#/components/schemas/SupportConfiguration" } ] }, "user": { "description": "Account Owner information.", "oneOf": [ { "$ref": "#/components/schemas/User" } ] } } }, "DelegationUser": { "type": "object", "description": "Delegated user.\nDelegates can sign documents on behalf of the delegator, and they can access the delegator's inbox, drafts, layouts,\nand templates. All transactions performed by the delegate nonetheless continue to be owned by the delegator.", "additionalProperties": false, "properties": { "email": { "type": "string", "description": "Delegated user email." }, "firstName": { "type": "string", "description": "Delegated user first name." }, "id": { "type": "string", "description": "Unique delegated user Id." }, "lastName": { "type": "string", "description": "Delegated user last name." }, "name": { "type": "string", "description": "Delegated user full name." }, "expiryDate": { "type": "string", "description": "Delegation expiration date.", "format": "date-time", "nullable": true } } }, "Features": { "type": "object", "additionalProperties": false, "properties": { "attachments": { "type": "boolean", "description": "Attachments" }, "authenticatedInbox": { "type": "boolean", "description": "AuthenticatedInbox" }, "customFields": { "type": "boolean", "description": "CustomFields" }, "encryptDocuments": { "type": "boolean", "description": "EncryptDocuments" }, "evidenceSummary": { "type": "boolean", "description": "EvidenceSummary" }, "fastTrack": { "type": "boolean", "description": "FastTrack" }, "forceLogin": { "type": "boolean", "description": "ForceLogin" }, "groups": { "type": "boolean", "description": "Groups" }, "inboxFiltering": { "type": "boolean", "description": "InboxFiltering" }, "kba": { "type": "boolean", "description": "KBA" }, "notarize": { "type": "boolean", "description": "Notarize" }, "showDocumentsPreview": { "type": "boolean", "description": "ShowDocumentsPreview" }, "tamperSealEvidence": { "type": "boolean", "description": "TamperSealEvidence" }, "optionalSignature": { "type": "boolean", "description": "OptionalSignature" }, "qrCode": { "type": "boolean", "description": "QR Code" }, "geteWitnessRecording": { "type": "boolean", "description": "Get e-WitnessRecording" }, "flattenSignerDocuments": { "type": "boolean", "description": "FlattenSignerDocuments" }, "delegation": { "type": "boolean", "description": "Delegation" }, "documentVisibility": { "type": "boolean", "description": "DocumentVisibility" }, "sendToMobile": { "type": "boolean", "description": "SendToMobile" }, "certificateSigning": { "type": "boolean", "description": "CertificateSigning" }, "equifaxCanada": { "type": "boolean", "description": "EquifaxCanada" }, "equifaxUSA": { "type": "boolean", "description": "EquifaxUSA" }, "smsAuth": { "type": "boolean", "description": "SmsAuth" }, "enforceAuth": { "type": "boolean", "description": "EnforceAuth" }, "ofacBlacklist": { "type": "boolean", "description": "OfacBlacklist" }, "mobileCapture": { "type": "boolean", "description": "MobileCapture" }, "maskResponse": { "type": "boolean", "description": "MaskResponse" }, "allowInPersonForAccountSenders": { "type": "boolean", "description": "AllowInPersonForAccountSenders" }, "mobileSigningCeremony": { "type": "boolean", "description": "MobileSigningCeremony" }, "mobileSigningCeremonyTablet": { "type": "boolean", "description": "MobileSigningCeremonyTablet" }, "disableInPersonActivationEmail": { "type": "boolean", "description": "DisableInPersonActivationEmail" }, "emailDocumentsAndEvidenceSummary": { "type": "boolean", "description": "EmailDocumentsAndEvidenceSummary" }, "bulkSend": { "type": "boolean", "description": "BulkSend" }, "disableFooter": { "type": "boolean", "description": "DisableFooter" }, "externalSignerVerification": { "type": "boolean", "description": "ExternalSignerVerification" }, "personalCertificateClient": { "type": "boolean", "description": "PersonalCertificateClient" }, "allowIntegration": { "type": "boolean", "description": "AllowIntegration" }, "preventConsentRemoval": { "type": "boolean", "description": "PreventConsentRemoval" }, "conditionalFields": { "type": "boolean", "description": "ConditionalFields" }, "ssoLogin": { "type": "boolean" }, "signerSso": { "type": "boolean" }, "allowUiSwitch": { "type": "boolean" }, "enableNewUi": { "type": "boolean" }, "enableSignerUi": { "type": "boolean" } } }, "SupportConfiguration": { "type": "object", "description": "Object to manage support configuration", "additionalProperties": false, "properties": { "email": { "type": "string", "description": "Email" }, "phone": { "type": "string", "description": "Phone" } } }, "AccessibleAccountResponse": { "type": "object", "description": "Sub Account information", "additionalProperties": false, "properties": { "accountUid": { "type": "string", "description": "SubAccount Id" }, "accountName": { "type": "string", "description": "SubAccount Name" } } }, "SubAccountApiKey": { "type": "object", "description": "Object to manage a sub account's api key", "additionalProperties": false, "properties": { "accountUid": { "type": "string", "description": "SubAccount Id" }, "accountName": { "type": "string", "description": "SubAccount Name" }, "apiKey": { "type": "string", "description": "SubAccount API Key" } } }, "SubAccount": { "allOf": [ { "$ref": "#/components/schemas/Account" }, { "type": "object", "description": "Object to manage a sub account", "additionalProperties": false, "properties": { "parentAccountId": { "type": "string", "description": "The parent account id" }, "language": { "type": "string", "description": "Available options: en, fr, it, ru, es, pt, de, nl, da, el, zh-CN, zh-TW, ja, ko" }, "timezoneId": { "type": "string", "description": "The timezone of the account" } } } ] }, "VirtualRoom": { "type": "object", "description": "Package Virtual Room information.", "additionalProperties": false, "properties": { "video": { "type": "boolean", "description": "Check for Video option." }, "videoRecording": { "type": "boolean", "description": "Check for Video Recording option." }, "startDatetime": { "type": "string", "description": "Virtual Room start date and time.", "format": "date-time" }, "hostUid": { "type": "string", "description": "Unique Virtual Room Host ID." } } }, "Recording": { "type": "object", "description": "Recording information.", "additionalProperties": false, "properties": { "uid": { "type": "string", "description": "Unique Recording ID." }, "fileName": { "type": "string", "description": "Recording file name." }, "creationDate": { "type": "integer", "description": "Recording creation date.", "format": "int32" }, "fileSize": { "type": "string", "description": "Recording file size." }, "fileFormat": { "type": "string", "description": "Recording file format (i.e. mp4)." } } } }, "securitySchemes": { "JWT": { "type": "apiKey", "description": "Provide oauth authentication", "name": "Authorization", "in": "header" } } }, "security": [ { "JWT": [] } ] }