CivicID Public API

From Gateway to Gov

CivicID will make use of the OpenID authentication scheme, followed by the iCard standard. Documented code samples will be provided.

Relaying Site Access Procedure

Sites making use of CIvicID logins or signatures will access the API in a common fashion. Relaying sites will redirect users to CivicID, which will prompt them to login or open a nearly instant (two-click) unverified CivicID. Users will be encouraged to begin the verification process at that point, as well as the ability to skip verification and return to the originating site.

On successful login, CivicID will return.

   * Success - Boolean
   * Verification Level
   * TransactionID
   * TransactionHash - a digital receipt of the transaction (signed hash)

And will store the following information internally:

   * UserID
   * Timestamp
   * OriginatingURL
   * ReturnURL
   * SessionID (from originating site)
   * TransactionID
   * Success - Boolean
   * TransactionHash