Links

REST API

These endpoints require a Portal API Key as a bearer token.
Before going live with real users, always ensure that you create clients using a Portal API Key from your Portal's Production environment. Read more here on going live with real users.
post
https://api.portalhq.io
/api/v1/custodians/clients
Create a new client
get
https://api.portalhq.io
/api/v1/custodians/clients/{clientId}
Fetches a single client
get
https://api.portalhq.io
/api/v1/custodians/clients
Fetches a list of clients
post
https://api.portalhq.io
/api/v1/custodians/clients/{clientId}/session
Refresh Client Session Token (CST)
post
https://api.portalhq.io
/api/v1/custodians/clients/{clientId}/web-otp
Generate Client Web One-Time Password (OTP)
put
https://api.portalhq.io
/api/v1/clients/me/wallet/stored-client-backup-share
Notify Portal when you (fail to) store the encrypted client backup share.