For the complete documentation index, see llms.txt. This page is also available as Markdown.

What UR configures for you

The settings UR provisions for you out of band, and which ones you can read back through an API.

Some of your integration is controlled by the APIs you call. The rest is configured by UR when you onboard, through your dedicated integration channel, and is not exposed as a self-serve API. This page lists every setting in that second group in one place, says who decides it and how it is set, and tells you whether you can read it back through an API.

UR is a regulated financial product. The settings on this page carry compliance, custody, and settlement consequences, so UR provisions them per partner during onboarding rather than exposing them as runtime API calls. That keeps the boundary auditable on both sides.

The practical takeaway: record every option you confirm during onboarding and treat your own record as the source of truth. You can read a few of these settings back from an API (see Reading your configuration back); most you cannot, so do not rely on discovering them at runtime.

This page is a boundary reference. It does not repeat how each mode works; each row links to the page that owns the detail. For how to pick your options in the first place, see Choose your integration options.

The boundary at a glance

You control at runtime via API
UR configures out of band

Create accounts and URIDs; create and freeze cards; set a card's default currency; pay-in, payout, FX, off-ramp; per-swipe authorization decisions (Crypto Backed)

Which Account Mode, Card Mode, and KYC Mode you run; your partnerId and signing key; your webhook and authorization callback URLs; Prefund Account setup and settlement rules; spending limits and regional eligibility

What UR configures

Account and identity

Setting
Who decides
When and how it is set
Readable via API?

Account Mode (Managed Custody, External Wallet Access, legacy Delegated)

You, confirmed with UR

Fixed at onboarding; it determines which API surface and signing model you use

No. Record it yourself

partnerId

UR issues it

Created with your key in the API sandbox, or issued when you register your own address with UR; it scopes every API call

You hold it (issued to you)

API signing key and rotation

You hold the key; UR registers the address

Create it in the API sandbox (self-serve), or generate it yourself and register the address through your integration channel; rotate by registering a new address and deregistering the old one

You hold it

Webhook URL

You, registered by UR

Registered during setup; changes are coordinated with UR, with no self-serve endpoint

No

Sandbox access and test-to-live promotion

UR team

Requested through the UR team before production

Not applicable (environment state)

See Choose your integration options for the Account Mode comparison, API signing key for the key lifecycle, and API authentication for the signing algorithm.

Card

Setting
Who decides
When and how it is set
Readable via API?

Card Mode (Fiat Only, Crypto Backed, No card)

You, confirmed with UR

Fixed at onboarding and configured onto the account by UR; there is no API to enable it

No. Record it yourself

Co-branded card artwork

You submit; UR approves

Submitted through your integration channel; UR reviews against Mastercard brand standards

Not applicable (submission)

See Card Mode and Co-branded card artwork. The runtime card endpoints (create card, get card info, set default currency, freeze) live in your Account Mode reference, for example Managed Custody Mode.

Crypto Backed card

These apply only if your Card Mode is Crypto Backed.

Setting
Who decides
When and how it is set
Readable via API?

Prefund Account provisioning

UR provisions

After you complete KYB; one account per partner

Balance is readable via GET /api/fma/v1/prefund-balance

Settlement currency

You, agreed with UR

Agreed before onboarding; defaults to USD

Yes; the Prefund Balance response exposes a single currency

Settlement mode (fixed or partner_controlled)

You, agreed with UR

Chosen during onboarding

No; the Prefund Balance response does not include a settleMode field; record it from onboarding

Minimum balance

You, agreed with UR

Agreed during onboarding

Yes, as minBalance in the Prefund Balance response

Off-ramp chain and deposit currency

You, agreed with UR

Agreed during onboarding; USDC is the only deposit currency today

No

Card authorization callback URL

You, registered by UR

Registered during onboarding; changes are coordinated with UR, with no self-serve endpoint

No

See the Crypto Backed card reference, the Prefund Balance endpoint, and settlement modes.

KYC

Setting
Who decides
When and how it is set
Readable via API?

KYC Mode (UR-hosted webview, Sumsub SDK in your app, Sumsub reuse)

You, confirmed with UR

Confirmed at onboarding

No. Record it yourself

Sumsub reuse setup (Donor / Recipient partners, DPA)

You and UR

Configured in the Sumsub dashboard, plus a Data Processing Agreement, before the first user flows through

Not applicable (legal and dashboard setup)

See KYC Mode for the integration contract and KYC & compliance for what UR verifies.

Compliance and limits

Setting
Who decides
When and how it is set
Readable via API?

Monthly spending limit

UR sets it

Set per compliance tier when the account goes Live; the default for KYC-verified users is 30,000 CHF. A higher limit requires additional verification (Enhanced Due Diligence) and is coordinated with UR

Yes, via the on-chain limit query and the monthly_limit_exceeded webhook

Supported regions, restricted nationalities, account eligibility

UR maintains and enforces

Enforced during the account opening flow; you do not enforce it on your side

UR enforces at account opening; the list is published

See Supported regions for the country and nationality lists, Smart contracts for the on-chain limit query, and Webhooks for limit events.

Reading your configuration back

Only some of the settings above can be read back through an API. Plan your integration around that split.

Readable via API

  • Prefund Account state: GET /api/fma/v1/prefund-balance returns the account's currency, balance, minBalance, level, and allowance (a single settlement currency; it does not return settleMode). Treat it as the source of truth for balance and threshold rather than hardcoding them. See the Prefund Balance endpoint.

  • Spending limit: read the on-chain limit query for a user (returns used and total limit and the cycle start), and subscribe to the monthly_limit_exceeded webhook. See Smart contracts and Webhooks.

Not exposed; record it yourself

Your Account Mode, your per-account Card Mode, your webhook URL, your authorization callback URL, and your KYC Mode are not returned by any API. Account and card creation calls do not echo them back. Keep your own record of what you confirmed at onboarding, and treat that record as authoritative.

Changing a setting after go-live

Every setting on this page changes through your dedicated integration channel. There are no self-serve endpoints for them, by design, so the change stays auditable. Confirm any change with UR before you rely on it in production; for URL changes (webhook or authorization callback), the switch is paired with signature validation so events keep verifying.

Where to read more

Last updated