NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Oksign connects to a Nagent workspace with an API key. Once it is connected, agents can call 17 Oksign actions, such as "Create Editor Express Session", "Get Active Documents" and "Update Organization Token Info". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Oksign, with input parameters and output schema.
OKSIGN_BRIEFCASE_REMOVETool to remove a previously created briefcase from OKSign platform. Use when you need to delete a briefcase that is no longer needed. The briefcase is identified by the token received when it was created.
Input parameters
The briefcase token received when creating a briefcase via the Briefcase.create service. This uniquely identifies the briefcase to be removed.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
OKSIGN_BRIEFCASE_RETRIEVETool to retrieve a previously uploaded briefcase tokeninfo for consultation. Use when you need to examine bundled document properties and signer requirements without re-creating the briefcase.
Input parameters
The briefcase token received when creating a briefcase via the Briefcase.create service. This uniquely identifies the briefcase to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
OKSIGN_CONTACTS_REMOVETool to remove specified contacts from the account's contact list. Use when you need to delete one or more contacts by providing their name and email.
Input parameters
List of contact objects to remove. Each contact must have a name and email field.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
OKSIGN_CONTACTS_RETRIEVETool to retrieve the list of contacts stored in the account. Use when you need to access all contacts with their details including name, email, mobile number, and role.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
OKSIGN_CONTACTS_UPLOADTool to insert or update contact information in the account's contact list. Use when you need to add new contacts or update existing ones with details like name, email, phone, mobile, address, company, or identifier.
Input parameters
List of contact objects to insert or update in the account's contact list. Each contact can have name, email, phone, mobile, address, company, and id fields (all optional).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
OKSIGN_CREDITS_RETRIEVETool to retrieve account credit balance and storage information. Use when you need to check available credits or storage capacity.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
OKSIGN_DOCUMENT_EXISTSTool to check if a signed or unsigned document still exists on the OKSign platform. Use when you need to verify document availability before performing operations.
Input parameters
The document ID to check if it exists on OKSign platform. Example: '670816-483B7F54-8591-DDF9-FA77-9042AED3E8FD'
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
OKSIGN_DOCUMENT_REMOVETool to remove a signed or unsigned document from the OKSign platform. Use when you need to delete a document and its signed copies from storage. Note: If document is removed immediately after signing while platform processes notifications, service may return FAILED status with retry message.
Input parameters
The document identifier received from Document.upload. This is the unique identifier for the document to be removed.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
OKSIGN_DOCUMENT_UPLOADTool to upload a PDF or Word document to OKSign platform for completion and/or signing. Use when you need to add a new document that requires signatures. Maximum file size is 10 MB. Supported formats: PDF, DOC, DOCX.
Input parameters
Document file to upload (PDF or Word).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
OKSIGN_EDITOREXPRESS_CREATETool to invoke the OKSign Editor Express for modifying documents and form descriptors. Use when you need to open documents in an interactive editor where users can add signature fields, form fields, and configure signing workflows. The editor URL returned can be embedded or redirected to within your application.
Input parameters
Array of document IDs to load in the editor for modification. Each ID should be a valid OKSign document identifier.
Show current user as a signer option in the editor. Set to true to include yourself as a signer.
Display team members in the editor interface. Set to true to show team members as options.
Display signing method options in the editor. Set to true to show available signing methods.
Display anonymous signers as options in the editor. Set to true to enable anonymous signer selection.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
OKSIGN_FORMDESC_UPLOADTool to upload form descriptor defining signature fields and other field types to a document. Use when you need to add form fields, signature areas, and configure signing workflows for a document.
Input parameters
URL of logo displayed during signing
Document ID from Document.upload service (passed in x-oksign-docid header)
Array of field objects defining form inputs and signature fields
Email of assigned user in account
Document filename (supports non-ASCII characters)
Whether multiple copies of this document can be signed
Array of signer information objects
Send signed document only to account's email
Email and SMS notification configuration.
Alternative email for signed document
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
OKSIGN_GET_ACTIVE_DOCUMENTSTool to retrieve all active document IDs and properties from OKsign account. Use when you need to list documents visible in the Active Documents tab. Note: Rate limited to 1 request per 3 minutes.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
OKSIGN_LINKED_LIST_RETRIEVETool to retrieve the list of linked signed or source document IDs related to a specific document. Use when you need to find linked documents (either the signed version of a source document, or the source of a signed document).
Input parameters
The document ID to retrieve linked document IDs for (source or signed document). Example: '504054-8D73D624-8EC5-EA1C-B932-8ACB7EF25585'
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
OKSIGN_NOTIFICATIONS_UPLOADTool to upload notifications defining email(s) and/or SMS(es) to be sent to signer(s) with signing links. Use when you need to send notification emails or SMS messages to document signers.
Input parameters
List of signers receiving notifications; if omitted, all signers receive them.
Notification configurations containing smtp and/or sms properties. At least one must be provided.
Document or briefcase token from Document.upload or Briefcase.create. This will be sent as a header.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
OKSIGN_ORG_TOKEN_INFO_UPDATETool to update organizational token information and settings for the account. Use when you need to configure or modify callback URL, webhook URL, or return URL for the organization's token.
Input parameters
Return URL to be linked to the organizational token. Users will be redirected to this URL after completing actions.
Webhook URL to be linked to the organizational token. This URL will receive webhook notifications.
Callback URL to be linked to the organizational token. This URL will be called when specific events occur.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
OKSIGN_SIGNEXPRESS_REMOVETool to remove a previously uploaded SignExpress tokeninfo JSONObject from the OKSign platform. Use when you need to clean up or invalidate a SignExpress token that was created for sign button integration.
Input parameters
Valid token received from SignExpress.create endpoint. Format: 123456-12345678-1234-1234-1234-123456789012
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
OKSIGN_USERS_RETRIEVETool to retrieve the list of users associated with the OkSign account. Use when you need to get all users in an account.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 17 Oksign actions on Nagent, including "Create Editor Express Session", "Get Active Documents" and "Update Organization Token Info". Create Editor Express Session: Invoke the OKSign Editor Express for modifying documents and form descriptors. Each action is listed on this page with its input parameters and its output.
Oksign connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Create Editor Express Session takes 1 required input: list. It also takes 4 optional inputs: show_me_signer, show_teammembers, show_signing_options and show_anonymous_signers. It returns data, error and successful.