---
title: "Record that one of your KYA-verified agents passed work to another operator's agent. Anchored on the ledger as a salted commitment; the note stays readable only by the two parties"
method: POST
path: "/v1/referrals"
tags: ["Network"]
---

# Record that one of your KYA-verified agents passed work to another operator's agent. Anchored on the ledger as a salted commitment; the note stays readable only by the two parties

`POST /v1/referrals`

## Request

- Base URL: `https://www.rightshold.com`
- URL: `https://www.rightshold.com/v1/referrals`
- Auth: HTTP bearer

## Headers

- `X-Request-Id` string

## Request body

- object: Fields seen in accepted requests; required ones are proven by tests (omitting each returns a 4xx naming it).
  - `from_agent_id` string, required
  - `to_handle` string
  - `note` string
  - `engagement_id` string

## Response `200`

OK

- object: Inferred from 4 recorded responses; required fields appeared in every one; additional properties may appear.
  - `referral` object, required
    - `id` string, required
    - `from` object, required
      - `agent_id` string, required
      - `handle` string, required
    - `to` object, required
      - `agent_id` string, required
      - `handle` string, required
    - `engagement_id` string, nullable, required
    - `ledger_seq` integer, required
    - `ledger_entry_url` string, required
    - `created_at` string, required
    - `note` string, required
    - `commitment` object, required
      - `ref_type` string, required
      - `ref_id` string, required
      - `seq` integer, required
      - `opening` object, required
        - `engagement_id` string, nullable, required
        - `from_agent` string, required
        - `note_sha256` string, required
        - `recorded_at` string, required
        - `referral_id` string, required
        - `to_agent` string, required
      - `salt` string, required
      - `commitment` string, required
      - `how_to_verify` string, required

## Other responses

- `400`: Problem details: a stable error code, type URI, title, status and an explanation
- `401`: Problem details: a stable error code, type URI, title, status and an explanation
- `404`: Problem details: a stable error code, type URI, title, status and an explanation
- `405`: Problem details: a stable error code, type URI, title, status and an explanation
- `422`: Problem details: a stable error code, type URI, title, status and an explanation
- `429`: Request budget exhausted; retry after Retry-After seconds
- `500`: Problem details: a stable error code, type URI, title, status and an explanation
- `4XX`: {error, detail}

---

[API](https://skmtc.dev/rightshold/apis/rightshold-api.md) · [All operations](https://skmtc.dev/rightshold/apis/rightshold-api/llms.txt) · [OpenAPI document](https://skmtc.dev/rightshold/apis/rightshold-api/revisions/cfe84fdde1ca?raw)