AUDRIEDOCS

Sandbox and test keys

Build and trial your integration end to end with test keys, without creating real records.

A test key lets you run the whole flow, from authenticating a document to revoking it, before you create anything real. Nothing you do with it carries legal weight.

What a test key does

  • Authenticates and revokes like a live key, using your organisation's separate test signing key.
  • Uses a test ledger. Test records are committed to the ledger's test network, never the real one.
  • Reads as a sandbox record. Verifying a test record answers sandbox, so it cannot be mistaken for a genuine one. When you verify with your own test key, revoked and still-settling test records answer as themselves, so you can exercise every branch of your code. Anyone else sees sandbox.
  • Stays apart from live records. A test key sees only test records, and a live key never sees them.

Try it

curl -sX POST https://api.audrie.io/v1/records \
  -H "Authorization: Bearer $AUDRIE_TEST_KEY" \
  -H "Content-Type: application/json" \
  -d '{"originalDocHash":"sha256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}'

The record settles within a few seconds. Verify the same hash straight away and you may see no_record or pending_anchor first, so check again until it answers sandbox. See authenticate as your organisation for the full flow.

Good to know

  • Use sample documents. Once a test record has settled, anyone who submits its hash, with no key at all, normally gets sandbox back. If a live record exists for the same hash, a check without a key prefers the live record. Test with hashes of files you are happy to be known.
  • Test records are cleared after 30 days. Audrie deletes its copy, and the hash stays on the test ledger.
  • Move to live when you are ready. Create a live key for records that last. Test and live keys are separate, so nothing carries over.

On this page