API reference

Saved addresses

A saved address is an outside address the merchant has approved for payouts and withdrawals. Adding one is itself a money-out decision, so the API can only propose it: it is created awaiting_approval, an Owner or Finance member approves it with a passkey at approval_url, and it then waits 24 hours (waiting) before it is active. Every owner is emailed when an address is proposed and when it is approved.

The `saved_address` object

JSON

{
  "id": "dst_92jw0br3z1bzkk45ddjqcm6q",
  "object": "saved_address",
  "livemode": true,
  "created": "2026-10-05T11:20:00.000Z",
  "label": "Green bean supplier",
  "kind": "third_party",
  "address": "0xD1220A0cf47c7B9Be7A2E6BA89F429762e7b9aDb",
  "network": "base",
  "asset": "base:usdc",
  "status": "active",
  "approved_by": "mem_ceh1wpzdrpk13cnpcjy9w0fa",
  "approved_at": "2026-10-05T11:24:09.000Z",
  "usable_at": "2026-10-06T11:24:09.000Z",
  "screening": {
    "id": "scr_6ncr4e0p7wqndfvny2d5vw5s",
    "status": "clear",
    "checked_at": "2026-10-05T11:20:01.000Z"
  },
  "approval_url": null,
  "metadata": {}
}

Table: The saved_address object
Field	Meaning
`usable_at`	A saved address can be paid from 24 hours after it was approved.
`status`	One of `awaiting_approval`, `waiting`, `active`, `removed`.
`kind`	One of `own`, `third_party`.

Every field

Fields of the `saved_address` object

Fields of the saved_address object
Field	Type	Meaning
`id`	string	Unique identifier: the object prefix, an underscore, 24 lower-case Crockford base32 characters.
`object`	string	The type of this object.
`livemode`	boolean	`true` for live mode (real money); `false` for test mode (simulated payments).
`created`	string (date-time)	When the object was created. RFC 3339, UTC, milliseconds.
`label`	string	The merchant's name for the address.
`kind`	string	One of `own`, `third_party`.
`address`	string	The address itself.
`network`	string	The network the address is on.
`asset`	string or null	The one asset it may receive; `null` for any asset of its network.
`status`	string	One of `awaiting_approval`, `waiting`, `active`, `removed`.
`approved_by`	string or null	The member who approved it with a passkey; `null` until approved.
`approved_at`	string (date-time) or null	When it was approved; `null` until then.
`usable_at`	string (date-time) or null	A saved address can be paid from 24 hours after it was approved.
`screening`	object or null	The sanctions check of the address; `null` in test mode, which screens nothing.
`screening.id`	string	The `scr_` id of the check.
`screening.status`	string	The check's result.
`screening.checked_at`	string (date-time)	When the address was checked.
`approval_url`	string or null	The dashboard page where an Owner or Finance member approves it; `null` once it is approved or removed.
`metadata`	object	Up to 50 keys of your own data. Key up to 40 characters, value a string up to 500 characters. Never used by Orrerie; never put secrets or personal data here.

Endpoints

Events

Webhook events whose data.object is an object of this page.