Fair API Pricing

    No Surprise Fees

    Secure Your Document Distribution and Management with a Signority API Plan

    Home
    Home
    Quick Navigation
    Getting Started
    Getting Started
    Quick Start
    Testing
    Authentication
    Charging and Rate Limits
    API Reference
    API Reference
    Callbacks
    Constants
    Examples
    Examples
    Integration Examples
    Sample Code
    Anchor Tags
    Use Cases
    Use Cases
    Frequently Asked Questions
    Frequently Asked Questions
    Further Support

    Create a Document

    POST: /v1/documents

    Description
    Creates a new blank document for the authenticated user

     

    Format
    JSON <multipart/related>

     

    URL Parameters
    None

     

    Data Parameters

    Field Mandatory Type Description
    title  Yes String  The name of the document
    senderName Yes String The sender name shown on the invitation email and UI
    senderEmail Yes String Email address shown in the invitation email
    signingStatus Yes Integer 52 : system will send the invitation out to the recipients.
    51 : system will not send the invitation
    SIGNING_STATUS_DRAFT = 51
    SIGNING_STATUS_IN_PROGRESS = 52
    SIGNING_STATUS_COMPLETED = 53
    SIGNING_STATUS_REJECTED = 54
    documentType Yes  Integer DOCUMENT_TYPE_DOCUMENT = 5
    DOCUMENT_TYPE_TEMPLATE_LINK = 6
    DOCUMENT_TYPE_REGULAR_TEMPLATE = 7
    DOCUMENT_TYPE_BULK_TEMPLATE = 8
    hsmDigitalSignEnabled No Boolean If set to True, the document signing will use digital signature.
    If set to False, the document signing will not use digital signature.
    postBackUrl No String Call back URL is used to receive the notification of Document & the finalized documents
    invitations No JSONArray Array of invitation objects
    id Integer Unique identifier for the invitation
    recipientName String Signer’s name showed on UI
    recipientEmail String Email used to receive and send invitation and notification
    actionType Integer INVITATION_TYPE_SIGNER = 15;
    INVITATION_TYPE_VIEWER = 16;
    INVITATION_TYPE_REVIEWER = 17;
    INVITATION_TYPE_SIGNING_HOST = 18;
    INVITATION_TYPE_OPEN_SIGNER = 21;
    status Integer RECIPIENT_STATUS_NOT_SENT = 60;
    RECIPIENT_STATUS_WAIT_TO_OPEN = 61;
    RECIPIENT_STATUS_REACH_DEADLINE = 62;
    RECIPIENT_STATUS_WORK_IN_PROGRESS = 63;
    RECIPIENT_STATUS_VIEWED = 64;
    RECIPIENT_STATUS_RECIPIENT_REJECTED = 65;
    RECIPIENT_STATUS_FINALIZED = 67;
    RECIPIENT_STATUS_CANCELED = 68;
    sequence Integer The sequence that the invitee should follow

    Response
    Response returns a response containing the information about the document that was created or an error

     

    Response Parameters

    Field Mandatory Type Description
    success Yes Boolean True if the request was successful, False otherwise
    deleted Yes Boolean True if the document is deleted, false otherwise
    documentType Yes  Integer See above table
    hasBouncedEmails Yes  Boolean True if the document contains invitations that were sent to another user to sign
    isPublished Yes  Boolean Applies for template links, True if the template is published
    signerCount Yes Integer Number of invited signers
    signingStatus Yes Integer See table above for status codes

    EXAMPLE REQUEST / RESPONSE (Python)
    Request:
data =
{"documents": [
            "title": "API Test document 001",
            "senderName": "Python User 27",
            "senderEmail": "pythonuser27@mail.com",
            "signingStatus": 51,
            "documentType": 8,
            "invitations": [
                {
                    "id": -1,
                    "recipientName": "Python Recipient",
                    "recipientEmail": "pythonrecip@mail.com",
                    "actionType": 15,
                    "status": 60,
                    "sequence": 1
                }
            ]
        }
    ]
}
requests.post("https://sign.signority.com/api/v1/documents/array", data=data, auth=(apiKey, ""))
Response:
{
 'documents': [
 {
 'GUID': 'afaf5ec8-183a-418a-866b-19e9cd781197',
 'createdTime': 1590588787473,
 'deleted': False,
 'documentSentTime': 1590588787473,
 'documentType': 5,
 'folderId': -5,
 'hasBouncedEmails': False,
 'id': 27437,
 'isPublished': False,
 'lastModifiedTime': 1590588787543,
 'pkiEnabled': False,
 'sharedToTeam': False,
 'signerCount': 1,
 'signingStatus': 51,
 'title': 'API Test document 001',
 'user':
 {
 'id': 1354
 },
 'version': 1
 }],
 'returnedAllDocumentsOfFolder': False,
 'success': True
}