Skip to content
Comms.ID
Esc
↑↓navigate↵open⌘Jpreview
On this page

Install address

Install address

These examples use published, verified artifacts. Keep signing keys on your server.

Script tag

The relay is a route on your server. It signs calls as your registered app.

<script src="https://cdn.comms.id/address/1.1.0.js" integrity="sha384-RIeFzFM9ak1S/1nbRxAPlECzJhrd+D6rT/ofsNqrtwaFcbnvdgmysNhEUzPFjUHH" crossorigin="anonymous"></script>
<comms-id-address relay="/api/comms-id/address"></comms-id-address>

React

pnpm add @comms-id/address-react@0.2.2 @comms-id/address@0.3.1
import { createAddressBrowserClient } from "@comms-id/address/browser";
import { AddressAutocomplete } from "@comms-id/address-react";

const client = createAddressBrowserClient({ relayUrl: "/api/comms-id/address" });
export const Example = () => <AddressAutocomplete client={client} />;

Server SDK

pnpm add @comms-id/address@0.3.1
import { createAddressClient } from "@comms-id/address/server";
const client = createAddressClient({
  clientId: process.env.COMMS_ID_CLIENT_ID!,
  privateJwk: JSON.parse(process.env.COMMS_ID_PRIVATE_JWK!),
});

See the operation reference for request, response and command-line examples.

Relay

Install the server relay into your relying-party app:

pnpm dlx comms-id add address-relay

Agent tools

Product tools are served at https://mcp.comms.id. The documentation MCP serves documentation only; it does not execute product operations.

Operations

suggest

Read the suggest API reference.

resolve

Read the resolve API reference.

validate

Read the validate API reference.

Upgrading

Upgrade guide.

Was this page helpful?