Oksign
oksignSign online contracts, purchase orders, forms, you name it. Simple and legal.
Acciones disponibles (17)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Remove BriefcaseOKSIGN_BRIEFCASE_REMOVEAcciónTool 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.
OKSIGN_BRIEFCASE_REMOVEAcciónTool 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.
Parámetros de entrada
docidstringObligatorioThe briefcase token received when creating a briefcase via the Briefcase.create service. This uniquely identifies the briefcase to be removed.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve Briefcase InformationOKSIGN_BRIEFCASE_RETRIEVEAcciónTool 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.
OKSIGN_BRIEFCASE_RETRIEVEAcciónTool 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.
Parámetros de entrada
docidstringObligatorioThe briefcase token received when creating a briefcase via the Briefcase.create service. This uniquely identifies the briefcase to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Remove ContactsOKSIGN_CONTACTS_REMOVEAcciónTool 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.
OKSIGN_CONTACTS_REMOVEAcciónTool 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.
Parámetros de entrada
contactsobject[]ObligatorioList of contact objects to remove. Each contact must have a name and email field.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve ContactsOKSIGN_CONTACTS_RETRIEVEAcciónTool 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.
OKSIGN_CONTACTS_RETRIEVEAcciónTool 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.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Upload ContactsOKSIGN_CONTACTS_UPLOADAcciónTool 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.
OKSIGN_CONTACTS_UPLOADAcciónTool 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.
Parámetros de entrada
contactsobject[]ObligatorioList 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).
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve Account CreditsOKSIGN_CREDITS_RETRIEVEAcciónTool to retrieve account credit balance and storage information. Use when you need to check available credits or storage capacity.
OKSIGN_CREDITS_RETRIEVEAcciónTool to retrieve account credit balance and storage information. Use when you need to check available credits or storage capacity.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Check Document ExistsOKSIGN_DOCUMENT_EXISTSAcciónTool 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.
OKSIGN_DOCUMENT_EXISTSAcciónTool 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.
Parámetros de entrada
doc_idstringObligatorioThe document ID to check if it exists on OKSign platform. Example: '670816-483B7F54-8591-DDF9-FA77-9042AED3E8FD'
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Remove DocumentOKSIGN_DOCUMENT_REMOVEAcciónTool 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.
OKSIGN_DOCUMENT_REMOVEAcciónTool 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.
Parámetros de entrada
doc_idstringObligatorioThe document identifier received from Document.upload. This is the unique identifier for the document to be removed.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Upload DocumentOKSIGN_DOCUMENT_UPLOADAcciónTool 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.
OKSIGN_DOCUMENT_UPLOADAcciónTool 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.
Parámetros de entrada
documentobjectObligatorioDocument file to upload (PDF or Word). FileUploadable object where 'name' is the filename to use in OKSign, e.g., 'contract.pdf' or 'agreement.docx'.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Editor Express SessionOKSIGN_EDITOREXPRESS_CREATEAcciónTool 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.
OKSIGN_EDITOREXPRESS_CREATEAcciónTool 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.
Parámetros de entrada
liststring[]ObligatorioArray of document IDs to load in the editor for modification. Each ID should be a valid OKSign document identifier.
show_me_signerbooleanShow current user as a signer option in the editor. Set to true to include yourself as a signer.
show_teammembersbooleanDisplay team members in the editor interface. Set to true to show team members as options.
show_signing_optionsbooleanDisplay signing method options in the editor. Set to true to show available signing methods.
show_anonymous_signersbooleanDisplay anonymous signers as options in the editor. Set to true to enable anonymous signer selection.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Upload Form DescriptorOKSIGN_FORMDESC_UPLOADAcciónTool 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.
OKSIGN_FORMDESC_UPLOADAcciónTool 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.
Parámetros de entrada
logostringURL of logo displayed during signing
docidstringObligatorioDocument ID from Document.upload service (passed in x-oksign-docid header)
fieldsobject[]ObligatorioArray of field objects defining form inputs and signature fields
assigntostringEmail of assigned user in account
filenamestringDocument filename (supports non-ASCII characters)
reusablebooleanObligatorioWhether multiple copies of this document can be signed
signersinfoobject[]ObligatorioArray of signer information objects
sendtomeonlybooleanSend signed document only to account's email
notificationsobjectEmail and SMS notification configuration.
sendtomeemailstringAlternative email for signed document
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Active DocumentsOKSIGN_GET_ACTIVE_DOCUMENTSAcciónTool 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.
OKSIGN_GET_ACTIVE_DOCUMENTSAcciónTool 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.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve Linked Document ListOKSIGN_LINKED_LIST_RETRIEVEAcciónTool 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).
OKSIGN_LINKED_LIST_RETRIEVEAcciónTool 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).
Parámetros de entrada
doc_idstringObligatorioThe document ID to retrieve linked document IDs for (source or signed document). Example: '504054-8D73D624-8EC5-EA1C-B932-8ACB7EF25585'
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Upload NotificationsOKSIGN_NOTIFICATIONS_UPLOADAcciónTool 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.
OKSIGN_NOTIFICATIONS_UPLOADAcciónTool 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.
Parámetros de entrada
signersinfoobject[]List of signers receiving notifications; if omitted, all signers receive them.
notificationsobjectObligatorioNotification configurations containing smtp and/or sms properties. At least one must be provided.
x-oksign-docidstringObligatorioDocument or briefcase token from Document.upload or Briefcase.create. This will be sent as a header.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Organization Token InfoOKSIGN_ORG_TOKEN_INFO_UPDATEAcciónTool 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.
OKSIGN_ORG_TOKEN_INFO_UPDATEAcciónTool 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.
Parámetros de entrada
returnurlstringReturn URL to be linked to the organizational token. Users will be redirected to this URL after completing actions.
webhookurlstringWebhook URL to be linked to the organizational token. This URL will receive webhook notifications.
callbackurlstringCallback URL to be linked to the organizational token. This URL will be called when specific events occur.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Remove SignExpress TokenOKSIGN_SIGNEXPRESS_REMOVEAcciónTool 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.
OKSIGN_SIGNEXPRESS_REMOVEAcciónTool 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.
Parámetros de entrada
x-oksign-tokenstringObligatorioValid token received from SignExpress.create endpoint. Format: 123456-12345678-1234-1234-1234-123456789012
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve UsersOKSIGN_USERS_RETRIEVEAcciónTool to retrieve the list of users associated with the OkSign account. Use when you need to get all users in an account.
OKSIGN_USERS_RETRIEVEAcciónTool to retrieve the list of users associated with the OkSign account. Use when you need to get all users in an account.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not