> **Can't find what you're looking for?** Use `search_docs` on the docs MCP server at `https://docs.prividium.com/api/mcp` to find what you need.
>
> **Have feedback?** Use `submit_feedback` on the same MCP server.

# default

## GET /contract-deployments/

`GET /contract-deployments/`

### Query parameters

- `limit` `integer`
- `offset` `integer`

### Responses

#### `200`: Default Response

Body (`application/json`):

- `items` `object[]` _(required)_
  - `id` `string` _(required)_
  - `address` `string` _(required)_
  - `deployedBy` `string` _(required)_
  - `deployerAddress` `string` _(required)_
  - `deployerNonce` `integer` _(required)_
  - `deployTxHash` `string` _(required)_
  - `startedAt` `string <date-time>` _(required)_
  - `successAt` `string <date-time>` _(required)_
  - `erroredAt` `string <date-time>` _(required)_
  - `errorMessage` `string | null` _(required)_
  - `createdAt` `string <date-time>` _(required)_
  - `updatedAt` `string <date-time>` _(required)_
- `pagination` `object` _(required)_
  - `currentPage` `number` _(required)_
  - `totalPages` `number` _(required)_
  - `totalItems` `number` _(required)_
  - `limit` `number` _(required)_
  - `offset` `number` _(required)_

#### `400`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

#### `401`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

#### `403`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

### Example request

```bash
curl '/api/contract-deployments/?limit=10&offset=0'
```

```ts
fetch('/api/contract-deployments/?limit=10&offset=0')
```

## PUT /tenants/{id}

`PUT /tenants/{id}`

Update a tenant by id

### Path parameters

- `id` `string` _(required)_

### Request body (required) (`application/json`)

- `name` `string` _(required)_
- `publicKey` `string` _(required)_
- `defaultRoles` `object[]` _(required)_
  - `id` `string` _(required)_

### Responses

#### `200`: Default Response

Body (`application/json`):

- `id` `string` _(required)_
- `name` `string` _(required)_
- `publicKey` `string` _(required)_
- `createdAt` `string <date-time>` _(required)_
- `updatedAt` `string <date-time>` _(required)_
- `defaultRoles` `object[]` _(required)_
  - `id` `string` _(required)_
  - `roleName` `string` _(required)_
  - `systemPermissions` `string[]`
  - `isSystemRole` `boolean`
  - `organizationId` `string | null`
  - `createdAt` `string <date-time>`
  - `updatedAt` `string <date-time>`

#### `400`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

#### `401`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

#### `403`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

#### `404`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

### Example request

```bash
curl /api/tenants/string \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "string",
  "publicKey": "string",
  "defaultRoles": [
    {
      "id": "string"
    }
  ]
}'
```

```ts
fetch('/api/tenants/string', {
  method: 'PUT',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'string',
    publicKey: 'string',
    defaultRoles: [
      {
        id: 'string'
      }
    ]
  })
})
```

## GET /applications/

`GET /applications/`

Returns a paginated list of applications

### Query parameters

- `limit` `integer`
- `offset` `integer`

### Responses

#### `200`: Default Response

Body (`application/json`):

- `items` `object[]` _(required)_
  - `id` `string` _(required)_
  - `name` `string` _(required)_
  - `oauthClientId` `string` _(required)_
  - `oauthRedirectUris` `string[]` _(required)_
  - `origin` `string | null` _(required)_
  - `isPublic` `boolean` _(required)_
  - `description` `string | null` _(required)_
  - `imageUrl` `string | null` _(required)_
  - `createdAt` `string <date-time>` _(required)_
  - `updatedAt` `string <date-time>` _(required)_
- `pagination` `object` _(required)_
  - `currentPage` `number` _(required)_
  - `totalPages` `number` _(required)_
  - `totalItems` `number` _(required)_
  - `limit` `number` _(required)_
  - `offset` `number` _(required)_

#### `401`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

#### `403`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

### Example request

```bash
curl '/api/applications/?limit=10&offset=0'
```

```ts
fetch('/api/applications/?limit=10&offset=0')
```

## POST /applications/

`POST /applications/`

Creates a new application

### Request body (required) (`application/json`)

- `name` `string` _(required)_
- `oauthRedirectUris` `string <uri>[]`
- `origin` `string <uri>`
- `isPublic` `boolean`
- `description` `string`
- `imageUrl` `string <uri>`

### Responses

#### `200`: Default Response

Body (`application/json`):

- `id` `string` _(required)_
- `name` `string` _(required)_
- `oauthClientId` `string` _(required)_
- `oauthRedirectUris` `string[]` _(required)_
- `origin` `string | null` _(required)_
- `isPublic` `boolean` _(required)_
- `description` `string | null` _(required)_
- `imageUrl` `string | null` _(required)_
- `createdAt` `string <date-time>` _(required)_
- `updatedAt` `string <date-time>` _(required)_

#### `400`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

#### `401`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

#### `403`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

### Example request

```bash
curl /api/applications/ \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "string",
  "oauthRedirectUris": [
    "string"
  ],
  "origin": "string",
  "isPublic": true,
  "description": "string",
  "imageUrl": "string"
}'
```

```ts
fetch('/api/applications/', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'string',
    oauthRedirectUris: ['string'],
    origin: 'string',
    isPublic: true,
    description: 'string',
    imageUrl: 'string'
  })
})
```

## GET /public-applications/

`GET /public-applications/`

Returns a paginated list of public applications

### Query parameters

- `limit` `integer`
- `offset` `integer`

### Responses

#### `200`: Default Response

Body (`application/json`):

- `items` `object[]` _(required)_
  - `id` `string` _(required)_
  - `name` `string` _(required)_
  - `description` `string | null` _(required)_
  - `imageUrl` `string | null` _(required)_
  - `origin` `string | null` _(required)_
- `pagination` `object` _(required)_
  - `currentPage` `number` _(required)_
  - `totalPages` `number` _(required)_
  - `totalItems` `number` _(required)_
  - `limit` `number` _(required)_
  - `offset` `number` _(required)_

#### `401`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

### Example request

```bash
curl '/api/public-applications/?limit=10&offset=0'
```

```ts
fetch('/api/public-applications/?limit=10&offset=0')
```

## POST /tenant-actions/users/{userId}/wallet

`POST /tenant-actions/users/{userId}/wallet`

Associates given wallet with user

### Path parameters

- `userId` `string` _(required)_

### Request body (`application/json`)

- `walletAddress` `string` _(required)_

### Responses

#### `200`: Default Response

Body (`application/json`):

- `id` `string` _(required)_
- `walletAddresses` `object[]` _(required)_
  - `walletAddress` `string` _(required)_
- `displayName` `string` _(required)_

#### `400`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

#### `401`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

#### `404`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

#### `409`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

### Example request

```bash
curl /api/tenant-actions/users/string/wallet \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "walletAddress": "string"
  }
]'
```

```ts
fetch('/api/tenant-actions/users/string/wallet', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    '0': {
      walletAddress: 'string'
    }
  })
})
```

## POST /service-actions/check-read-access

`POST /service-actions/check-read-access`

allows a service to check if a user has full read access

### Request body (required) (`application/json`)

- `userId` `string` _(required)_

### Responses

#### `200`: Default Response

Body (`application/json`):

- `authorized` `boolean` _(required)_

#### `400`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

#### `401`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

#### `403`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

#### `404`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

### Example request

```bash
curl /api/service-actions/check-read-access \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "userId": "string"
}'
```

```ts
fetch('/api/service-actions/check-read-access', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    userId: 'string'
  })
})
```

## GET /oauth-clients/{oauthClientId}

`GET /oauth-clients/{oauthClientId}`

### Path parameters

- `oauthClientId` `string` _(required)_

### Responses

#### `200`: Default Response

Body (`application/json`):

- `oauthClientId` `string` _(required)_
- `oauthRedirectUris` `string[]` _(required)_
- `name` `string` _(required)_
- `sessionKind` `string` _(required)_

#### `404`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

### Example request

```bash
curl /api/oauth-clients/string
```

```ts
fetch('/api/oauth-clients/string')
```

## POST /rpc/

`POST /rpc/`

### Responses

#### `200`: Default Response

### Example request

```bash
curl /api/rpc/ \
  --request POST
```

```ts
fetch('/api/rpc/', {
  method: 'POST'
})
```

## POST /rpc/service/

`POST /rpc/service/`

### Responses

#### `200`: Default Response

### Example request

```bash
curl /api/rpc/service/ \
  --request POST
```

```ts
fetch('/api/rpc/service/', {
  method: 'POST'
})
```

## POST /rpc/wallet/{token}

`POST /rpc/wallet/{token}`

### Path parameters

- `token` `string` _(required)_

### Request body (required) (`application/json`)

- `id` `string | number` _(required)_
- `jsonrpc` `string` _(required)_
- `method` `string` _(required)_
- `params` `unknown[]`

### Responses

#### `200`: Default Response

### Example request

```bash
curl /api/rpc/wallet/string \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "string",
  "jsonrpc": "2.0",
  "method": "string",
  "params": []
}'
```

```ts
fetch('/api/rpc/wallet/string', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    id: 'string',
    jsonrpc: '2.0',
    method: 'string',
    params: []
  })
})
```

## GET /readyz

`GET /readyz`

### Responses

#### `200`: Default Response

### Example request

```bash
curl /api/readyz
```

```ts
fetch('/api/readyz')
```

## GET /health

`GET /health`

### Responses

#### `200`: Default Response

### Example request

```bash
curl /api/health
```

```ts
fetch('/api/health')
```

## GET /.well-known/prividium

`GET /.well-known/prividium`

### Responses

#### `200`: Default Response

Body (`application/json`):

- `v1` `object` _(required)_
  - `blockExplorerUrl` `string <uri>` _(required)_
  - `chainId` `string` _(required)_
  - `chainName` `string` _(required)_
  - `baseToken` `object` _(required)_
    - `name` `string` _(required)_
    - `symbol` `string` _(required)_
    - `decimals` `number` _(required)_
    - `l1Address` `unknown` _(required)_
  - `rpcUrl` `string <uri>` _(required)_
  - `userPanelUrl` `string <uri>` _(required)_
  - `version` `string` _(required)_
  - `l1ChainId` `string` _(required)_
  - `l1ChainName` `string | null` _(required)_
  - `featuredWalletIds` `string[]`

### Example request

```bash
curl /api/.well-known/prividium
```

```ts
fetch('/api/.well-known/prividium')
```

## GET /.well-known/security.txt

`GET /.well-known/security.txt`

### Responses

#### `200`: Default Response

### Example request

```bash
curl /api/.well-known/security.txt
```

```ts
fetch('/api/.well-known/security.txt')
```