ONE ramp:kyc
← Receivers

ramp:kyc

ramp family

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.

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:kyc \
  -H "Authorization: Bearer $ONE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"data": {}}'

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.

  • verifier bridge-kyc-link | sumsub-share optional Which VerifiedOnce implementation: bridge-kyc-link (default, door 1) or sumsub-share (verify once, share by token)
  • recipient transak | banxa | moonpay optional sumsub-share only: the ramp the one-use share token is for (Transak and Banxa carry Sui USDC; MoonPay does not)

Response

What comes back from the call.

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

Traffic

Every call to ramp:kyc, 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:kyc, 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

API route 1
  • one.ie/web/src/lib/receiver-index.generated.ts:341
CLI 1
  • packages/cli/src/lib/money-receivers.ts:29
→

Answered by

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

ramp family · 3 more

JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "verifier": {
      "description": "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": "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"
      ]
    }
  }
}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean"
    },
    "step": {
      "description": "{kind:'link', url} finish at the provider's page · {kind:'shared', recipient, expiresAt} · {kind:'verified'}"
    },
    "error": {
      "description": "unauthenticated | person_only | blocked_location | recipient_required | provider_not_configured | provider_error",
      "type": "string"
    }
  },
  "required": [
    "ok"
  ]
}