GlobalSign DSS API documentation version v2.6

https://emea.api.dss.globalsign.com:8443/v2

GlobalSign Document Signing Solution API

/login

post

post

Login to obtain a JWT token for authentication on further requests

Login to obtain a JWT token for authentication on further requests

Headers

  • Content-Type: required(string - pattern: ^application/json;charset=utf-8$)

    Request Content-Type

  • Content-Length: required(integer - minimum: 1)

    Length of the request in bytes

  • X-SSL-Client-Serial: (string)

    SSL Client Certificate serial number

Body

Media type: application/json;charset=utf-8

Type: object

Properties
  • api_key: required(string - pattern: ^[A-Fa-f0-9]{16}$)
  • api_secret: required(string - pattern: ^[A-Fa-f0-9]{40}$)

Example:

{
  "api_key": "e510e289e6cd8947",
  "api_secret": "a477a8393d17a55ecb2ba6a61f58feb84770b621"
}

HTTP status code 200

Authentication was successful

Headers

  • Authorization: required(string)

    The Authorization header

    Example:

    Bearer eyJhbGciOiAiSFMyNTYiLCAidHlwIjogIkpXVCJ9.eyJ1c2VyX2lkIjogMX0.BSf1w1blYKcbxVlyOtUogUsozH2clY34xxYPd8lQIlQ

Body

Media type: application/json;charset=utf-8

Type: object

Properties
  • access_token: required(string)

Example:

{
  "access_token": "eyJhbGciOiAiSFMyNTYiLCAidHlwIjogIkpXVCJ9.eyJ1c2VyX2lkIjogMX0.BSf1w1blYKcbxVlyOtUogUsozH2clY34xxYPd8lQIlQ"
}

HTTP status code 400

Request could not be parsed

Body

Media type: application/problem+json;charset=utf-8

Type: object

Properties
  • description: required(string)
  • id: (string)
  • errors: (object)

    key value error type

    • /^.+$/: required(string)

      key is the error type, and value contains error details

Example:

{
  "description": "Bad Request"
}

HTTP status code 401

Returned on unsuccessful authentication

Body

Media type: application/problem+json;charset=utf-8

Type: object

Properties
  • description: required(string)
  • id: (string)
  • errors: (object)

    key value error type

    • /^.+$/: required(string)

      key is the error type, and value contains error details

Example:

{
  "description": "Unauthorized"
}

HTTP status code 411

Request Content-Length is absent or 0

Body

Media type: application/problem+json;charset=utf-8

Type: object

Properties
  • description: required(string)
  • id: (string)
  • errors: (object)

    key value error type

    • /^.+$/: required(string)

      key is the error type, and value contains error details

Example:

{
  "description": "Content-Length required"
}

HTTP status code 415

Request content type is not application/json;charset=utf-8

Body

Media type: application/problem+json;charset=utf-8

Type: object

Properties
  • description: required(string)
  • id: (string)
  • errors: (object)

    key value error type

    • /^.+$/: required(string)

      key is the error type, and value contains error details

Example:

{
  "description": "Bad Content-Type"
}

HTTP status code 422

Malformed authentication request

Body

Media type: application/problem+json;charset=utf-8

Type: object

Properties
  • description: required(string)
  • id: (string)
  • errors: (object)

    key value error type

    • /^.+$/: required(string)

      key is the error type, and value contains error details

Example:

{
  "description": "Invalid credentials"
}

HTTP status code 503

System temporarily cannot process the request

Body

Media type: application/problem+json;charset=utf-8

Type: object

Properties
  • description: required(string)
  • id: (string)
  • errors: (object)

    key value error type

    • /^.+$/: required(string)

      key is the error type, and value contains error details

Example:

{
  "description": "Service busy, please retry later",
  "id": "0vqe8FWeDe4DQ7rU7wbzzGmPc4B"
}

/identity

post

post

Submit a request for a signing identity

Submit a request for a signing identity

Headers

  • Authorization: required(string)

    The Authorization header. Only "Bearer" is supported

    Example:

    Bearer eyJhbGciOiAiSFMyNTYiLCAidHlwIjogIkpXVCJ9.eyJ1c2VyX2lkIjogMX0.BSf1w1blYKcbxVlyOtUogUsozH2clY34xxYPd8lQIlQ
  • Content-Type: required(string - pattern: ^application/json;charset=utf-8$)

    Request Content-Type

  • Content-Length: required(integer - minimum: 1)

    Length of the request in bytes

Body

Media type: application/json;charset=utf-8

Type: object

Properties
  • subject_dn: required(object)

    List of Distinguished Name attributes to include in the certificate. See RFC 5280#4.1.2.6

    • country: (string - minLength: 2 - maxLength: 2 - pattern: ^[A-Z]{2}$)

      Format: PrintableString, ISO 3166-1 alpha-2 two-letter country code

    • state: (string - maxLength: 128)

      Format: UTF8String or PrintableString

    • locality: (string - maxLength: 128)

      Format: UTF8String or PrintableString

    • street_address: (string - maxLength: 128)

      Format: UTF8String or PrintableString

    • postal_code: (string - maxLength: 40)

      Format: UTF8String or PrintableString

    • organization: (string - maxLength: 64)

      Format: UTF8String or PrintableString

    • organizational_unit: (array of string)

      Format: Array of UTF8String or PrintableString (string - maxLength: 64)

    • organization_identifier: (string - maxLength: 64)

      Format: UTF8String or PrintableString

    • common_name: (string - maxLength: 64)

      Format: UTF8String or PrintableString

    • surname: (string - maxLength: 64)

      Format: UTF8String or PrintableString

    • given_name: (string - maxLength: 64)

      Format: UTF8String or PrintableString

    • email: (string - maxLength: 255)

      Format: IA5String

    • pseudonym: (string - maxLength: 128)

      Format: UTF8String or PrintableString

    • jurisdiction_of_incorporation_locality_name: (string - maxLength: 128)

      Format: UTF8String or PrintableString

    • jurisdiction_of_incorporation_state_or_province_name: (string - maxLength: 128)

      Format: UTF8String or PrintableString

    • jurisdiction_of_incorporation_country_name: (string - minLength: 2 - maxLength: 2 - pattern: ^[A-Z]{2}$)

      Format: PrintableString, ISO 3166-1 alpha-2 two-letter country code

    • business_category: (one of “Private Organization”, “Government Entity”, “Business Entity”, “Non-Commercial Entity” - maxLength: 128)

      Format: UTF8String or PrintableString

    • serial_number: (string - maxLength: 64)

      Format: PrintableString

    • extra_attributes: (array of basic.type_and_value)

      Extra subject distinguished name attributes to include by OID and value

      Items: type_and_value

      • type: required(string - pattern: ^([0-9]{1,9}\.){0,63}[0-9]+$)

        Object Identifier such as 1.3.6.1.4.1.311.20.2

      • value: (string)

    Example:

    {
  "common_name": "John Doe",
  "surname": "Doe",
  "given_name": "John",
  "country": "GB",
  "state": "London",
  "locality": "London",
  "street_address": "1 GlobalSign Road",
  "postal_code": "E1",
  "organization": "GMO GlobalSign",
  "organizational_unit": [
    "Operations",
    "Development"
  ],
  "organization_identifier": "PSDFI-FINFSA-29884997",
  "email": "john.doe@demo.hvca.globalsign.com",
  "pseudonym": "whatshisname",
  "jurisdiction_of_incorporation_locality_name": "London",
  "jurisdiction_of_incorporation_state_or_province_name": "London",
  "jurisdiction_of_incorporation_country_name": "United Kingdom",
  "business_category": "Internet security",
  "serial_number": "AA0448C4AE22702EF2C7A9BD7FA09743",
  "extra_attributes": [
    {
      "type": "2.5.4.43",
      "value": "GS"
    }
  ]
}
  • san: (object)

    List of Subject Alternative Name attributes to include in the certificate. See RFC 5280#4.2.1.6

    • dns_names: (array of string)
    • emails: (array of string)
    • ip_addresses: (array of string)
    • uris: (array of string)
    • other_names: (array of basic.type_and_value)

      Items: type_and_value

      • type: required(string - pattern: ^([0-9]{1,9}\.){0,63}[0-9]+$)

        Object Identifier such as 1.3.6.1.4.1.311.20.2

      • value: (string)

    Example:

    {
  "dns_names": [
    "test.demo.hvca.globalsign.com",
    "test2.demo.hvca.globalsign.com"
  ],
  "ip_addresses": [
    "198.41.214.154"
  ],
  "uris": [
    "http://test.demo.hvca.globalsign.com/uri"
  ],
  "emails": [
    "admin@demo.hvca.globalsign.com",
    "contact@demo.hvca.globalsign.com"
  ],
  "other_names": [
    {
      "type": "1.3.6.1.4.1.311.20.2.3",
      "value": "upn@demo.hvca.globalsign.com"
    }
  ]
}
  • key_usages: (object)

    Validation policy for key_usages field. If the field is present at least one of the fields must be set to TRUE

    • digital_signature: (boolean)

      The digital signature field is asserted when the subject public key is used for verifying digital signatures, other than signatures on certificates and CRLs, such as those used in an entity authentication service, a data origin authentication service, and/or an integrity service.

    • content_commitment: (boolean)

      The content commitment field is asserted when the subject public key is used to verify digital signatures, other than signatures on certificates and CRLs, used to provide a non-repudiation service that protects against the signing entity falsely denying some action. In the case of later conflict, a reliable third party may determine the authenticity of the signed data. (Note that in older editions of X.509 this field used to be referred to as nonRepudiation.)

    • key_encipherment: (boolean)

      The key encipherment field is asserted when the subject public key is used for enciphering private or secret keys, i.e., for key transport. For example, this bit shall be set when an RSA public key is to be used for encrypting a symmetric content-decryption key or an asymmetric private key.

    • data_encipherment: (boolean)

      The data encipherment field is asserted when the subject public key is used for directly enciphering raw user data without the use of an intermediate symmetric cipher. Note that the use of this bit is extremely uncommon; almost all applications use key transport or key agreement to establish a symmetric key.

    • key_agreement: (boolean)

      The key agreement field is asserted when the subject public key is used for key agreement. For example, when a Diffie-Hellman key is to be used for key management, then this bit is set.

    • key_certificate_sign: (boolean)

      The key certificate sign field is asserted when the subject public key is used for verifying signatures on public key certificates. If this field is asserted, then the cA field in the basic constraints extension (Section 4.2.1.9 of rfc 5280) MUST also be asserted.

    • crl_sign: (boolean)

      The crl sign field is asserted when the subject public key is used for verifying signatures on certificate revocation lists (e.g., CRLs, delta CRLs, or ARLs).

    • encipher_only: (boolean)

      The meaning of the encipher only bit is undefined in the absence of the keyAgreement bit. When the encipherOnly bit is asserted and the keyAgreement bit is also set, the subject public key may be used only for enciphering data while performing key agreement.

    • decipher_only: (boolean)

      The meaning of the decipher only field is undefined in the absence of the key agreement field. When the decipherOnly bit is asserted and the keyAgreement field is also set, the subject public key may be used only for deciphering data while performing key agreement.

    Example:

    {
  "digital_signature": true,
  "content_commitment": false,
  "key_encipherment": true,
  "data_encipherment": false,
  "key_agreement": true,
  "key_certificate_sign": true,
  "crl_sign": false,
  "encipher_only": true,
  "decipher_only": true
}
  • extended_key_usages: (array of basic.oid)

    List of Extended Key Usages to include in the certificate. See RFC 5280#4.2.1.12

    Example:

    [
  "1.3.6.1.5.5.7.3.1",
  "1.3.6.1.5.5.7.3.2"
]
  • qualified_statements: (object)

    List of qualified statements to include in the certificate See RFC 3739#3.2.6

    • semantics: (object)

      If present QC-Statement identifier will be id-qcs-pkixQCSyntax-v2. See RFC 3739#3.2.6.1

      • identifier: (string - pattern: ^([0-9]{1,9}\.){0,63}[0-9]+$)

        SemanticsIdentifier as per RFC 3739#3.2.6.1.

      • name_authorities: (array of string)

        NameRegistrationAuthorities as per RFC 3739#3.2.6.1. QC-Statement identifier will be id-qcs-pkixQCSyntax-v2 (1.3.6.1.5.5.7.11.2).

    • etsi_qc_compliance: (boolean)

      This QCstatement claims that the certificate is an EU qualified certificate that is issued according to Directive 1999/93/EC [i.3] or the Annex I, III or IV of the Regulation (EU) No 910/2014 [i.8] whichever is in force at the time of issuance. See ETSI EN 319 412-5 V2.1.1#4.2.1

    • etsi_qc_sscd_compliance: (boolean)

      This QCstatement declares that the private key related to the certified public key resides in a Qualified Signature/Seal Creation Device (QSCD) according to the Regulation (EU) No 910/2014 [i.8] or a secure signature creation device as defined in the Directive 1999/93/EC [i.3]. See ETSI EN 319 412-5 V2.1.1#4.2.2

    • etsi_qc_type: (string - pattern: ^([0-9]{1,9}\.){0,63}[0-9]+$)

      This QCStatement declares that a EU qualified certificate is issued as one or more specific types according to Annexes I, III or IV of the Regulation (EU) No 910/2014 [i.8] when used in combination with the qcStatement as defined in clause 4.2.1. When used on its own it indicates that it is used for the purposes of electronic signatures, seals or web sites for "non-qualified certificates" within the context of Regulation (EU) No 910/2014 [i.8]. See ETSI EN 319 412-5 V2.1.1#4.2.3

    • etsi_qc_retention_period: (integer)

      This QCStatement declares a retention period for material information relevant to the use of and reliance on a certificate, expressed as a number of years after the expiry date of the certificate. See ETSI EN 319 412-5 V2.1.1#4.3.3

    • etsi_qc_pds: (object)

      This QCStatement holds URLs to PKI Disclosure Statements (PDS) in accordance with Annex A of ETSI EN 319 411-1. See ETSI EN 319 412-5 V2.1.1#4.3.4.

      • /^[A-Z]{2}/: required(string)

        The key indicates the language of the PDS and shall be as defined in ISO 639-1. The value corresponds to the URL at which the PDS can be accessed.

    Example:

    {
  "semantics": {
    "identifier": "1.1.1.1.1.1",
    "name_authorities": [
      "contact@ra1.hvsign.globalsign.com"
    ]
  },
  "etsi_qc_compliance": true,
  "etsi_qc_type": "0.4.0.1862.1.6.1",
  "etsi_qc_sscd_compliance": true,
  "etsi_qc_retention_period": 1,
  "etsi_qc_pds": {
    "EN": "https://demo.hvsign.globalsign.com/en/pds"
  }
}
  • subject_da: (object)

    List of Subject Directory Attributes to include in the certificate. See RFC3739

    • gender: (string)
    • date_of_birth: (date-only)

      RFC3339 date. As per RFC3739, the resulting attribute will specify time as GMT 12.00.00 (noon)

    • place_of_birth: (string)
    • country_of_citizenship: (array of basic.country_code)

      List of ISO 3166-1 Alpha-2 country codes

    • country_of_residence: (array of basic.country_code)

      List of ISO 3166-1 Alpha-2 country codes

    • extra_attributes: (array of basic.type_and_value)

      Extra subject directory attributes to include by OID and value

      Items: type_and_value

      • type: required(string - pattern: ^([0-9]{1,9}\.){0,63}[0-9]+$)

        Object Identifier such as 1.3.6.1.4.1.311.20.2

      • value: (string)

    Example:

    {
  "gender": "m",
  "date_of_birth": "1979-01-31",
  "place_of_birth": "London",
  "country_of_citizenship": [
    "GB",
    "US"
  ],
  "country_of_residence": [
    "US"
  ],
  "extra_attributes": [
    {
      "type": "2.5.29.9.1.1.1"
    },
    {
      "type": "2.5.29.9.1.1.2",
      "value": "custom subject da value"
    }
  ]
}
  • ms_extension_template: (object)

    Values to populate Microsoft template extension (91.3.6.1.4.1.311.21.7) with

    • id: (string - pattern: ^([0-9]{1,9}\.){0,63}[0-9]+$)

      Object Identifier such as 1.3.6.1.4.1.311.20.2

    • major_version: (integer)
    • minor_version: (integer)

    Example:

    {
  "id": "1.2.3.4.123.4.5.1",
  "major_version": 1,
  "minor_version": 2
}
  • custom_extensions: (object)

    List of custom extensions to include in the certificate as X509v3 extensions. See RFC5280#4.2

    • /^([0-9]{1,9}\.){0,63}[0-9]+$/: required(string)

      The key indicates the object identifier of the custom extension and the value will be formatted as defined by the corresponding validation policy.

    Example:

    {
  "2.5.29.99.1": "NIL",
  "2.5.29.99.2": "SOME TEXT"
}

Example:

{
  "subject_dn": {
    "common_name": "John Doe",
    "surname": "Doe",
    "given_name": "John",
    "country": "GB",
    "state": "London",
    "locality": "London"
  },
  "san": {
    "emails": [
      "admin@demo.hvca.globalsign.com",
      "contact@demo.hvca.globalsign.com"
    ],
    "other_names": [
      {
        "type": "1.3.6.1.4.1.311.20.2.3",
        "value": "upn@demo.hvca.globalsign.com"
      }
    ]
  },
  "key_usages": {
    "digital_signature": true,
    "content_commitment": false,
    "key_encipherment": true,
    "data_encipherment": false,
    "key_agreement": true,
    "key_certificate_sign": false,
    "crl_sign": false,
    "encipher_only": true,
    "decipher_only": true
  },
  "extended_key_usages": [
    "1.3.6.1.5.5.7.3.3"
  ],
  "ms_extension_template": {
    "id": "1.2.3.4.123.4.5.1",
    "major_version": 1,
    "minor_version": 2
  },
  "subject_da": {
    "gender": "m",
    "date_of_birth": "1979-01-31",
    "place_of_birth": "London",
    "country_of_citizenship": [
      "GB",
      "US"
    ],
    "country_of_residence": [
      "US"
    ]
  }
}

HTTP status code 200

Successfully created a signing identity

Body

Media type: application/json;charset=utf-8

Type: object

Properties
  • id: required(string)

    Id of the created identity

  • signing_cert: required(string)

    PEM encoded X509 signing certificate (defined in RFC 5280). The PEM encoding format (defined in RFC 1421) requires a line length of 64 characters except for the last line which can be shorter. In JSON newlines are delimited with ASCII newline symbol "\n".

  • ocsp_response: required(string)

    Base64 encoded DER representation of the OCSP response for signing_certificate. See RFC6960

Example:

{
  "id": "730EDFF3C8809624B3B902E83DCB2440",
  "signing_cert": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----",
  "ocsp_response": "MIGIAkIA6CotF+LAs2MeymHWul2KuatxcqWDpvhgaEJCI+joyj7p9XEUyH5pBTJ2VqvO0hKYEm+dZl8KKD7ISHWz8Vfb9cECQgFwaB7u/5cw4kT5gv9BPTlxCSiZRlRPVbTbYWl/BeaWAwrt3oEqDuHXOwIQscj/887bBEN/SnYGpKkKe/qdKEd0gw=="
}

HTTP status code 400

Request could not be parsed

Body

Media type: application/problem+json;charset=utf-8

Type: object

Properties
  • description: required(string)
  • id: (string)
  • errors: (object)

    key value error type

    • /^.+$/: required(string)

      key is the error type, and value contains error details

Example:

{
  "description": "Bad Request"
}

HTTP status code 401

Request is unauthorized

Body

Media type: application/problem+json;charset=utf-8

Type: object

Properties
  • description: required(string)
  • id: (string)
  • errors: (object)

    key value error type

    • /^.+$/: required(string)

      key is the error type, and value contains error details

Example:

{
  "description": "Unauthorized"
}

HTTP status code 411

Request Content-Length is absent or 0

Body

Media type: application/problem+json;charset=utf-8

Type: object

Properties
  • description: required(string)
  • id: (string)
  • errors: (object)

    key value error type

    • /^.+$/: required(string)

      key is the error type, and value contains error details

Example:

{
  "description": "Content-Length required"
}

HTTP status code 415

Request content type is not application/json;charset=utf-8

Body

Media type: application/problem+json;charset=utf-8

Type: object

Properties
  • description: required(string)
  • id: (string)
  • errors: (object)

    key value error type

    • /^.+$/: required(string)

      key is the error type, and value contains error details

Example:

{
  "description": "Bad Content-Type"
}

HTTP status code 422

Invalid request

Body

Media type: application/problem+json;charset=utf-8

Type: object

Properties
  • description: required(string)
  • id: (string)
  • errors: (object)

    key value error type

    • /^.+$/: required(string)

      key is the error type, and value contains error details

Example:

{
  "description": "Validation error message"
}

HTTP status code 429

Request rate exceeded the set limit

Body

Media type: application/problem+json;charset=utf-8

Type: object

Properties
  • description: required(string)
  • id: (string)
  • errors: (object)

    key value error type

    • /^.+$/: required(string)

      key is the error type, and value contains error details

Example:

{
  "description": "Rate Limit Reached"
}

HTTP status code 503

System temporarily cannot process the request

Body

Media type: application/problem+json;charset=utf-8

Type: object

Properties
  • description: required(string)
  • id: (string)
  • errors: (object)

    key value error type

    • /^.+$/: required(string)

      key is the error type, and value contains error details

Example:

{
  "description": "Service busy, please retry later",
  "id": "0vqe8FWeDe4DQ7rU7wbzzGmPc4B"
}

/identity/{id}/sign/{digest}

get

get

Retrieve signature for digest

Retrieve signature for digest

URI Parameters

  • id: required(string - minLength: 32 - maxLength: 32 - pattern: ^([A-Fa-f0-9]{2})+$)

    The id of the identity to sign digest with

    Example:

    730EDFF3C8809624B3B902E83DCB2440
  • digest: required(string - minLength: 64 - maxLength: 64 - pattern: ^([A-Fa-f0-9]{2})+$)

    Hex encoded SHA256 message digest as defined in RFC5652#section-5.4

    Example:

    7573A237684A9CE53857C96B709A867A84D15B43B3381549E082CF421778B5DF

Headers

  • Authorization: required(string)

    The Authorization header. Only "Bearer" is supported

    Example:

    Bearer eyJhbGciOiAiSFMyNTYiLCAidHlwIjogIkpXVCJ9.eyJ1c2VyX2lkIjogMX0.BSf1w1blYKcbxVlyOtUogUsozH2clY34xxYPd8lQIlQ

HTTP status code 200

Signed the digest with signing identity, returning the signature

Headers

  • Content-Length: required(integer - default: 0)

Body

Media type: application/json;charset=utf-8

Type: object

Properties
  • signature: required(string)

    Hex encoded SignatureValue as defined in RFC5652

Example:

{
  "signature": "2F786C81B507ACB5CC4C4F69CA1D73F46C0012440F3D1CBB0A194352AE0D120049977660F2BA6BCDFDF26DAAA1B386A8064C9C07335E5B5664445CA0A275140B3C0F60097C153FE9391C08AA4D312B5B0D1F4FBB59747D5AD364EEA4EBC6AA3BDE2485B485A3A43523D6F1E05472930C26D3E8EEE8A4C0CC18E14F8AA542D74BD315D48D51B00AF7FFD92E7C67A423AB49A572AD25F811C2021153FE5C4184036400AE21A542C05D8280919431698C331FBC3A332F56EC62525DECF90D803BE9A0667A266051EF04F96012F6191F0CB9A436288009540A2DC71A24167692CF720F9E9854BB1C092692EBB2EC33E117A3AAA8E8EEABC514D7CE4F73E341B96F83"
}

HTTP status code 400

Request could not be parsed

Body

Media type: application/problem+json;charset=utf-8

Type: object

Properties
  • description: required(string)
  • id: (string)
  • errors: (object)

    key value error type

    • /^.+$/: required(string)

      key is the error type, and value contains error details

Example:

{
  "description": "Bad Request"
}

HTTP status code 401

Request is unauthorized

Body

Media type: application/problem+json;charset=utf-8

Type: object

Properties
  • description: required(string)
  • id: (string)
  • errors: (object)

    key value error type

    • /^.+$/: required(string)

      key is the error type, and value contains error details

Example:

{
  "description": "Unauthorized"
}

HTTP status code 402

Quota has been reached

Body

Media type: application/problem+json;charset=utf-8

Type: object

Properties
  • description: required(string)
  • id: (string)
  • errors: (object)

    key value error type

    • /^.+$/: required(string)

      key is the error type, and value contains error details

Example:

{
  "description": "Quota Reached"
}

HTTP status code 404

Identity to sign with was not found or expired

Body

Media type: application/problem+json;charset=utf-8

Type: object

Properties
  • description: required(string)
  • id: (string)
  • errors: (object)

    key value error type

    • /^.+$/: required(string)

      key is the error type, and value contains error details

Example:

{
  "description": "Identity not found or expired"
}

HTTP status code 422

Invalid request

Body

Media type: application/problem+json;charset=utf-8

Type: object

Properties
  • description: required(string)
  • id: (string)
  • errors: (object)

    key value error type

    • /^.+$/: required(string)

      key is the error type, and value contains error details

Example:

{
  "description": "Validation error message"
}

HTTP status code 429

Request rate exceeded the set limit

Body

Media type: application/problem+json;charset=utf-8

Type: object

Properties
  • description: required(string)
  • id: (string)
  • errors: (object)

    key value error type

    • /^.+$/: required(string)

      key is the error type, and value contains error details

Example:

{
  "description": "Rate Limit Reached"
}

HTTP status code 503

System temporarily cannot process the request

Body

Media type: application/problem+json;charset=utf-8

Type: object

Properties
  • description: required(string)
  • id: (string)
  • errors: (object)

    key value error type

    • /^.+$/: required(string)

      key is the error type, and value contains error details

Example:

{
  "description": "Service busy, please retry later",
  "id": "0vqe8FWeDe4DQ7rU7wbzzGmPc4B"
}

/timestamp/{digest}

get

get

Retrieve timestamp token for digest

Retrieve timestamp token for digest

URI Parameters

  • digest: required(string - minLength: 64 - maxLength: 64 - pattern: ^([A-Fa-f0-9]{2})+$)

    Hex encoded SHA2-256 digest of the object to be timestamped. Corresponds to MessageImprint hashedMesssage as defined in RFC3161.

    Example:

    7573A237684A9CE53857C96B709A867A84D15B43B3381549E082CF421778B5DF

Headers

  • Authorization: required(string)

    The Authorization header. Only "Bearer" is supported

    Example:

    Bearer eyJhbGciOiAiSFMyNTYiLCAidHlwIjogIkpXVCJ9.eyJ1c2VyX2lkIjogMX0.BSf1w1blYKcbxVlyOtUogUsozH2clY34xxYPd8lQIlQ

HTTP status code 200

Returns timestamp token for digest

Headers

  • Content-Length: required(integer - default: 0)

Body

Media type: application/json;charset=utf-8

Type: object

Properties
  • token: required(string)

    Base64 encoded DER representation of timestamp token according to RFC3161. It includes the TSA signing certificate in SignedData.CertificatesSet.

Example:

{
  "token": "MIGIAkIA6CotF+LAs2MeymHWul2KuatxcqWDpvhgaEJCI+joyj7p9XEUyH5pBTJ2VqvO0hKYEm+dZl8KKD7ISHWz8Vfb9cECQgFwaB7u/5cw4kT5gv9BPTlxCSiZRlRPVbTbYWl/BeaWAwrt3oEqDuHXOwIQscj/887bBEN/SnYGpKkKe/qdKEd0gw=="
}

HTTP status code 400

Request could not be parsed

Body

Media type: application/problem+json;charset=utf-8

Type: object

Properties
  • description: required(string)
  • id: (string)
  • errors: (object)

    key value error type

    • /^.+$/: required(string)

      key is the error type, and value contains error details

Example:

{
  "description": "Bad Request"
}

HTTP status code 401

Request is unauthorized

Body

Media type: application/problem+json;charset=utf-8

Type: object

Properties
  • description: required(string)
  • id: (string)
  • errors: (object)

    key value error type

    • /^.+$/: required(string)

      key is the error type, and value contains error details

Example:

{
  "description": "Unauthorized"
}

HTTP status code 402

Quota has been reached

Body

Media type: application/problem+json;charset=utf-8

Type: object

Properties
  • description: required(string)
  • id: (string)
  • errors: (object)

    key value error type

    • /^.+$/: required(string)

      key is the error type, and value contains error details

Example:

{
  "description": "Quota Reached"
}

HTTP status code 422

Invalid request

Body

Media type: application/problem+json;charset=utf-8

Type: object

Properties
  • description: required(string)
  • id: (string)
  • errors: (object)

    key value error type

    • /^.+$/: required(string)

      key is the error type, and value contains error details

Example:

{
  "description": "Validation error message"
}

HTTP status code 429

Request rate exceeded the set limit

Body

Media type: application/problem+json;charset=utf-8

Type: object

Properties
  • description: required(string)
  • id: (string)
  • errors: (object)

    key value error type

    • /^.+$/: required(string)

      key is the error type, and value contains error details

Example:

{
  "description": "Rate Limit Reached"
}

HTTP status code 503

System temporarily cannot process the request

Body

Media type: application/problem+json;charset=utf-8

Type: object

Properties
  • description: required(string)
  • id: (string)
  • errors: (object)

    key value error type

    • /^.+$/: required(string)

      key is the error type, and value contains error details

Example:

{
  "description": "Service busy, please retry later",
  "id": "0vqe8FWeDe4DQ7rU7wbzzGmPc4B"
}

/validationpolicy

get

get

Retrieve the validation policy associated with the calling account

/certificate_path

get

get

Retrieve the certificate used to sign the identity requests

/trustchain

get

get

Query the chain of trust for the certificates issued by the calling account and the revocation info for the certificates in the chain

/counters

get

get

Query the number of signatures created by the calling account

Deprecated

  • This endpoint is not recommended for use and is subject to removal in future major releases.
  • It is recommended to use the /quotas/signatures endpoint instead.

get

get

Query the number of timestamps created by the calling account

Deprecated

  • This endpoint is not recommended for use and is subject to removal in future major releases.
  • It is recommended to use the /quotas/timestamps endpoint instead.

get

get

Query the number of identities created by the calling account

Deprecated

  • This endpoint is not recommended for use and is subject to removal in future major releases.

/quotas

get

get

Query remaining signatures quota for the calling account

get

get

Query remaining timestamp quota for the calling account