Signup Endpoint#

Added in version 2.3.

Developer Preview

The ESS Wallet Service endpoints are available as part of a Developer Preview program to allow early access to these features. Please be aware that these APIs may change.

The ESS Wallet Service provides the following endpoint for initializing the user’s Pod for use with the Wallet:

https://datawallet.{ESS Domain}/signup

Note

To access the /signup endpoint, users must be authenticated. The endpoint supports the use of HTTP-only, secure session cookies.

The /signup endpoint initializes the following:

  • WebID Profile

    • Modify the WebID profile document to include an inbox triple with the following form:

      <> ldp:inbox <https://storage.{ESS_instance}/{uuid}/inbox>

  • Pod Storage

    • Create the /wallet, /inbox, /accessrequests, and /accessgrants containers within the Pod.

  • Default access control settings for the inbox

    • Set the /inbox access control to allow public write access

Initialize Wallet#

The Wallet Service provides an endpoint that the Wallet uses to initialize the user’s Pod and associated configuration options to support the function of the Wallet.

Method

POST

Content-Type

application/json

Endpoint

https://datawallet.{ESS Domain}/signup

Payload

none

Output#

Upon completion of the request, the initialization is complete and the following fields are returned.

Example response

{
  "webId": "https://id.example/alice",
  "name": "Alice User",
  "logo": "https://images.example/logo.png",
  "signupRequired": true
}

Field

Value

webId

The new WebID of the user who has signed up.

name

The preferred name of the user, if available, for display in a user interface.

logo

A URL referencing a logo, if available, for display in a user interface.

signupRequired

Indicates whether the user needs to provision a Pod. true indicates that signup is required before a Pod can be provisioned. false indicates that the user already has a Pod.
On this page