---
title: "Two ways to build on Coinme"
url: "https://platformdocs.coinme.com/agents/surfaces.md"
markdown: "https://platformdocs.coinme.com/agents/surfaces.md"
summary: "The Coinme App Platform has two implementation surfaces: the Coinme Widget (a complete Ramp a transactional partner embeds, whose users become Coinme customers) and Coinme-as-a-Service (SDKs and services a partner with its own users composes into its own app). Who owns the user, who owns the transaction, which SDKs and credentials apply, and what each does not need."
---

# Two ways to build on Coinme

The Coinme App Platform has two implementation surfaces. They differ first in who owns the end user, and that decides which SDKs, credentials and responsibilities apply. Every SDK on this site belongs to exactly one of them, except an SDK that works the same on both, which is listed under each and in its own section below. Page front matter, `skills/index.json` and `versions.json` carry the same value as a `surface` field: `ramp`, `caas`, or `both`.

|  | Widget / Ramp integration | Coinme-as-a-Service (CaaS) integration |
| --- | --- | --- |
| For | For transactional partners: a partner that wants regulated crypto buying and selling inside its own product without building it. | For partners with their own user base and their own application, who want Coinme to perform regulated services for those users. |
| The end user | The end user is onboarded as a Coinme customer, inside the widget. Sign-in, KYC, payment and receipts all happen in the Coinme Widget. | The end users are the partner's customers. Coinme onboards them to CaaS and verifies them (KYC) as a service, and returns a `customerId`, but they are not Coinme consumer users and never see a Coinme app. |
| The transaction | The transaction belongs to the partner: the partner decides when the widget opens and can pre-fill and lock the amount, asset, payment method and destination wallet for the session. | The partner owns the user experience end to end and calls Coinme services from its own UI and backend. |
| Coinme provides | A complete application (a Ramp) composed by Orchestrator, with its flows, compliance rules, KYC, risk signals, payment rails and receipts. Coinme is the licensed money transmitter. | Services the partner composes: customer onboarding with non-documentary KYC, secure capture and vaulting of sensitive data such as card details and the SSN, device and behavioural risk signals, and the transactions themselves. |
| The partner builds | A container for the widget and the reaction to its events: an iframe on the web (Framekit), a view controller on iOS or a fragment on Android (CoinmeBridge). The Bridge Proxy is a backend-only variant with no live channel. | Its own screens and backend, with Coinme SDKs for the parts that must not touch partner code (secure fields), that feed Coinme systems (risk signals) or that apply Coinme's regional compliance rules in its screens (the Compliance SDK, in beta). Its backend calls the CaaS API directly or through the CaaS API clients for Node.js. |
| Choose it when | Choose it when the partner wants the whole experience supplied and its users can be Coinme customers. | Choose it when the partner keeps its own users, brand and flows and needs Coinme as a regulated back end. |

<a id="ramp"></a>

## Widget / Ramp integration

For transactional partners: a partner that wants regulated crypto buying and selling inside its own product without building it.

### SDKs

| SDK | Family | Platform | Package | Agent skill |
| --- | --- | --- | --- | --- |
| [Framekit](https://platformdocs.coinme.com/pages/build/web/overview.md) | Widget SDK | Web | `@coinme/coinme-bridge-framekit` | [coinme-widget-web](https://platformdocs.coinme.com/skills/coinme-widget-web/SKILL.md) |
| [CoinmeBridge for iOS](https://platformdocs.coinme.com/pages/build/native/ios/overview.md) | Widget SDK | iOS | `CoinmeBridge · Swift` | [coinme-widget-ios](https://platformdocs.coinme.com/skills/coinme-widget-ios/SKILL.md) |
| [CoinmeBridge for Android](https://platformdocs.coinme.com/pages/build/native/android/overview.md) | Widget SDK | Android | `CoinmeBridge · Kotlin` | [coinme-widget-android](https://platformdocs.coinme.com/skills/coinme-widget-android/SKILL.md) |
| [Wallet address validator](https://platformdocs.coinme.com/docs/wallet-address-validator.md) | Wallet addresses (both integrations) | Web | `@coinme/wallet-address-validator` | [coinme-wallet-address-validator](https://platformdocs.coinme.com/skills/coinme-wallet-address-validator/SKILL.md) |

### What you get from Coinme first

- **`rampId`**: Names the Ramp the widget loads; issued at onboarding.
- **`partnerKey`**: Identifies your app to the Widget in the bridge handshake. Native integrations need it; keep it in runtime configuration with your rampId.
- **Embed allowlist entry**: Every web hostname that embeds the widget must be added by Coinme. Local development hosts work against the stage Widget without an allowlist entry.
- **`COINME_REGISTRY_TOKEN`**: Read-only token for the private package registry that serves the Widget SDKs.

### What you do not need

The widget itself needs none of the Onboarding, Vault or Risk SDKs: it carries its own onboarding, card capture and risk signals inside its frame. The Risk SDK's session-tag call does accept an `x-ramp-id` header for Ramp partners; this site does not say when a Ramp partner also runs the Risk SDK outside the widget, so ask your Coinme integration contact before adding it.

### Read next

- [agents/ramp-reference.md](https://platformdocs.coinme.com/agents/ramp-reference.md): environments, everything to get from Coinme and how, platform requirements, go-live checklists
- [llms-widget.txt](https://platformdocs.coinme.com/llms-widget.txt)
- [llms-wallet.txt](https://platformdocs.coinme.com/llms-wallet.txt)
- [llms-testing.txt](https://platformdocs.coinme.com/llms-testing.txt)
- [skills/index.json](https://platformdocs.coinme.com/skills/index.json), filtered by `"surface": "ramp"` or `"surface": "both"`

<a id="caas"></a>

## Coinme-as-a-Service (CaaS) integration

For partners with their own user base and their own application, who want Coinme to perform regulated services for those users.

### SDKs

| SDK | Family | Platform | Package | Agent skill |
| --- | --- | --- | --- | --- |
| [Risk SDK for Web](https://platformdocs.coinme.com/docs/using-the-coinme-risk-sdk-for-web.md) | Risk SDK | Web | `@coinme-security/risk-sdk-js` | [coinme-risk-web](https://platformdocs.coinme.com/skills/coinme-risk-web/SKILL.md) |
| [Risk SDK for iOS](https://platformdocs.coinme.com/docs/risk-sdk-for-ios-native-apps.md) | Risk SDK | iOS | `CoinmeRisk · Swift` | [coinme-risk-ios](https://platformdocs.coinme.com/skills/coinme-risk-ios/SKILL.md) |
| [Risk SDK for Android](https://platformdocs.coinme.com/docs/risk-sdk-for-android-native-apps.md) | Risk SDK | Android | `CoinmeRisk · Kotlin` | [coinme-risk-android](https://platformdocs.coinme.com/skills/coinme-risk-android/SKILL.md) |
| [Risk SDK for React Native](https://platformdocs.coinme.com/docs/coinme-risk-sdk-for-react-native.md) | Risk SDK | React Native | `@coinme-security/risk-sdk-react-native` | [coinme-risk-react-native](https://platformdocs.coinme.com/skills/coinme-risk-react-native/SKILL.md) |
| [Vault SDK for JavaScript](https://platformdocs.coinme.com/docs/coinme-vault-sdk-for-javascript.md) | Vault SDK | Web | `@coinme-security/vault-sdk-js` | [coinme-vault-js](https://platformdocs.coinme.com/skills/coinme-vault-js/SKILL.md) |
| [Vault SDK for iOS](https://platformdocs.coinme.com/docs/coinme-vault-sdk-for-ios-native.md) | Vault SDK | iOS | `CoinmeVault · Swift` | [coinme-vault-ios](https://platformdocs.coinme.com/skills/coinme-vault-ios/SKILL.md) |
| [Vault SDK for Android](https://platformdocs.coinme.com/docs/coinme-vault-sdk-for-android-native.md) | Vault SDK | Android | `CoinmeVault · Kotlin` | [coinme-vault-android](https://platformdocs.coinme.com/skills/coinme-vault-android/SKILL.md) |
| [Vault SDK for React Native](https://platformdocs.coinme.com/docs/coinme-vault-sdk-for-react-native.md) | Vault SDK | React Native | `@coinme-security/vault-sdk-react-native` | [coinme-vault-react-native](https://platformdocs.coinme.com/skills/coinme-vault-react-native/SKILL.md) |
| [Onboarding SDK for JavaScript & React](https://platformdocs.coinme.com/docs/onboarding-sdk-react.md) | Onboarding SDK | Web | `@coinme-security/onboarding-sdk-react` | [coinme-onboarding-react](https://platformdocs.coinme.com/skills/coinme-onboarding-react/SKILL.md) |
| [Onboarding SDK for React Native](https://platformdocs.coinme.com/docs/onboarding-sdk-react-native.md) | Onboarding SDK | React Native | `@coinme-security/onboarding-sdk-react-native` | [coinme-onboarding-react-native](https://platformdocs.coinme.com/skills/coinme-onboarding-react-native/SKILL.md) |
| [Compliance SDK for JavaScript & React](https://platformdocs.coinme.com/docs/compliance-sdk-react.md) | Compliance SDK | Web | `@coinme-security/compliance-sdk-react` | [coinme-compliance-react](https://platformdocs.coinme.com/skills/coinme-compliance-react/SKILL.md) |
| [Compliance SDK for React Native](https://platformdocs.coinme.com/docs/compliance-sdk-react-native.md) | Compliance SDK | React Native | `@coinme-security/compliance-sdk-react-native` | [coinme-compliance-react-native](https://platformdocs.coinme.com/skills/coinme-compliance-react-native/SKILL.md) |
| [Core API client](https://platformdocs.coinme.com/docs/caas-core-api-client.md) | CaaS API clients | Server | `@coinme/core-api-client` | [coinme-caas-api-clients](https://platformdocs.coinme.com/skills/coinme-caas-api-clients/SKILL.md) |
| [Prove onboarding API client](https://platformdocs.coinme.com/docs/caas-prove-onboarding-api-client.md) | CaaS API clients | Server | `@coinme/prove-onboarding-api-client` | none yet |
| [Quotes API client](https://platformdocs.coinme.com/docs/caas-quotes-api-client.md) | CaaS API clients | Server | `@coinme/quotes-api-client` | none yet |
| [Transactions API client](https://platformdocs.coinme.com/docs/caas-transactions-api-client.md) | CaaS API clients | Server | `@coinme/transactions-api-client` | none yet |
| [History API client](https://platformdocs.coinme.com/docs/caas-history-api-client.md) | CaaS API clients | Server | `@coinme/history-api-client` | none yet |
| [Locations API client](https://platformdocs.coinme.com/docs/caas-locations-api-client.md) | CaaS API clients | Server | `@coinme/locations-api-client` | none yet |
| [Send API client](https://platformdocs.coinme.com/docs/caas-send-api-client.md) | CaaS API clients | Server | `@coinme/send-api-client` | none yet |
| [Custody API client](https://platformdocs.coinme.com/docs/caas-custody-api-client.md) | CaaS API clients | Server | `@coinme/custody-api-client` | none yet |
| [Cash ramp API client](https://platformdocs.coinme.com/docs/caas-cash-ramp-api-client.md) | CaaS API clients | Server | `@coinme/cash-ramp-api-client` | none yet |
| [Wallet address validator](https://platformdocs.coinme.com/docs/wallet-address-validator.md) | Wallet addresses (both integrations) | Web | `@coinme/wallet-address-validator` | [coinme-wallet-address-validator](https://platformdocs.coinme.com/skills/coinme-wallet-address-validator/SKILL.md) |

### What you get from Coinme first

- **Transient Auth Token**: 10-minute token the partner's backend mints at `POST /services/browserAuth` for each Onboarding submit, Onboarding phone verification call or Vault payment-method submit; never stored in the browser.
- **API client ID and client secret**: Exchanged by the partner's backend at `POST /services/authorize` for the partner access token that mints Transient Auth Tokens. Not the partner ID, and not the Risk SDK `clientId`.
- **`clientId`**: Identifies the integration to the Risk Engine; one per environment.
- **`x-partner-id`**: Partner identifier sent as a header on Risk session-tag requests.
- **partnerId and clientSecret**: The partner credentials the backend exchanges for a CaaS API bearer token (AuthService in the CaaS API clients); one pair per environment, kept in the server's secret store.
- **`COINME_CAAS_REGISTRY_TOKEN`**: Read-only token for the registry that serves the CaaS API clients (https://npm.coinme.com/coinme-caas/); not the same token as the SDK registry.
- **SDK registry token**: Read-only token for the private package registry that serves the SDKs; each guide's install steps name the environment variable they read.

### What you do not need

A CaaS integration does not embed the Coinme Widget. Each CaaS SDK is used on its own or together with the others in the partner’s own flows.

### Read next

- [agents/caas-reference.md](https://platformdocs.coinme.com/agents/caas-reference.md): environments, everything to get from Coinme and how, platform requirements, go-live checklists
- [llms-caas.txt](https://platformdocs.coinme.com/llms-caas.txt)
- [llms-onboarding.txt](https://platformdocs.coinme.com/llms-onboarding.txt)
- [llms-compliance.txt](https://platformdocs.coinme.com/llms-compliance.txt)
- [llms-vault.txt](https://platformdocs.coinme.com/llms-vault.txt)
- [llms-risk.txt](https://platformdocs.coinme.com/llms-risk.txt)
- [llms-api.txt](https://platformdocs.coinme.com/llms-api.txt)
- [llms-wallet.txt](https://platformdocs.coinme.com/llms-wallet.txt)
- [skills/index.json](https://platformdocs.coinme.com/skills/index.json), filtered by `"surface": "caas"` or `"surface": "both"`

<a id="both"></a>

## Both integrations (Widget / Ramp and CaaS)

These SDKs belong to neither surface alone. They run entirely in the partner's app, call no Coinme service and need no credential beyond the registry token that installs them, so a Widget / Ramp partner and a CaaS partner use them the same way. Their pages, skills and `versions.json` entries carry `surface: "both"`, and each is listed in both surfaces' SDK tables above.

| SDK | Family | Platform | Package | Agent skill | Slice |
| --- | --- | --- | --- | --- | --- |
| [Wallet address validator](https://platformdocs.coinme.com/docs/wallet-address-validator.md) | Wallet addresses | Web | `@coinme/wallet-address-validator` | [coinme-wallet-address-validator](https://platformdocs.coinme.com/skills/coinme-wallet-address-validator/SKILL.md) | [llms-wallet.txt](https://platformdocs.coinme.com/llms-wallet.txt) |
