Using the Identity API

Once authentication and sign-in are done through the publishing API auth endpoint, up next, we use the identity internal sign in methods. Not to fear, this just refers to using the Signpad endpoint to authenticate the user's wallet for entry into an online experience.

Authentication with the Signpad Endpoint

The first step to using the identity API is to login into the web experience. The Signpad endpoint does this by taking in a value called signer sent in from the wallet infrastructure and returns a value that is displayed to the frontend.

Example Request

KeyExample value
signer/ gateId0x58279cE1d04bE1b64bf875317577e4061790b768

Example Response

A response from this endpoint will be passed into the wallet infrastructure's frontend and is entirely customizable. We have engineered this response to have the wallet address, nonce of the transaction, and service signature which is the hash of the whole signpad content.


Return value from clicking Sign in

The wallet infrastructure being used will provide a pop-up asking that the collector signs in to authenticate the transaction. Upon doing that, a value is return to the signpad endpoint - that value is called the Wallet Signature and will be referred to as signature through the docs

Entry into gated content with Web3 auth

The web3auth endpoint takes in three values and returns a JWT token that authenticates the user for access. The values are: the signpad, the signature and roles.

Example Request

signpadText that contains the wallet address, the nonce of the transaction and the service signature.
`signature``Returned value from signing in with the signpad endpoint through the wallet infrastructure.
rolesRoles assigned to holders of the token.

In return, it sends out a JWT token that can be decoded at a JWT encoding and decoding service to see the values.