signProperties (required)

JSON object:

"signProperties": {
    "orderName": "My order name",
    "documentDisplayMode": "interior",
    "showConfirmation": true,
    "showUnderstanding": true,
    "timeoutSeconds": 1800
}

padesSignProperties
(required)

JSON object:

"padesSignProperties": {
    "addVisualSeals": true
}

documents

JSON array of documents to be signed (minimum one).

The document to be signed is represented as a JSON object:

Be aware that very large PDF files, typically files with a large number of images, might give a less than optimal user experience due to the document processing time.

The total package size has no upper limit, but we recommend to keep the total size below 35MB.

"documents": [
{

    "description": "My document",
    "pdf": "JVBER...",
    "pdfSpec:" "PDFA_2B",
    "merchantSealPos": {
        "x": 100,
        "y": 80,
        "page": 1
    },
    "endUserSealPos": {
        "x": 200,
        "y": 80,
        "page": 1
    }
}
]

resultContent

(required)

JSON array of string. Must contain at either padesSignedPdf, or padesAppendix, or both.

The string values will determine the content result when retrieving a completed sign order later:

["padesSignedPdf", "padesAppendix", "documentHash"]

POST [signdoc-baseurl]/signdoc/pades
Request body:

{

    "signProperties": {
        "orderName": "My order name",
        "documentDisplayMode": "interior",
        "showConfirmation": true,
        "showUnderstanding": true
    },
    "padesSignProperties": {
        "addVisualSeals": true
    },
    "documents": [
        {
            "description": "Document to sign",
            "pdf": "JVBER...",
            "endUserOnly": false,
            "merchantSealPos": {
                "x": 20,
                "y": 20,
                "page": 1
            },
            "endUserSealPos": {
                "x": 200,
                "y": 20,
                "page": 1
            }
        },
        {
            "description": "Another document to sign",
            "pdf": "JVBER...",
            "endUserOnly": true
        }
    ],
    "resultContent": [
        "padesSignedPdf",
        "padesAppendix",
        "documentHash"
    ]
}

201 Created

Successfully uploaded PAdES sign order

{
    "sign_id": "4120de56-4391-4e5a-adea-a28e62daac7e"
}

400 Bad request

Could not create order due to error in request. See the "errors"-array in the response for details.

{
    "errors": [
        "Missing field: 'orderName'",
        "Missing field: 'padesSignProperties'",
        "'resultContent' must contain at least one of 'padesSignedPdf' or 'padesAppendix' for PAdES orders"
    ]
}

403 Forbidden

Access token is invalid.

AccessToken is invalid - Please provide reference: AbcDEf if reporting the problem.

201 Created

Successfully uploaded and converted PAdES sign order

conversionWarnings contains an array of warnings that occurred during the conversion.

Possible values are:

•     VISUAL_DIFF("Visual differences in output PDF")
•     COLORANTS("Resolve name collisions of colorants")
•     OCG_REMOVED("Removed optional content groups (layers)")
•     TRANSP_REMOVED("Transparency removed")
•     XMP_REMOVED("Removed non convertible XMP metadata")
•     FONT_SUBST("Font substituted")
•     ACTION_REMOVED( "Removed interactive elements such as actions or annotations")
•     STRUCTURE_REMOVED("Structure removed")

In CURRENT the response will always be DISABLED("PDF conversion is disabled") and  "converted" = false

{
    "sign_id": "6adc9075-5a02-4152-ae26-7cc75da469eb",
    "conversionResults": [
        {
            "conversionId": "d886b218-af9f-4765-a9e1-d819fec6abbe",
            "description": "My order name - 1",
            "converted": true,
            "conversionErrors": [],
            "conversionWarnings": [
                "Visual differences in output PDF",
                "Removed interactive elements such as actions or annotations"
            ]
        },
        {
            "conversionId": "1b4c673a-9d9e-4680-8aa2-810a31d50d8c",
            "description": "My order name - 2",
            "converted": true,
            "conversionErrors": [],
            "conversionWarnings": [
                "Visual differences in output PDF",
                "Removed interactive elements such as actions or annotations"
            ]
        }
    ]
}

400 Bad request

Could not convert order due to error in request. 

Documents that could not be converted will have a list of errors in  conversionErrors.

Possible conversionErrors are:

• CORRUPT("Document is corrupt")
• DOC_SIGNED("Document contains signatures")
• EF_REMOVED("Embedded files removed")
• GENERIC_ERROR("Unknown error")
• DISABLED("PDF conversion is disabled") 

{
    "conversionResults": [
        {
            "conversionId": "90c3803b-5e90-400c-b945-02ce223d65be",
            "description": null,
            "converted": true,
            "conversionErrors": [],
            "conversionWarnings": [
                "Visual differences in output PDF",
                "Removed interactive elements such as actions or annotations"
            ]
        },
        {
            "conversionId": "fe7c3db8-e586-4253-960b-771ba6d170a1",
            "description": null,
            "converted": true,
            "conversionErrors": [],
            "conversionWarnings": [
                "Visual differences in output PDF",
                "Removed interactive elements such as actions or annotations"
            ]
        },
        {
            "conversionId": "d796513c-ae65-4a9b-a3ae-f6652d4f7a2b",
            "description": null,
            "converted": false,
            "conversionErrors": [
                "Document contains signatures"
            ],
            "conversionWarnings": []
        }
    ]
}

403 Forbidden

Access token is invalid.

AccessToken is invalid - Please provide reference: AbcDEf if reporting the problem.

Sign order was found. Returns the order state.

Possible values are:

• ORDER_RECEIVED
• GRABBED_BY_IDP
• GENERATING_MERCHANT_SEALS
• USER_SIGNING
• ADD_DOCUMENT_SECURITY_STORE
• FAILED
• CANCELLED
• SIGN_COMPLETED

{
    "orderState": "ORDER_RECEIVED"
}

Sign order was not found.

This could be caused by timeout or an invalid sign_id.

(empty)

signId can not be empty - Please provide reference: AbcDEf if reporting the problem.

AccessToken is invalid - Please provide reference: AbcDEf if reporting the problem.

Sign order was found.

The claims returned in the signing results depends on the values pass to the resultContent array when creating the order:

description

signId

orderState

orderName

If order is not completed, i.e. order state is not SIGN_COMPLETED, the signing results will be an empty array.

{
    "signingResults": [
        {
            "signedDocumentSha256": "u0XXG...",
            "padesSignedPdf": "JVBER..."
            "padesAppendix": "DQoxMiAw..."
            "description": "My order name - 1",
            "unsignedDocumentSha256": "QJ2y8..."
        }
    ],
    "signId": "4120de56-4391-4e5a-adea-a28e62daac7e",
    "orderName": "My order name",
    "orderState": "SIGN_COMPLETED"
}

Sign order was not found.

This could be caused by timeout or an invalid sign_id.

(empty)

signId can not be empty - Please provide reference: AbcDEf if reporting the problem.

AccessToken is invalid - Please provide reference: AbcDEf if reporting the problem.