Documentation

Written for somebody deciding whether to connect their code to us, and for somebody who already has.

• Getting started

  From signing up to your first signed proof, in about a day.

• Connecting GitHub

  What the app asks for, what it can do, and how to take it away.

• Authorising a scan

  Why we ask you to prove you own an address before we send it traffic.

• Verifying a proof

  How somebody who does not trust us checks one.

• Roles and permissions

  Who can see what, and who can approve a change.

• The API

  Authenticating, choosing a workspace, the ten v1 endpoints, and what each refusal means.