The latest version of the specification is version v2.

Archive

Endpoint

GET /download-register

The contents of a register MUST be made available as an archive. The archive file MUST be capable of being used as backup of the register, with the exception of secrets used to generate Digital Proofs. The archive file SHOULD be made available in a single file, but MAY be split into multiple parts if it deemed too large.

The archive contains the following files in the following structure:

  • A directory with the name of the register containing:

    • A file named "register.json" containing the Register summary serialised as JSON.
    • A file named "proof.json" containing one or more digital proofs for the register serialised as JSON.
    • A directory named "item" containing all of the items serialised in one or more JSON files.
    • A directory named "entry" containing all of the Entry serialised as one or more JSON files.

GET /download-register
Host: country.register.gov.uk
Accept: application/octet-stream
HTTP/1.1 200 OK
Content-Type: application/octet-stream
Content-Transfer-Encoding: binary

...

© Crown copyright released under the Open Government Licence.