ONE ramp:create
← Receivers

ramp:create

ramp family

Open an on-ramp for the caller, by kind. kind 'kyc': Begin, or reuse, the identity check an on-ramp needs, through VerifiedOnce (one.ie/web/src/lib/ramp/verify.ts): Bridge's hosted KYC link (door 1, Bridge re-verifies), or verify once with Sumsub and hand a one-use share token to a ramp that accepts it (Transak, Banxa, MoonPay), so the person is not asked twice. A signed-in person only; sandbox, closed by location. kind 'account': The caller's own bank details for a chain (a US account and routing number, or a euro IBAN) that pay out as USDC into the caller's PROVEN address for that chain, never a typed or payload address. Read back if already issued (last four only); issuing needs the provider (Bridge sandbox), refused by name until then. A signed-in person only; sandbox, closed by location. Was ramp:kyc and ramp:account until 2026-11-19 (each an alias for one release that carries its kind)

Effect
ask
Awaits an outcome — the call returns the response below.
Caller
owner
The class of authority the caller must already hold, decided from the attested context with no round trip.
Cost
free
What one call costs, so you can budget before acting.
Reversible
yes
The effect can be undone by a later call.
Idempotent
yes
Safe to retry as-is.
Version
1.0.0
Pin this to keep a contract stable; additive bumps never break callers.

Send it with your agent

One click hands your coding agent a prompt that registers the substrate, reads this contract, and makes the call. Launch opens the app; the others copy the prompt.

Claude Code
Codex
Cursor
Gemini CLI
Claude Desktop
ChatGPT
curl -X POST https://one.ie/api/ask/ramp:create \
  -H "Authorization: Bearer $ONE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"data": { "kind": "kyc" }}'

The key is never in a link. npx -y @oneie/cli login writes it to ~/.config/oneie/key on your machine.

Request

Validated before dispatch — an invalid payload is refused with the fix, never half-applied.

  • kind kyc | account required kyc = begin or reuse the identity check; account = the caller's own bank details that pay out as USDC
  • verifier bridge-kyc-link | sumsub-share optional kind kyc: which VerifiedOnce implementation: bridge-kyc-link (default, door 1) or sumsub-share (verify once, share by token)
  • recipient transak | banxa | moonpay optional kind kyc, sumsub-share only: the ramp the one-use share token is for (Transak and Banxa carry Sui USDC; MoonPay does not)
  • chain sui | base | solana optional kind account: where the USDC lands; default sui. The address is the caller's proven one for this chain (base reads the EVM proof)
  • rail us_ach | eu_sepa optional kind account: which bank details; default us_ach

Response

What comes back from the call.

  • ok boolean
  • step any kind kyc: {kind:'link', url} finish at the provider's page · {kind:'shared', recipient, expiresAt} · {kind:'verified'}
  • account object kind account
  • error string unauthenticated | person_only | blocked_location | bad_kind | recipient_required | bad_chain | bad_rail | address_not_proven | provider_not_configured | provider_error | no_db

Traffic

Every call to ramp:create, counted where it is dispatched — over HTTP or in-process alike. Aggregate only — no actor, no payload, no workspace.

Counting…

Wiring

Every place in the open source that names ramp:create, and the file that answers it. Read from the tree at build time — a receiver is reached by NAME through one door, so there is no import edge to follow and a grep is the honest shape of the question. Structure, not volume — the count is in Traffic above.

Called from

UI 1
  • one.ie/web/src/components/finance/map/stations.ts:157
API route 1
  • one.ie/web/src/lib/receiver-index.generated.ts:339
CLI 1
  • packages/cli/src/lib/money-receivers.ts:29
SDK 1
  • packages/sdk/src/receiver-layers.ts:852
→

Answered by

ramp:create one.ie/web/src/lib/resolvers/ramp.ts:130 Dispatched through POST /api/ask/ramp:create, after the envelope validates the payload.

ramp family · 2 more

JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "kind": {
      "type": "string",
      "enum": [
        "kyc",
        "account"
      ],
      "description": "kyc = begin or reuse the identity check; account = the caller's own bank details that pay out as USDC"
    },
    "verifier": {
      "description": "kind kyc: which VerifiedOnce implementation: bridge-kyc-link (default, door 1) or sumsub-share (verify once, share by token)",
      "type": "string",
      "enum": [
        "bridge-kyc-link",
        "sumsub-share"
      ]
    },
    "recipient": {
      "description": "kind kyc, sumsub-share only: the ramp the one-use share token is for (Transak and Banxa carry Sui USDC; MoonPay does not)",
      "type": "string",
      "enum": [
        "transak",
        "banxa",
        "moonpay"
      ]
    },
    "chain": {
      "description": "kind account: where the USDC lands; default sui. The address is the caller's proven one for this chain (base reads the EVM proof)",
      "type": "string",
      "enum": [
        "sui",
        "base",
        "solana"
      ]
    },
    "rail": {
      "description": "kind account: which bank details; default us_ach",
      "type": "string",
      "enum": [
        "us_ach",
        "eu_sepa"
      ]
    }
  },
  "required": [
    "kind"
  ]
}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean"
    },
    "step": {
      "description": "kind kyc: {kind:'link', url} finish at the provider's page · {kind:'shared', recipient, expiresAt} · {kind:'verified'}"
    },
    "account": {
      "description": "kind account",
      "type": "object",
      "properties": {
        "rail": {
          "type": "string"
        },
        "last4": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "chain": {
          "type": "string"
        },
        "destAddress": {
          "type": "string",
          "description": "The caller's proven address the USDC lands in"
        },
        "state": {
          "type": "string"
        },
        "test": {
          "type": "boolean",
          "description": "true = sandbox; never live money"
        }
      },
      "required": [
        "rail",
        "last4",
        "chain",
        "destAddress",
        "state",
        "test"
      ]
    },
    "error": {
      "description": "unauthenticated | person_only | blocked_location | bad_kind | recipient_required | bad_chain | bad_rail | address_not_proven | provider_not_configured | provider_error | no_db",
      "type": "string"
    }
  },
  "required": [
    "ok"
  ]
}