PadesSignature

post/Api/PadesSignatures

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /Api/PadesSignatures
  • Auth: none declared

Request body

pdfToSignstring byte required
bypassMarksIfSignedboolean
measurementUnits'Centimeters' | 'PdfPoints'
customSignatureFieldNamestring nullable
certificationLevel'NotCertified' | 'CertifiedFormFilling' | 'CertifiedFormFillingAndAnnotations' | 'CertifiedNoChangesAllowed'
reasonstring nullable
certificatestring byte nullable
signaturePolicyIdstring uuid
securityContextIdstring uuid nullable
callbackArgumentstring nullable
ignoreRevocationStatusUnknownboolean nullable

Example request

{
  "reason": "reason",
  "callbackArgument": "callbackArgument",
  "certificate": "certificate",
  "certificationLevel": "NotCertified",
  "customSignatureFieldName": "customSignatureFieldName",
  "signaturePolicyId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "visualRepresentation": {
    "image": {
      "verticalAlign": "Top",
      "resource": {
        "mimeType": "mimeType",
        "url": "url",
        "content": "content"
      },
      "horizontalAlign": "Left",
      "opacity": 9
    },
    "text": {
      "container": {
        "top": 1.4658129805029452,
        "left": 6.027456183070403,
        "bottom": 5.637376656633329,
        "width": 2.3021358869347655,
        "right": 5.962133916683182,
        "height": 7.061401241503109
      },
      "horizontalAlign": "Left",
      "fontSize": 0.8008281904610115,
      "text": "text",
      "includeSigningTime": true
    },
    "position": {
      "auto": {
        "container": {
          "top": 1.4658129805029452,
          "left": 6.027456183070403,
          "bottom": 5.637376656633329,
          "width": 2.3021358869347655,
          "right": 5.962133916683182,
          "height": 7.061401241503109
        },
        "signatureRectangleSize": {
          "width": 4.145608029883936,
          "height": 2.027123023002322
        },
        "horizontalDirection": "LeftToRight",
        "verticalDirection": "TopDown",
        "rowSpacing": 7.386281948385884
      },
      "pageNumber": 3,
      "pageOptimization": {
        "pageOrientation": "Auto",
        "customPaperSize": {
          "width": 4.145608029883936,
          "height": 2.027123023002322
        },
        "paperSize": "Custom"
      },
      "manual": {
        "top": 1.4658129805029452,
        "left": 6.027456183070403,
        "bottom": 5.637376656633329,
        "width": 2.3021358869347655,
        "right": 5.962133916683182,
        "height": 7.061401241503109
      },
      "measurementUnits": "Centimeters"
    }
  },
  "ignoreRevocationStatusUnknown": true,
  "pdfToSign": "pdfToSign",
  "bypassMarksIfSigned": true,
  "securityContextId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "pageOptimization": {
    "pageOrientation": "Auto",
    "customPaperSize": {
      "width": 4.145608029883936,
      "height": 2.027123023002322
    },
    "paperSize": "Custom"
  },
  "measurementUnits": null,
  "pdfMarks": [
    {
      "container": {
        "top": 1.4658129805029452,
        "left": 6.027456183070403,
        "bottom": 5.637376656633329,
        "width": 2.3021358869347655,
        "right": 5.962133916683182,
        "height": 7.061401241503109
      },
      "borderColor": {
        "red": 1,
        "green": 1,
        "blue": 6,
        "alpha": 7.457744773683766
      },
      "backgroundColor": {
        "red": 1,
        "green": 1,
        "blue": 6,
        "alpha": 7.457744773683766
      },
      "pageOptionNumber": 9,
      "borderWidth": 1.2315135367772556,
      "elements": [
        {
          "image": {
            "resource": {
              "mimeType": "mimeType",
              "url": "url",
              "content": "content"
            },
            "opacity": 5.025004791520295
          },
          "verticalAlign": null,
          "qrCodeData": "qrCodeData",
          "qrCodeDrawQuietZones": true,
          "rotation": 1,
          "textSections": [
            {
              "color": {
                "red": 1,
                "green": 1,
                "blue": 6,
                "alpha": 7.457744773683766
              },
              "style": "Normal",
              "fontSize": 4.965218492984954,
              "text": "text"
            },
            {
              "color": {
                "red": 1,
                "green": 1,
                "blue": 6,
                "alpha": 7.457744773683766
              },
              "style": "Normal",
              "fontSize": 4.965218492984954,
              "text": "text"
            }
          ],
          "relativeContainer": {
            "top": 1.4658129805029452,
            "left": 6.027456183070403,
            "bottom": 5.637376656633329,
            "width": 2.3021358869347655,
            "right": 5.962133916683182,
            "height": 7.061401241503109
          },
          "align": null,
          "opacity": 9.965781217890562,
          "elementType": "Text"
        },
        {
          "image": {
            "resource": {
              "mimeType": "mimeType",
              "url": "url",
              "content": "content"
            },
            "opacity": 5.025004791520295
          },
          "verticalAlign": null,
          "qrCodeData": "qrCodeData",
          "qrCodeDrawQuietZones": true,
          "rotation": 1,
          "textSections": [
            {
              "color": {
                "red": 1,
                "green": 1,
                "blue": 6,
                "alpha": 7.457744773683766
              },
              "style": "Normal",
              "fontSize": 4.965218492984954,
              "text": "text"
            },
            {
              "color": {
                "red": 1,
                "green": 1,
                "blue": 6,
                "alpha": 7.457744773683766
              },
              "style": "Normal",
              "fontSize": 4.965218492984954,
              "text": "text"
            }
          ],
          "relativeContainer": {
            "top": 1.4658129805029452,
            "left": 6.027456183070403,
            "bottom": 5.637376656633329,
            "width": 2.3021358869347655,
            "right": 5.962133916683182,
            "height": 7.061401241503109
          },
          "align": null,
          "opacity": 9.965781217890562,
          "elementType": "Text"
        }
      ],
      "pageOption": "AllPages"
    },
    {
      "container": {
        "top": 1.4658129805029452,
        "left": 6.027456183070403,
        "bottom": 5.637376656633329,
        "width": 2.3021358869347655,
        "right": 5.962133916683182,
        "height": 7.061401241503109
      },
      "borderColor": {
        "red": 1,
        "green": 1,
        "blue": 6,
        "alpha": 7.457744773683766
      },
      "backgroundColor": {
        "red": 1,
        "green": 1,
        "blue": 6,
        "alpha": 7.457744773683766
      },
      "pageOptionNumber": 9,
      "borderWidth": 1.2315135367772556,
      "elements": [
        {
          "image": {
            "resource": {
              "mimeType": "mimeType",
              "url": "url",
              "content": "content"
            },
            "opacity": 5.025004791520295
          },
          "verticalAlign": null,
          "qrCodeData": "qrCodeData",
          "qrCodeDrawQuietZones": true,
          "rotation": 1,
          "textSections": [
            {
              "color": {
                "red": 1,
                "green": 1,
                "blue": 6,
                "alpha": 7.457744773683766
              },
              "style": "Normal",
              "fontSize": 4.965218492984954,
              "text": "text"
            },
            {
              "color": {
                "red": 1,
                "green": 1,
                "blue": 6,
                "alpha": 7.457744773683766
              },
              "style": "Normal",
              "fontSize": 4.965218492984954,
              "text": "text"
            }
          ],
          "relativeContainer": {
            "top": 1.4658129805029452,
            "left": 6.027456183070403,
            "bottom": 5.637376656633329,
            "width": 2.3021358869347655,
            "right": 5.962133916683182,
            "height": 7.061401241503109
          },
          "align": null,
          "opacity": 9.965781217890562,
          "elementType": "Text"
        },
        {
          "image": {
            "resource": {
              "mimeType": "mimeType",
              "url": "url",
              "content": "content"
            },
            "opacity": 5.025004791520295
          },
          "verticalAlign": null,
          "qrCodeData": "qrCodeData",
          "qrCodeDrawQuietZones": true,
          "rotation": 1,
          "textSections": [
            {
              "color": {
                "red": 1,
                "green": 1,
                "blue": 6,
                "alpha": 7.457744773683766
              },
              "style": "Normal",
              "fontSize": 4.965218492984954,
              "text": "text"
            },
            {
              "color": {
                "red": 1,
                "green": 1,
                "blue": 6,
                "alpha": 7.457744773683766
              },
              "style": "Normal",
              "fontSize": 4.965218492984954,
              "text": "text"
            }
          ],
          "relativeContainer": {
            "top": 1.4658129805029452,
            "left": 6.027456183070403,
            "bottom": 5.637376656633329,
            "width": 2.3021358869347655,
            "right": 5.962133916683182,
            "height": 7.061401241503109
          },
          "align": null,
          "opacity": 9.965781217890562,
          "elementType": "Text"
        }
      ],
      "pageOption": "AllPages"
    }
  ]
}

Response

Created

tokenstring nullable
toSignDatastring byte nullable
toSignHashstring byte nullable
digestAlgorithmOidstring nullable

Example response

{
  "toSignHash": "toSignHash",
  "digestAlgorithmOid": "digestAlgorithmOid",
  "toSignData": "toSignData",
  "certificate": {
    "serialNumber": "serialNumber",
    "issuerName": {
      "country": "country",
      "commonName": "commonName",
      "serialNumber": "serialNumber",
      "initials": "initials",
      "dnString": "dnString",
      "givenName": "givenName",
      "locality": "locality",
      "organizationUnit": "organizationUnit",
      "title": "title",
      "pseudonym": "pseudonym",
      "emailAddress": "emailAddress",
      "dnQualifier": "dnQualifier",
      "stateName": "stateName",
      "surname": "surname",
      "organization": "organization",
      "generationQualifier": "generationQualifier",
      "allValues": {
        "key": [
          "allValues",
          "allValues"
        ]
      }
    },
    "validityEnd": "2000-01-23T04:56:07.000+00:00",
    "thumbprint": "thumbprint",
    "pkiBrazil": {
      "rgEmissor": "rgEmissor",
      "oabNumero": "oabNumero",
      "rgNumero": "rgNumero",
      "companyName": "companyName",
      "cpf": "cpf",
      "oabUF": "oabUF",
      "dateOfBirth": "dateOfBirth",
      "rgEmissorUF": "rgEmissorUF",
      "cnpj": "cnpj",
      "responsavel": "responsavel",
      "certificateType": "Unknown"
    },
    "validityStart": "2000-01-23T04:56:07.000+00:00",
    "issuer": null,
    "binaryThumbprintSHA256": "binaryThumbprintSHA256",
    "emailAddress": "emailAddress",
    "pkiItaly": {
      "idCarta": "idCarta",
      "codiceFiscale": "codiceFiscale",
      "certificateType": "Undefined"
    },
    "organizationIdentifier": "organizationIdentifier",
    "issuerDisplayName": "issuerDisplayName",
    "organization": "organization",
    "subjectIdentifier": "subjectIdentifier",
    "subjectCommonName": "subjectCommonName",
    "thumbprintSHA256": "thumbprintSHA256",
    "subjectDisplayName": "subjectDisplayName",
    "subjectName": {
      "country": "country",
      "commonName": "commonName",
      "serialNumber": "serialNumber",
      "initials": "initials",
      "dnString": "dnString",
      "givenName": "givenName",
      "locality": "locality",
      "organizationUnit": "organizationUnit",
      "title": "title",
      "pseudonym": "pseudonym",
      "emailAddress": "emailAddress",
      "dnQualifier": "dnQualifier",
      "stateName": "stateName",
      "surname": "surname",
      "organization": "organization",
      "generationQualifier": "generationQualifier",
      "allValues": {
        "key": [
          "allValues",
          "allValues"
        ]
      }
    }
  },
  "token": "token"
}

Changes

No recorded changes to this operation across all 1 revision of this API.