Documentation 9.0

# Cryptograph's Storage

Group of methods to access enrolled cryptographs, manage cryptograph's blocking and unblocking them, and to get a list of blocked cryptographs.

# Get Cryptograph information

GET /v1/cryptograph?uuid=<cryptograph uuid>
1

The method returns the cryptograph's image representation, its expiration date if applicable, and the blocked status.

Result sample:

{
  "uuid": "UUID FROM QUERY STRING",
  "image": "BASE64",
  "expirationDate": "DATE TIME (ISO 8601) or null",
  "blocked": true or false
}
1
2
3
4
5
6

# Block/unblock a cryptograph

Method to block a cryptograph by its uuid.

PUT /v1/cryptograph/block?uuid=<cryptograph uuid>
1

Method to unblock a cryptograph by its uuid.

PUT /v1/cryptograph/unblock?uuid=<cryptograph uuid>
1

# List of blocked cryptographs

Method to get a list of blocked cryptographs:

GET /v1/cryptograph/blocked/list
1

This method returns:

  • A file with the blocked cryptographs (in the body of response request). See List of blocked cryptographs file format
  • The SHA256 hash of the file in the ETag response header
  • A signature of the hash in Signature response header
  • The last date and time when the list was updated in Last-Modified response header

Method to get information about list of blocked cryptographs:

HEAD /v1/cryptograph/blocked/list
1

Unlike GET /v1/cryptograph/blocked/list the method doesn't return a file, but provide information about the hash of the file, the signature of the hash and the last modification date/time.

It is useful to determinate when the cached list of blocked cryptographs shoud be upgraded, e.g.

Method to get X.509 certificate to verify signature of the list hash:

GET /v1/cryptograph/blocked/cert
1

WARNING

IDencode just provides a list of blocked cryptographs, but does nothing with them. The users are entirely responsibly to decide what to do with and how to manage blocked cryptographs in the context of their application.