Documents

Retrieves the full information about each of a document's signers

get/api/documents/{id}/signers

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/documents/{id}/signers
  • Auth: none declared

Path parameters

idstring uuid required

Response

Success

signingTimestring date-time nullable
certifiedDateReferencestring date-time nullable
isDocumentTimestampboolean
signatureFieldNamestring nullable
hasLtvboolean nullable
xmlSignedEntityType'FullXml' | 'XmlElement' | 'DetachedResource'
datestring date-time

Example response

[
  {
    "xmlSignedEntityType": "FullXml",
    "date": "2000-01-23T04:56:07.000+00:00",
    "signatureFieldName": "signatureFieldName",
    "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",
    "hasLtv": true,
    "certifiedDateReference": "2000-01-23T04:56:07.000+00:00",
    "xmlSignedElement": {
      "localName": "localName",
      "attributes": [
        {
          "localName": "localName",
          "namespaceUri": "namespaceUri",
          "value": "value"
        },
        {
          "localName": "localName",
          "namespaceUri": "namespaceUri",
          "value": "value"
        }
      ],
      "namespaceUri": "namespaceUri"
    },
    "signaturePolicy": {
      "digest": {
        "hexValue": "hexValue",
        "value": "value",
        "algorithm": "MD5"
      },
      "oid": "oid",
      "uri": "uri"
    },
    "messageDigest": {
      "hexValue": "hexValue",
      "value": "value",
      "algorithm": "MD5"
    },
    "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
        }
      ]
    },
    "isDocumentTimestamp": true,
    "attributeCertificates": [
      {
        "holderName": {
          "otherName": {
            "displayHtml": "displayHtml",
            "typeId": "typeId",
            "encoded": "encoded"
          },
          "choice": "OtherName",
          "uri": "uri",
          "directoryName": {
            "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"
              ]
            }
          }
        },
        "holderDisplayName": "holderDisplayName",
        "validityEnd": "2000-01-23T04:56:07.000+00:00",
        "issuerDisplayName": "issuerDisplayName",
        "attributes": [
          {
            "role": {
              "authority": [
                {
                  "otherName": {
                    "displayHtml": "displayHtml",
                    "typeId": "typeId",
                    "encoded": "encoded"
                  },
                  "choice": "OtherName",
                  "uri": "uri",
                  "directoryName": {
                    "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"
                      ]
                    }
                  }
                },
                {
                  "otherName": {
                    "displayHtml": "displayHtml",
                    "typeId": "typeId",
                    "encoded": "encoded"
                  },
                  "choice": "OtherName",
                  "uri": "uri",
                  "directoryName": {
                    "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"
                      ]
                    }
                  }
                }
              ],
              "name": "name",
              "alias": "alias"
            },
            "type": "Role"
          },
          {
            "role": {
              "authority": [
                {
                  "otherName": {
                    "displayHtml": "displayHtml",
                    "typeId": "typeId",
                    "encoded": "encoded"
                  },
                  "choice": "OtherName",
                  "uri": "uri",
                  "directoryName": {
                    "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"
                      ]
                    }
                  }
                },
                {
                  "otherName": {
                    "displayHtml": "displayHtml",
                    "typeId": "typeId",
                    "encoded": "encoded"
                  },
                  "choice": "OtherName",
                  "uri": "uri",
                  "directoryName": {
                    "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"
                      ]
                    }
                  }
                }
              ],
              "name": "name",
              "alias": "alias"
            },
            "type": "Role"
          }
        ],
        "holderCertificateSerialNumber": "holderCertificateSerialNumber",
        "validityStart": "2000-01-23T04:56:07.000+00:00",
        "holderType": "EntityName",
        "issuer": {
          "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"
            ]
          }
        }
      },
      {
        "holderName": {
          "otherName": {
            "displayHtml": "displayHtml",
            "typeId": "typeId",
            "encoded": "encoded"
          },
          "choice": "OtherName",
          "uri": "uri",
          "directoryName": {
            "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"
              ]
            }
          }
        },
        "holderDisplayName": "holderDisplayName",
        "validityEnd": "2000-01-23T04:56:07.000+00:00",
        "issuerDisplayName": "issuerDisplayName",
        "attributes": [
          {
            "role": {
              "authority": [
                {
                  "otherName": {
                    "displayHtml": "displayHtml",
                    "typeId": "typeId",
                    "encoded": "encoded"
                  },
                  "choice": "OtherName",
                  "uri": "uri",
                  "directoryName": {
                    "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"
                      ]
                    }
                  }
                },
                {
                  "otherName": {
                    "displayHtml": "displayHtml",
                    "typeId": "typeId",
                    "encoded": "encoded"
                  },
                  "choice": "OtherName",
                  "uri": "uri",
                  "directoryName": {
                    "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"
                      ]
                    }
                  }
                }
              ],
              "name": "name",
              "alias": "alias"
            },
            "type": "Role"
          },
          {
            "role": {
              "authority": [
                {
                  "otherName": {
                    "displayHtml": "displayHtml",
                    "typeId": "typeId",
                    "encoded": "encoded"
                  },
                  "choice": "OtherName",
                  "uri": "uri",
                  "directoryName": {
                    "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"
                      ]
                    }
                  }
                },
                {
                  "otherName": {
                    "displayHtml": "displayHtml",
                    "typeId": "typeId",
                    "encoded": "encoded"
                  },
                  "choice": "OtherName",
                  "uri": "uri",
                  "directoryName": {
                    "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"
                      ]
                    }
                  }
                }
              ],
              "name": "name",
              "alias": "alias"
            },
            "type": "Role"
          }
        ],
        "holderCertificateSerialNumber": "holderCertificateSerialNumber",
        "validityStart": "2000-01-23T04:56:07.000+00:00",
        "holderType": "EntityName",
        "issuer": {
          "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"
            ]
          }
        }
      }
    ]
  }
]

Changes

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