CadesSignature

post/Api/CadesSignatures/Open

Request

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

Request body

extractEncapsulatedContentboolean
validateboolean
defaultSignaturePolicyIdstring uuid nullable
acceptableExplicitPoliciesstring[] nullable
securityContextIdstring uuid nullable
ignoreRevocationStatusUnknownboolean nullable
trustUncertifiedSigningTimeboolean

Example request

{
  "file": {
    "mimeType": "mimeType",
    "content": "content",
    "url": "url",
    "blobToken": "blobToken"
  },
  "ignoreRevocationStatusUnknown": true,
  "auditPackage": {
    "includeFile": true,
    "generate": true
  },
  "securityContextId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "trustUncertifiedSigningTime": true,
  "dataHashes": [
    {
      "hexValue": "hexValue",
      "value": "value",
      "algorithm": "MD5"
    },
    {
      "hexValue": "hexValue",
      "value": "value",
      "algorithm": "MD5"
    }
  ],
  "extractEncapsulatedContent": true,
  "acceptableExplicitPolicies": [
    "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  ],
  "defaultSignaturePolicyId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "validate": true
}

Response

Success

encapsulatedContentType'Data' | 'SignedData' | 'EnvelopedData' | 'DigestedData' | 'EncryptedData' | 'AuthenticatedData' | 'TstInfo'
hasEncapsulatedContentboolean

Example response

{
  "encapsulatedContentType": "Data",
  "signers": [
    {
      "commitmentType": {
        "name": "name",
        "oid": "oid"
      },
      "certifiedDateReference": "2000-01-23T04:56:07.000+00:00",
      "signaturePolicy": {
        "digest": {
          "hexValue": "hexValue",
          "value": "value",
          "algorithm": "MD5"
        },
        "oid": "oid",
        "uri": "uri"
      },
      "messageDigest": {
        "hexValue": "hexValue",
        "value": "value",
        "algorithm": "MD5"
      },
      "bStamp": {
        "crlsDigests": [
          {
            "hexValue": "hexValue",
            "value": "value",
            "algorithm": "MD5"
          },
          {
            "hexValue": "hexValue",
            "value": "value",
            "algorithm": "MD5"
          }
        ],
        "blockchain": null,
        "signatureDigest": {
          "hexValue": "hexValue",
          "value": "value",
          "algorithm": "MD5"
        },
        "transactionDate": "2000-01-23T04:56:07.000+00:00",
        "certificateDigests": [
          {
            "hexValue": "hexValue",
            "value": "value",
            "algorithm": "MD5"
          },
          {
            "hexValue": "hexValue",
            "value": "value",
            "algorithm": "MD5"
          }
        ],
        "transactionId": "transactionId"
      },
      "validationResults": {
        "passedChecks": [
          {
            "detail": "detail",
            "type": "Success",
            "message": "message",
            "innerValidationResults": null
          },
          {
            "detail": "detail",
            "type": "Success",
            "message": "message",
            "innerValidationResults": null
          }
        ],
        "warnings": [
          {
            "detail": "detail",
            "type": "Success",
            "message": "message",
            "innerValidationResults": null
          },
          {
            "detail": "detail",
            "type": "Success",
            "message": "message",
            "innerValidationResults": null
          }
        ],
        "errors": [
          {
            "detail": "detail",
            "type": "Success",
            "message": "message",
            "innerValidationResults": null
          },
          {
            "detail": "detail",
            "type": "Success",
            "message": "message",
            "innerValidationResults": null
          }
        ]
      },
      "signature": {
        "hexValue": "hexValue",
        "algorithmIdentifier": {
          "algorithm": "MD5WithRSA"
        },
        "value": "value"
      },
      "timestamps": [
        {
          "encapsulatedContentType": null,
          "signers": [
            null,
            null
          ],
          "serialNumber": "serialNumber",
          "encapsulatedContent": {
            "mimeType": "mimeType",
            "content": "content",
            "url": "url",
            "blobToken": "blobToken"
          },
          "bStamp": {
            "documentDigests": [
              {
                "hexValue": "hexValue",
                "value": "value",
                "algorithm": "MD5"
              },
              {
                "hexValue": "hexValue",
                "value": "value",
                "algorithm": "MD5"
              }
            ],
            "blockDate": "2000-01-23T04:56:07.000+00:00",
            "indexDigests": [
              {
                "hexValue": "hexValue",
                "value": "value",
                "algorithm": "MD5"
              },
              {
                "hexValue": "hexValue",
                "value": "value",
                "algorithm": "MD5"
              }
            ],
            "blockchain": "Bitcoin",
            "blockNumber": 0,
            "indexFile": {
              "mimeType": "mimeType",
              "content": "content",
              "url": "url",
              "blobToken": "blobToken"
            },
            "transactionId": "transactionId"
          },
          "messageImprint": {
            "hexValue": "hexValue",
            "value": "value",
            "algorithm": "MD5"
          },
          "auditPackage": {
            "mimeType": "mimeType",
            "content": "content",
            "url": "url",
            "blobToken": "blobToken"
          },
          "hasEncapsulatedContent": true,
          "genTime": "2000-01-23T04:56:07.000+00:00"
        },
        {
          "encapsulatedContentType": null,
          "signers": [
            null,
            null
          ],
          "serialNumber": "serialNumber",
          "encapsulatedContent": {
            "mimeType": "mimeType",
            "content": "content",
            "url": "url",
            "blobToken": "blobToken"
          },
          "bStamp": {
            "documentDigests": [
              {
                "hexValue": "hexValue",
                "value": "value",
                "algorithm": "MD5"
              },
              {
                "hexValue": "hexValue",
                "value": "value",
                "algorithm": "MD5"
              }
            ],
            "blockDate": "2000-01-23T04:56:07.000+00:00",
            "indexDigests": [
              {
                "hexValue": "hexValue",
                "value": "value",
                "algorithm": "MD5"
              },
              {
                "hexValue": "hexValue",
                "value": "value",
                "algorithm": "MD5"
              }
            ],
            "blockchain": "Bitcoin",
            "blockNumber": 0,
            "indexFile": {
              "mimeType": "mimeType",
              "content": "content",
              "url": "url",
              "blobToken": "blobToken"
            },
            "transactionId": "transactionId"
          },
          "messageImprint": {
            "hexValue": "hexValue",
            "value": "value",
            "algorithm": "MD5"
          },
          "auditPackage": {
            "mimeType": "mimeType",
            "content": "content",
            "url": "url",
            "blobToken": "blobToken"
          },
          "hasEncapsulatedContent": true,
          "genTime": "2000-01-23T04:56:07.000+00:00"
        }
      ],
      "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"
            ]
          }
        }
      },
      "signingTime": "2000-01-23T04:56:07.000+00:00"
    },
    {
      "commitmentType": {
        "name": "name",
        "oid": "oid"
      },
      "certifiedDateReference": "2000-01-23T04:56:07.000+00:00",
      "signaturePolicy": {
        "digest": {
          "hexValue": "hexValue",
          "value": "value",
          "algorithm": "MD5"
        },
        "oid": "oid",
        "uri": "uri"
      },
      "messageDigest": {
        "hexValue": "hexValue",
        "value": "value",
        "algorithm": "MD5"
      },
      "bStamp": {
        "crlsDigests": [
          {
            "hexValue": "hexValue",
            "value": "value",
            "algorithm": "MD5"
          },
          {
            "hexValue": "hexValue",
            "value": "value",
            "algorithm": "MD5"
          }
        ],
        "blockchain": null,
        "signatureDigest": {
          "hexValue": "hexValue",
          "value": "value",
          "algorithm": "MD5"
        },
        "transactionDate": "2000-01-23T04:56:07.000+00:00",
        "certificateDigests": [
          {
            "hexValue": "hexValue",
            "value": "value",
            "algorithm": "MD5"
          },
          {
            "hexValue": "hexValue",
            "value": "value",
            "algorithm": "MD5"
          }
        ],
        "transactionId": "transactionId"
      },
      "validationResults": {
        "passedChecks": [
          {
            "detail": "detail",
            "type": "Success",
            "message": "message",
            "innerValidationResults": null
          },
          {
            "detail": "detail",
            "type": "Success",
            "message": "message",
            "innerValidationResults": null
          }
        ],
        "warnings": [
          {
            "detail": "detail",
            "type": "Success",
            "message": "message",
            "innerValidationResults": null
          },
          {
            "detail": "detail",
            "type": "Success",
            "message": "message",
            "innerValidationResults": null
          }
        ],
        "errors": [
          {
            "detail": "detail",
            "type": "Success",
            "message": "message",
            "innerValidationResults": null
          },
          {
            "detail": "detail",
            "type": "Success",
            "message": "message",
            "innerValidationResults": null
          }
        ]
      },
      "signature": {
        "hexValue": "hexValue",
        "algorithmIdentifier": {
          "algorithm": "MD5WithRSA"
        },
        "value": "value"
      },
      "timestamps": [
        {
          "encapsulatedContentType": null,
          "signers": [
            null,
            null
          ],
          "serialNumber": "serialNumber",
          "encapsulatedContent": {
            "mimeType": "mimeType",
            "content": "content",
            "url": "url",
            "blobToken": "blobToken"
          },
          "bStamp": {
            "documentDigests": [
              {
                "hexValue": "hexValue",
                "value": "value",
                "algorithm": "MD5"
              },
              {
                "hexValue": "hexValue",
                "value": "value",
                "algorithm": "MD5"
              }
            ],
            "blockDate": "2000-01-23T04:56:07.000+00:00",
            "indexDigests": [
              {
                "hexValue": "hexValue",
                "value": "value",
                "algorithm": "MD5"
              },
              {
                "hexValue": "hexValue",
                "value": "value",
                "algorithm": "MD5"
              }
            ],
            "blockchain": "Bitcoin",
            "blockNumber": 0,
            "indexFile": {
              "mimeType": "mimeType",
              "content": "content",
              "url": "url",
              "blobToken": "blobToken"
            },
            "transactionId": "transactionId"
          },
          "messageImprint": {
            "hexValue": "hexValue",
            "value": "value",
            "algorithm": "MD5"
          },
          "auditPackage": {
            "mimeType": "mimeType",
            "content": "content",
            "url": "url",
            "blobToken": "blobToken"
          },
          "hasEncapsulatedContent": true,
          "genTime": "2000-01-23T04:56:07.000+00:00"
        },
        {
          "encapsulatedContentType": null,
          "signers": [
            null,
            null
          ],
          "serialNumber": "serialNumber",
          "encapsulatedContent": {
            "mimeType": "mimeType",
            "content": "content",
            "url": "url",
            "blobToken": "blobToken"
          },
          "bStamp": {
            "documentDigests": [
              {
                "hexValue": "hexValue",
                "value": "value",
                "algorithm": "MD5"
              },
              {
                "hexValue": "hexValue",
                "value": "value",
                "algorithm": "MD5"
              }
            ],
            "blockDate": "2000-01-23T04:56:07.000+00:00",
            "indexDigests": [
              {
                "hexValue": "hexValue",
                "value": "value",
                "algorithm": "MD5"
              },
              {
                "hexValue": "hexValue",
                "value": "value",
                "algorithm": "MD5"
              }
            ],
            "blockchain": "Bitcoin",
            "blockNumber": 0,
            "indexFile": {
              "mimeType": "mimeType",
              "content": "content",
              "url": "url",
              "blobToken": "blobToken"
            },
            "transactionId": "transactionId"
          },
          "messageImprint": {
            "hexValue": "hexValue",
            "value": "value",
            "algorithm": "MD5"
          },
          "auditPackage": {
            "mimeType": "mimeType",
            "content": "content",
            "url": "url",
            "blobToken": "blobToken"
          },
          "hasEncapsulatedContent": true,
          "genTime": "2000-01-23T04:56:07.000+00:00"
        }
      ],
      "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"
            ]
          }
        }
      },
      "signingTime": "2000-01-23T04:56:07.000+00:00"
    }
  ],
  "encapsulatedContent": {
    "mimeType": "mimeType",
    "content": "content",
    "url": "url",
    "blobToken": "blobToken"
  },
  "bStamp": {
    "documentDigests": [
      {
        "hexValue": "hexValue",
        "value": "value",
        "algorithm": "MD5"
      },
      {
        "hexValue": "hexValue",
        "value": "value",
        "algorithm": "MD5"
      }
    ],
    "blockDate": "2000-01-23T04:56:07.000+00:00",
    "indexDigests": [
      {
        "hexValue": "hexValue",
        "value": "value",
        "algorithm": "MD5"
      },
      {
        "hexValue": "hexValue",
        "value": "value",
        "algorithm": "MD5"
      }
    ],
    "blockchain": "Bitcoin",
    "blockNumber": 0,
    "indexFile": {
      "mimeType": "mimeType",
      "content": "content",
      "url": "url",
      "blobToken": "blobToken"
    },
    "transactionId": "transactionId"
  },
  "auditPackage": {
    "mimeType": "mimeType",
    "content": "content",
    "url": "url",
    "blobToken": "blobToken"
  },
  "hasEncapsulatedContent": true
}

Changes

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