V1 endpoints

These endpoints require a Portal API Key (aka "Custodian 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.

Create a new client

POST https://api.portalhq.io/api/v1/custodians/clients

Registers a new client and returns a client session token.

Headers

Name	Type	Description
Authorization*	String	Bearer <Portal API Key>
Content-Type*	String	application/json

Request Body

Name	Type	Description
isAccountAbstracted	Boolean	The client will use ERC-4337 Account Abstraction.

201: Created Success

{
  "id": "string",
  "clientApiKey": "string",
  "clientSessionToken": "string",
  "isAccountAbstracted": boolean
}

400: Bad Request Bad Request

{}

401: Unauthorized Unauthorized Request

{}

Fetches a single client

GET https://api.portalhq.io/api/v1/custodians/clients/{clientId}

Fetches the specified client for the authorized custodian.

Path Parameters

Name	Type	Description
clientId*	String	The ID of a client.

Headers

Name	Type	Description
Authorization*	String	Bearer <Portal API Key>
Content-Type*	String	application/json

200: OK Success

{
  "id": "string",
  "address": "string",
  "clientApiKey": "string",
  "isAccountAbstracted": boolean
}

400: Bad Request Bad Request

{}

401: Unauthorized Unauthorized Request

{}

Fetches a list of clients

GET https://api.portalhq.io/api/v1/custodians/clients

Fetches all clients for the authorized custodian.

Headers

Name	Type	Description
Authorization*	String	Bearer <Portal API Key>
Content-Type*	String	application/json

200: OK Success

[
  {
    "id": "string",
    "address": "string",
    "backupStatus": "string",
    "clientApiKey": "string",
    "signingStatus": "string"
  }
]

400: Bad Request Bad Request

{}

401: Unauthorized Unauthorized Request

{}

Refresh Client Session Token (CST)

POST https://api.portalhq.io/api/v1/custodians/clients/{clientId}/session

Refreshes a client's Client Session Token.

Path Parameters

Name	Type	Description
clientId	String	The ID of a client.

Headers

Name	Type	Description
Authorization*	String	Bearer <Portal API Key>
Content-Type*	String	application/json

200: OK Success

{
  "id": "string",
  "clientSessionToken": "string",
  "isAccountAbstracted": boolean
}

400: Bad Request Bad Request

{
  "error": "string"
}

401: Unauthorized Unauthorized Request

{
  "error": "string"
}

Generate Client Web One-Time Password (OTP)

GET https://api.portalhq.io/api/v1/custodians/clients/{clientId}/web-otp

Generate a one-time password for a client.

Path Parameters

Name	Type	Description
clientId*	String	The ID of a client.

Headers

Name	Type	Description
Authorization*	String	Bearer <Portal API Key>
Content-Type*	String	application/json

200: OK Success

{
  "id": "string"
  "otp": "string"
}

400: Bad Request Bad Request

{}

401: Unauthorized Unauthorized

{}