IDCanopy Developers

Sandbox

Credential provisioning, there is no self-service signup

There is no self-service signup. Sandbox and production access are provisioned by IDCanopy.

IDCanopy portal: Sign in to the portal: coming soon. Your Aletheia access will be reachable from there. Until then, contact office@idcanopy.com.

Requesting a sandbox tenant

Email office@idcanopy.com with:

  • the tenant/organisation name you want provisioned,
  • your integration contact(s),
  • whether you need staging only, or staging and production,
  • for the inbound webhook: the document-host domain(s) to add to your fetch allowlist, and your outbound callback URL.

IDCanopy provisions and returns, out of band:

  • your tenant API key (fsk_<prefix>_<secret>),
  • optionally, on request: an mTLS CA chain and a signed client certificate, see mTLS; mTLS is not required by default,
  • the inbound HMAC secret and the outbound webhook secret, see Webhooks,
  • the document-URL allowlist registration and IDCanopy's egress IP range.

Credentials are never sent through git or any shared channel. Rotation is handled by IDCanopy on request and takes effect immediately, with a 60-second grace period on the prior key.

Base URLs

  • Production: https://aletheia.api-umbrella.io
  • Other environments carry a suffix on the host name (-sbx sandbox, -test, -dev); IDCanopy tells you which one your tenant uses.

Pending verification: the Aletheia team's docs call the non-production environment "staging"; which suffixed host a staging tenant uses is being confirmed.

All services' hosts are listed in Environments.

On this page