Connectors Reference
Scrive, the Nordic market leader for electronic signatures, offers a growing suite of solutions for document workflows requiring e-signing and identity verification.
|
Status: Preview |
Tier: Premium |
Version: 1.0 |
|
Name |
Summary |
|
WebhookOnDocumentSign (WebhookOnDocumentSignParameterBody body) |
When a document is signed by all signatories |
|
StartAndOnDocumentSign (StartAndOnDocumentSignParameterBody body) |
When a document is signed by all signatories (Start Signing) |
|
WebhookFromTemplateSign (string templateId-dynamic, WebhookFromTemplateSignParameterBody body) |
When a document from template is signed by all signatories |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Gets the fields schema of the selected template
Description: Fetches the fields from a template that can be used to populate the fields of a new document from that template.
Syntax:
ScriveeSign.GetTemplateSchema (string templateID)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
templateID |
string (Select Template) |
Select template to fetch fields from. |
True |
Returns:
Type:GetTemplateSchemaResponse
Summary: Get's the properties schema of the selected template
Description: Fetches the properties fields of a template that can be used to populate the properties of a new document from that template.
Syntax:
ScriveeSign.GetTemplatePropertiesSchema (string templateID)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
templateID |
string (Select Template) |
Select template to fetch properties from. |
True |
Returns:
Type:GetTemplatePropertiesSchemaResponse
Summary: Get Document JSON
Description: Gets the document JSON.
Syntax:
ScriveeSign.GetDocJson ([internal]string Content-Type, GetDocJsonParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Content-Type |
string (Content type) |
Content type of parameter. |
True |
|
|
body |
|
|
True |
Returns:
Type:GetDocJsonResponseDocument JSON
Title: Document JSON
Description: The document JSON
Summary: Get document PDF file contents
Description: Gets the content of the document PDF file.
Syntax:
ScriveeSign.GetDocumentPdfContent ([internal]string Content-Type, GetDocumentPdfContentParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Content-Type |
string (Content Type) |
Content type of parameter. |
True |
|
|
body |
GetDocumentPdfContentParameterBody
|
|
True |
Returns:
Type:string(byte)Document PDF content
Title: Document PDF content
Summary: Create new document from template
Description: Create a new document from the selected template.
Syntax:
ScriveeSign.NewDocumentFromTemplate (string templateId-dynamic)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
templateId-dynamic |
string (Select Template) |
Select template to start a new document from. |
True |
Returns:
Type:stringNew document ID
Title: New document ID
Description: ID of the created document
Summary: Start signing process
Description: Start the signing process for a document.
Syntax:
ScriveeSign.StartSigning ([internal]string Content-Type, StartSigningParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Content-Type |
string (Content Type) |
Content type of parameter. |
True |
|
|
body |
|
|
True |
Returns:
Type:stringDocument ID being signed
Title: Document ID being signed
Description: The document ID being signed
Summary: Gets all the templates you have access to
Description: Fetches all templates for the Scrive e-archive templates.
Syntax:
ScriveeSign.GetTemplates ()
Returns:
Type:array of (GetTemplatesResponseItem)
Summary: Update document JSON
Description: Updates the document JSON with a provided JSON.
Syntax:
ScriveeSign.UpdateDocJson ([internal]string Content-Type, UpdateDocJsonParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Content-Type |
string (Content Type) |
Content type of parameter. |
True |
|
|
body |
|
|
True |
Returns:
Summary: Update fields based on template
Description: Updates party fields based on the selected template.
Syntax:
ScriveeSign.UpdatePartiesFields (string templateID-dynamic, [Optional]UpdatePartiesFieldsParameterDynamicTemplateSchema dynamicTemplateSchema)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
templateID-dynamic |
string (Select Template) |
Select Template you want fields from. |
True |
|
|
dynamicTemplateSchema |
UpdatePartiesFieldsParameterDynamicTemplateSchema
|
|
False |
Returns:
Summary: Update properties of parties based on template
Description: Updates properties based on the selected template.
Syntax:
ScriveeSign.UpdatePartiesProperties (string templateID-dynamic, [Optional]UpdatePartiesPropertiesParameterDynamicTemplateMetaSchema dynamicTemplateMetaSchema)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
templateID-dynamic |
string (Select Template) |
Select template you want the property fields from. |
True |
|
|
dynamicTemplateMetaSchema |
UpdatePartiesPropertiesParameterDynamicTemplateMetaSchema
|
|
False |
Returns:
Summary: Set file for document
Description: Sets the main PDF file for the document.
Syntax:
ScriveeSign.SetFile ([internal]string Content-Type, SetFileParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Content-Type |
string (Content Type) |
Content type of parameter. |
True |
|
|
body |
|
|
True |
Returns:
Type:SetFileResponseDocument JSON
Title: Document JSON
Description: The document JSON
Summary: Create new document from PDF
Description: Creates a document from a PDF file.
Syntax:
ScriveeSign.NewFromPdf ([internal]string Content-Type, NewFromPdfParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Content-Type |
string (Content type) |
Content type of parameter. |
True |
|
|
body |
|
|
True |
Returns:
Type:stringDocument ID
Title: Document ID
Description: Document ID of the created document.
Summary: Add new party
Description: Adds a new party to the document. The party can be a signatory, viewer or approver of the document.
Syntax:
ScriveeSign.AddParty ([internal]string Content-Type, AddPartyParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Content-Type |
string (Content type) |
Content type of parameter. |
True |
|
|
body |
|
|
True |
Returns:
Summary: Gets all the attachments you have access to
Description: Fetches all attachments from the Scrive e-archive.
Syntax:
ScriveeSign.GetAttachments ()
Returns:
Type:array of (GetAttachmentsResponseItem)
Summary: Set attachment
Description: Adds a PDF to a document as an attachment. Choose between existing attachments from your Scrive account or create a new attachment by providing a PDF file.
Syntax:
ScriveeSign.SetAuthorAttachment (SetAuthorAttachmentParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
SetAuthorAttachmentParameterBody
|
|
True |
Returns:
Summary: Deletes a webhook
Description: Deletes a webhook.
Syntax:
ScriveeSign.DeleteWebhook (string webhook_id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
webhook_id |
string (Webhook ID) |
ID of the webhook being deleted. |
True |
Returns:
Summary: When a document is signed by all signatories
Description: Waits for a document to be signed.
Syntax:
ScriveeSign.WebhookOnDocumentSign (WebhookOnDocumentSignParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
WebhookOnDocumentSignParameterBody
|
|
True |
Returns:
Type:stringSigned document ID
Title: Signed document ID
Description: ID of the created document.
Summary: When a document is signed by all signatories (Start Signing)
Description: Starts the signing process for a document and waits for it to be signed.
Syntax:
ScriveeSign.StartAndOnDocumentSign (StartAndOnDocumentSignParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
StartAndOnDocumentSignParameterBody
|
|
True |
Returns:
Type:stringSigned document ID
Title: Signed document ID
Description: ID of the created document.
Summary: When a document from template is signed by all signatories
Description: Watches a template and waits for one of its documents to be signed.
Syntax:
ScriveeSign.WebhookFromTemplateSign (string templateId-dynamic, WebhookFromTemplateSignParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
templateId-dynamic |
string (Select Template) |
Choose template whose documents will trigger the flow when signed. |
True |
|
|
body |
WebhookFromTemplateSignParameterBody
|
|
True |
Returns:
Type:stringSigned document ID
Title: Signed document ID
Description: ID of the triggering document.
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
documentId |
string
|
ID of the document to add the new party to. |
|
partyEmail |
string
|
The email of the new party |
|
partyRole |
string
|
The role of the party in the signing process. Values: [signing_party, viewer, approver] |
|
firstname |
string
|
The firstname of the new party. |
|
lastname |
string
|
The lastname of the new party. |
|
company |
string
|
The company that the new party works with. |
|
mobile |
string
|
The mobile phone number of the new party. |
|
personalNumber |
string
|
The new party's personal number. Used for Swedish, Norwegian, Danish, and Finnish eID. |
|
signOrder |
number
|
The new party's order in the signing process. |
|
deliveryMethod |
string
|
The method of invitation for the new party. Values: [email, mobile, email_mobile, pad, api] |
|
authenticationToView |
string
|
The authentication method needed to view the document. Values: [standard, sms_pin, se_bankid, no_bankid, dk_nemid, fi_tupas, verimi, nl_idin] |
|
authenticationToViewArchived |
string
|
The authentication method needed to view the archived document. Values: [standard, sms_pin, se_bankid, no_bankid, dk_nemid, fi_tupas, verimi, nl_idin] |
|
authenticationToSign |
string
|
The authentication method needed to sign the document. Values: [standard, sms_pin, se_bankid, no_bankid, dk_nemid, fi_tupas, onfido_document_check, onfido_document_and_photo_check] |
|
confirmation |
string
|
Method for sending confirmation. Values: [email, mobile, email_mobile, email_link, email_link_mobile, none] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
|
|
title |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
documentId |
string
|
The ID of the document to get JSON from. |
Summary:
Description: The document JSON
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
documentId |
string
|
The document ID to get the PDF file from. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
|
|
title |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
pdfContent |
string(byte)
|
The file content of the PDF file that will be used for the new document. |
|
authorRole |
string
|
The role of the author in the signing process. Values: [signing_party, viewer] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fileId |
string
|
Select an existing attachment. |
|
documentId |
string
|
The ID of the document to add the attachment to. |
|
attachmentName |
string
|
The name for the attachment. |
|
required |
string
|
Whether or not the attachment will be presented with a mandatory checkmark before signing. Values: [Yes, No] |
|
addToSealedFile |
string
|
Whether or not to include the attachment in the sealed document after signing. Values: [Yes, No] |
|
pdfContent |
string(byte)
|
The PDF file content for the new attachment. Use this OR "Select Attachment". |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
documentId |
string
|
The document ID of the document to update. |
|
pdfContent |
string(byte)
|
The file contents of the new PDF file. |
Summary:
Description: The document JSON
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
documentId |
string
|
ID of document to start and trigger from on signed. |
|
webhookUrl |
string
|
webhookUrl |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
documentId |
string
|
The document ID for the document to start the signing process for. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
documentId |
string
|
Document ID of the document to update. |
|
documentJson |
string
|
The JSON that will be used to update the old one. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
webhookUrl |
string
|
webhookUrl |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
documentId |
string
|
Document ID to trigger on when signed. |
|
webhookUrl |
string
|
webhookUrl |