Skip to content
Hightop docs header art
Hightop
API and Integrations

/recipients/resolve

POST/v1/agent/recipients/resolve

Resolve an agent-facing recipient identifier

Requires API-key authentication (agentAuth, agentId).

Purpose: resolve an opaque recipient identifier, address, or handle into a recipient-shaped resource.

Auth and scope: header-key auth or OAuth agent:read.

Idempotency: not required.

Request:

json
example
{
  "to": "recipient id, address, or handle",
  "asset": "USDC",
  "action": "send_payment"
}

Fields:

FieldTypeRequired
tononempty stringYes
assetstringNo
actionrecipient action enumNo

Response:

json
example
{
  "ok": true,
  "recipient": {
    "id": "string",
    "type": "recurring_payment",
    "display_name": "Vendor",
    "nickname": "Compute vendor",
    "asset_symbols": ["USDC"],
    "status": "active",
    "agent_actions": ["send_payment"],
    "blocked_actions": {}
  }
}

Common errors: validation_failed, not_found, recipient_not_allowed, insufficient_scope.

Related recipe: Pay a Vendor.