Skip to main content
Documentation Powered by Redocly

Users API (1.0)

Consumer Health Platform - Users API - Open API docs

Authentication

bearer

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "jwt"

Accounts

/public/accounts

Endpoint to create an account

Request Body schema: application/json
password
required
string [ 8 .. 72 ] characters (?=.*[A-Z])(?=.*[a-z])(?=.*[0-9])

Must contain: at least one upper case letter, at least one lower case letter and at least one number.

email
required
string
contactNumber
string
contactName
string
consents
Array of strings
Items Enum: "terms_of_service" "privacy_policy" "notice_of_privacy_practices"

Responses

Request samples

Content type
application/json
{
  • "password": "stringst",
  • "email": "string",
  • "contactNumber": "string",
  • "contactName": "string",
  • "consents": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string"
}

/public/accounts/{accountId}/resend-verification

Endpoint to resend email verification

path Parameters
accountId
required
string

Responses

/accounts/{accountId}/consents

Endpoint to register consent for an account

Authorizations:
bearer (
  • accounts:consents:create
)
path Parameters
accountId
required
string
Request Body schema: application/json
type
required
string
Enum: "terms_of_service" "privacy_policy" "notice_of_privacy_practices"

Responses

Request samples

Content type
application/json
{
  • "type": "terms_of_service"
}

/accounts/{accountId}

Endpoint to delete an account

Authorizations:
bearer (
  • accounts:delete
)
path Parameters
accountId
required
string

Responses

Health

/healthz

Endpoint for healthcheck

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "info": {
    },
  • "error": { },
  • "details": {
    }
}

/healthz/ready

Endpoint for readyness

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "info": {
    },
  • "error": { },
  • "details": {
    }
}