Prepare PDF Document

/documents/pdf/prepare

curl -X POST "http://localhost/documents/pdf/prepare"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        Object provider = ; // Object | Token provider id
        Object certificate = ; // Object | Certificate in base64 format
        Object certLabel = ; // Object | Certificate Label
        Object reason = ; // Object | Signing reason
        Object location = ; // Object | Signing location
        Object file = ; // Object | PDF File to be signed
        Object timestamp = ; // Object | Check this if you need to add timestamp to the PDF file
        Object signatureFieldName = ; // Object | Signature Field Name
        Object signaturePage = ; // Object | Signature page, -1 for last page
        Object startX = ; // Object | Signature location, top left
        Object endX = ; // Object | Signature location, bottom left
        Object startY = ; // Object | Signature location, top right
        Object endY = ; // Object | Signature location, bottom right
        try {
            inline_response_200 result = apiInstance.documentsPdfPreparePost(provider, certificate, certLabel, reason, location, file, timestamp, signatureFieldName, signaturePage, startX, endX, startY, endY);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#documentsPdfPreparePost");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        Object provider = ; // Object | Token provider id
        Object certificate = ; // Object | Certificate in base64 format
        Object certLabel = ; // Object | Certificate Label
        Object reason = ; // Object | Signing reason
        Object location = ; // Object | Signing location
        Object file = ; // Object | PDF File to be signed
        Object timestamp = ; // Object | Check this if you need to add timestamp to the PDF file
        Object signatureFieldName = ; // Object | Signature Field Name
        Object signaturePage = ; // Object | Signature page, -1 for last page
        Object startX = ; // Object | Signature location, top left
        Object endX = ; // Object | Signature location, bottom left
        Object startY = ; // Object | Signature location, top right
        Object endY = ; // Object | Signature location, bottom right
        try {
            inline_response_200 result = apiInstance.documentsPdfPreparePost(provider, certificate, certLabel, reason, location, file, timestamp, signatureFieldName, signaturePage, startX, endX, startY, endY);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#documentsPdfPreparePost");
            e.printStackTrace();
        }
    }
}

Parameters

Form parameters

Name

Description

provider*

ObjectToken provider idRequired

certificate*

ObjectCertificate in base64 formatRequired

certLabel*

ObjectCertificate LabelRequired

reason*

ObjectSigning reasonRequired

location*

ObjectSigning locationRequired

file*

ObjectPDF File to be signedRequired

timestamp

ObjectCheck this if you need to add timestamp to the PDF file

signatureFieldName

ObjectSignature Field Name

signaturePage

ObjectSignature page, -1 for last page

startX

ObjectSignature location, top left

endX

ObjectSignature location, bottom left

startY

ObjectSignature location, top right

endY

ObjectSignature location, bottom right

Responses

Status: 200 - Successful response

Schema

{

Successful response

statusCode:integerexample: 200result: {ID: string

Request unique identifier

example: 752360ae-e7d1-4af8-adfc-5418d306ac0ccertificate: string

Certificate in base64 format

example: MIIHOTCCBSGgAwIBAgIRANL9ArzIzI/DA2AUyL2vVcYwDQYJKoZIhvcNAQELBQAwaTELMAkGA1UEBhMCRUcxEzARBgNVBAoTCkZpeGVkIE1pc3IxIDAeBgNVBAsTF0NlcnRpZmljYXRpb24gQXV0aG9yaXR5MSMwIQYDVQQDExpGaXhlZCBNaXNyIENvcnBvcmF0ZSBDQSBHMTAeFw0yMjEyMDYxMjM2NDVaFw0yMzEyMDYyMTU5NTlaMIIBZjELMAkGA1UEBhMCRUcxFzAVBgNVBAgMDtin2YTZgtin2YfYsdipMTowOAYDVfYsdipMTowOAYDVQQKDDHZhdiv2YrYsSDYqtmG2YHZitiw2Ykg4BgNVBAwMMdmF2K/ZitixINiq2YbZgdmK2LDZiSDZgdmK2YPYs9mK2K8g2LPZhNmK2YjYtNmG2LIxNjA0BgNVBAMMLdmF2K3ZhdmI2K8g2KfYrdmF2K8g2YXYrdmF2YjYryDYp9iz2YXYp9i52YrZhDEgMB4GCSqGSIb3DQEJARYRaW5mb0BmZWRpcy5jb20uZWcwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDRdfW4mNjTJnn+SsPjM1dpCYHKyr7N7+PrSaeVSywQthJnpiKovRTW/ZPDokGAMXGi+EHdStK/TSfiNjW7aLDiUzr2X4Ly0JRBjQ6MxURNq+dHJMG5KRlEfEGHpYJHNsWv6pIH1eFFrfD0aWgq367PLlE+7sd5quXUZpVJVQjuSUwCDc7/SAOfWh4YJH0exhnOYs941dK7/xGMDEjbIh2qmQiKvy2BLr2dtffa64yyrxWLmd5MNIiuLkaXwrUL3WFXs1JDxkWlWYqcELOpXVUt3NQWry9OVymh5Kf2mU4okYaX0MTXDGWATPKG9woNj9+spSFP/S0D2IOB20jfMRIvAgMBAAGjggHbMIIB1zAMBgNVHRMBAf8EAjAAMA4GA1UdDwEB/wQEAwI5YzpT5GydBLoe+HuZw26jAdBgNVHQ4EFgQUtgi9oyf+vLTr5MJqew8B6/9KOT4wewYIKwYBBQUHAQEEbzBtMEIGCCsGAQUFBzAChjZodHRwOi8vY2EuZmVkaXMuY29tLmVnL3JlcG8vRml4ZWRNaXNyQ29ycG9yYXRlQ0FHMS5jcnQwJwYIKwYBBQUHMAGGG2h0dHA6Ly9vY3NwLmZlZGlzLmNvbS5lZy92MTBoBgNVHR8EYTBfMCygKqAohiZodHRwOi8vY3JsLmZlZGlzLmNvbS5lZy9yZXBvL0NBLUcxLmNybDAvoC2gK4YpaHR0cDovL3JlcG8uZmVkaXMuY29tLmVnL3B1YmxpYy9DQS1HMS5jcmwwUQYDVR0gAQH/BEcwRTBDBgorBgEEAYPHUwECMDUwMwYIKwYBBQUHAgEWJ2h0dHA6Ly9yZXBvLmZlZGlzLmNvbS5lZy9wdWJsaWMvQ1BTLnBkZjAcBgNVHREEFTATgRFpbmZvQGZlZGlzLmNvbS5lZzANBgkqhkiG9w0BAQsFAAOCAgEABaN40pkO9PPYLzCCvNEf9hSWEt6/DqE7/2VSI5e2rzNYzubADXll7JMOunlDCXKH3mEm2IWMTNU3t9FSPi/F2S1NCJF8Z5GaYhlTY+d9LJgjULFyFPQVXxhsX150z0s54JkYtL/JQvD4/tLZU1GF+OFxE+Tv83e0b1yhvLzxcq/xhJPaqBhyOmijmVurUbRzEV26COgu3gBoJUg6g8pMTvcEYX/vP4GY2XJF/I27tx4LgavTJukri61FcMtWKV1cgr38LzY1H1qD1/pbgRssmHiaLo1+PRRkwkrhE+HtJVUCwnOh3IT2JmgMYnIi5D3XDVLs/4zKA2rN03xa7LDBHq3L45xjKtBLohFVehe0eV1iOpskcjalU4M7LQT4LN0OPsqXgKeoRUeZtcjSSI7+ehOQkg1r+YI879JqvKXqRgT/KEapgBV+QbKOSM9mjiFSekFkDaHpCG5MOoWW8cmdinbSa/PucYslhPAibhPXwRSgAlBgC0YQcCzq+oEzVfxuJa1gUZakZvW/PembsX7yVLQKCNPyfUJ6SmR9Voz3B32dXkP0nByQQzixrr/3MY0p4qb5a04oAr8Pv4+hJuraACK5iziYyXlmV94sqzu8cmKtb3zSg9+0Xvzdd/2Qnszd7Jzwa6AVOFlKFD58ib2jIMVpI8Mm/C2r2Rmq2bHLDr0=hash: string

PDF hash to be signed

example: MYIBDjAYBgkqhkiG9w0BCQMxCwYJKoZID3KqkscYzqvTuegfYUAGH4X0/t/aCTQyfGYPZN1l/TCBwAYLKoZ+nNXXxQFgduGimT3YMIGCMG2kazBpMQswCQYDVQQGEwJFRzETMBEGA1UEChMKRml4ZWQgTWlzcjEgMB4GA1UECxMXQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxIzAhBgNVBAMTGkZpeGVkIE1pc3IgQ29ycG9yYXRlIENBIEcxAhEA0v0CvMjMj8MDYBTIva9Vxg==provider: string

Token provider id

example: 22094919f9f45165a619680163572bfa956421ef86a30f95d429dc77df3e8aab}error:boolean}

Status: 400 - Validation error

Schema

{

Validation error

statusCode:integerexample: 400error:stringexample: Bad Requestmessage:stringexample: position/key should be type}

Status: 410 - Unable to prepare the document

Schema

{

Unable to prepare the document

statusCode:integerexample: 410error:stringexample: Operation Errormessage:stringexample: Unable to prepare the document}

Status: 500 - Internal Server Error

Schema

{

Internal Server Error

statusCode:integerexample: 500error:stringexample: Internal Server Errormessage:stringexample: Something went wrong, please try again later}

Here is an example that lists instructions relevant to specific platforms:

Example

PreviousClient Utility NextFinish PDF Document Signing

Last updated 1 year ago

hashtagParameters

hashtagResponses

hashtagStatus: 200 - Successful response

hashtagStatus: 400 - Validation error

hashtagStatus: 410 - Unable to prepare the document

hashtagStatus: 500 - Internal Server Error

hashtagExample