# Coinme App Platform documentation > Documentation and developer guides for the Coinme App Platform. There are two ways to build on it: embed the Coinme Widget (the Widget / Ramp integration, with the Widget SDK for web, iOS and Android), or compose Coinme-as-a-Service into your own app (the CaaS integration, with the Onboarding, Vault and Risk SDKs). Each link below is a Markdown rendition of a page on platformdocs.coinme.com; the human pages are hash routes on the same site. The Skills sections list step-by-step procedures in the Agent Skills format for integrating each SDK. ## Orientation The Coinme App Platform is how other companies put regulated crypto buying, selling and moving inside their own products. Coinme is the licensed money transmitter and carries the licences, compliance and reporting. There are two ways to build on it. In the **Widget / Ramp** integration a transactional partner embeds the Coinme Widget, a complete crypto application (a Ramp) that Coinme composes from reusable flows; the transaction is the partner's and the end user is onboarded as a Coinme customer inside the widget. In the **Coinme-as-a-Service (CaaS)** integration a partner with its own users composes Coinme services into its own app with the Onboarding, Compliance, Vault and Risk SDKs, and its backend calls the CaaS API, directly or through the CaaS API clients, server-side convenience wrappers for Node.js; the users stay the partner's customers. What a Ramp offers is configuration, not code: it resolves at session start from the Ramp's remote configuration (keyed by its Ramp ID), the compliance rules of the user's region, and the session intent the partner sends. Read [the agent primer](https://platformdocs.coinme.com/agents/primer.md) first: a decision tree, a glossary, what an integrator touches versus internal architecture, what is shipped, and the table below in full. | If the question is | Read | | --- | --- | | What is the platform, which surface am I on, which SDKs do I need? | [The agent primer](https://platformdocs.coinme.com/agents/primer.md), then [agents/surfaces.md](https://platformdocs.coinme.com/agents/surfaces.md). | | How do I integrate SDK X on platform Y? | Its skill: [skills/index.json](https://platformdocs.coinme.com/skills/index.json) lists every skill with its surface, platform, package and version. | | Did my call succeed? What does this error code mean: fix, retry, or stop and ask? | [Reading results](https://platformdocs.coinme.com/agents/results.md): HTTP 200 is not success, the error envelope, common codes by what to do, lifetimes and limits, and what to send when something fails. | | Every document for one SDK | The [Library](https://platformdocs.coinme.com/pages/build/library.md), or that SDK's `llms-.txt` slice. | | Which `CoinmeConfig` fields exist, which are required, which can change mid-session? | The field table on [Build](https://platformdocs.coinme.com/pages/build/index.md#config). | | Which widget events will my app receive? | [Build](https://platformdocs.coinme.com/pages/build/index.md) for the four that need an answer; [How to use (web)](https://platformdocs.coinme.com/pages/build/web/how-to-use.md) for the typed set and forwarding. | | Bridge or Bridge Proxy? | [The bridge explainer](https://platformdocs.coinme.com/pages/explainers/bridges.md). | | Why does a user see (or not see) a rail, asset or disclosure? | [The configuration explainer](https://platformdocs.coinme.com/pages/explainers/configuration.md): base config, compliance overlay, session intent. | | In my own CaaS screens, which states can I offer, and which rails, assets, consents and disclosures apply in a region? | The [Compliance SDK](https://platformdocs.coinme.com/docs/coinme-compliance-sdk.md): its [JavaScript & React guide](https://platformdocs.coinme.com/docs/compliance-sdk-react.md) covers region status, the rule helpers, consents and disclosures, localized copy and attestations, with an end-to-end walkthrough. It is in beta and advisory. For a React Native app, its [React Native guide](https://platformdocs.coinme.com/docs/compliance-sdk-react-native.md) covers the same SDK, also in beta. | | How do I check a wallet address before sending, or before passing it to the widget? | The [wallet address validator](https://platformdocs.coinme.com/docs/wallet-address-validator.md) on either surface: `validateAddress` with `strict: true` and the asset's `chainType`, trimmed input, and the three outcomes (valid, invalid, unsupported) handled apart. [Supported assets and chains](https://platformdocs.coinme.com/docs/wallet-address-validator-supported-assets.md) lists every asset and chain it can validate; its skill is [coinme-wallet-address-validator](https://platformdocs.coinme.com/skills/coinme-wallet-address-validator/SKILL.md). | | What does a Ramp contain, and how is a new one stood up? | [The Orchestrator explainer](https://platformdocs.coinme.com/pages/explainers/orchestrator.md). | | Which credentials do I need from Coinme, and how do I get them? | The integrator reference for your surface: [Widget / Ramp](https://platformdocs.coinme.com/agents/ramp-reference.md) or [CaaS](https://platformdocs.coinme.com/agents/caas-reference.md). | | Which environments and hosts are there, and what do I set for each? | The integrator reference: [Widget / Ramp](https://platformdocs.coinme.com/agents/ramp-reference.md#environments) or [CaaS](https://platformdocs.coinme.com/agents/caas-reference.md#environments). | | Which version of an SDK is current, and is it released yet? | [SDK versions](https://platformdocs.coinme.com/pages/build/versions.md) lists every SDK's current release, generally available or beta (published, fine for development builds, not generally available), and the SDKs still in development; [versions.json](https://platformdocs.coinme.com/versions.json) has the same list as JSON. Each skill's front matter, and each page's, carries the same version and a `status: "beta"` where it applies. | | Which platform and framework versions are supported? | The integrator reference: [Widget / Ramp](https://platformdocs.coinme.com/agents/ramp-reference.md#platform-requirements) or [CaaS](https://platformdocs.coinme.com/agents/caas-reference.md#platform-requirements). | | What must change before going live? | The go-live checklists: [Widget / Ramp](https://platformdocs.coinme.com/agents/ramp-reference.md#go-live-checklists) or [CaaS](https://platformdocs.coinme.com/agents/caas-reference.md#go-live-checklists). | | How do I create a verified test customer in the stage Widget, and which test identities can I use? | [Creating Widget test accounts in stage](https://platformdocs.coinme.com/docs/widget-test-accounts.md) and [Test identities for Coinme KYC](https://platformdocs.coinme.com/docs/widget-test-identities.md); [Expected behavior in stage](https://platformdocs.coinme.com/docs/widget-stage-behavior.md) covers failed verification, test cards, cash locations and testnet use. The identities are fake and work wherever Coinme performs identity verification (KYC): in the Widget and in Coinme onboarding for CaaS partners (the Onboarding SDK's sandbox environment and the onboarding API). | | My web embed is deployed but does not load | [Doctor](https://platformdocs.coinme.com/pages/build/web/doctor.md) and the allowlist callout in [How to use (web)](https://platformdocs.coinme.com/pages/build/web/how-to-use.md). | | How does my backend get the token the Vault, Onboarding or Compliance SDK sends? | [Transient Auth Token](https://platformdocs.coinme.com/docs/transient-auth-token.md): exchange the API client ID and secret for a partner access token, then mint a 10-minute token per customer or sign-up session, with the scope of the call (`payment-methods`, `onboarding` or `attestations`, the last not available in the Compliance SDK beta at this time). Never pass the partner access token to the SDK; the `Authorization` header carries only the Transient Auth Token from `POST /services/browserAuth`. | | How does my backend link an onboarded customer to its own sign-up session? | [Example: linking onboarding to your backend session](https://platformdocs.coinme.com/docs/onboarding-sdk-session-example.md), a complete example of the two backend routes and the checks; the concepts are in the [Onboarding SDK guide](https://platformdocs.coinme.com/docs/onboarding-sdk-react.md#how-do-i-associate-an-onboarding-with-my-own-backend-session). | | Is there a REST API? How do I call CaaS from my backend? | [CaaS API clients](https://platformdocs.coinme.com/docs/caas-api-clients.md) for Node.js, one reference page per package, all in [llms-api.txt](https://platformdocs.coinme.com/llms-api.txt); the API reference itself is on docs.coinme.com, linked from that page. | | Pricing, supported assets or states, webhooks, support, release notes? | Not covered on this site: see [what is not covered](https://platformdocs.coinme.com/agents/primer.md#not-covered) and ask your Coinme integration contact. | | Is this a real transaction? Can I use it from my country? | [The FAQ](https://platformdocs.coinme.com/pages/explainers/faq.md). | **Not covered on this site** (ask your Coinme integration contact; details in [the primer](https://platformdocs.coinme.com/agents/primer.md#not-covered)): Supported assets, chains, countries and US states; Fees and pricing; Support and bug reporting; Changelog and release notes; Webhooks (registration, payload, signing, retries); Server-side transaction status; The Bridge Proxy API. ## Two ways to build on Coinme - [Widget / Ramp integration](https://platformdocs.coinme.com/agents/surfaces.md#ramp): For transactional partners: a partner that wants regulated crypto buying and selling inside its own product without building it. The end user is onboarded as a Coinme customer, inside the widget. Sign-in, KYC, payment and receipts all happen in the Coinme Widget. - [Coinme-as-a-Service (CaaS) integration](https://platformdocs.coinme.com/agents/surfaces.md#caas): For partners with their own user base and their own application, who want Coinme to perform regulated services for those users. 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. - [Both integrations (Widget / Ramp and CaaS)](https://platformdocs.coinme.com/agents/surfaces.md#both): SDKs that work the same on either surface and use neither one's credentials or services: Wallet addresses. They are listed in both surfaces' files below and carry `surface: "both"`. ## Files: Widget / Ramp integration - [llms-widget.txt](https://platformdocs.coinme.com/llms-widget.txt): Every page and skill for the Widget SDK in one file. Read this rather than llms-full.txt when you are integrating one SDK. - [llms-wallet.txt](https://platformdocs.coinme.com/llms-wallet.txt): Every page and skill for the Wallet addresses family in one file. Read this rather than llms-full.txt when you are integrating one SDK. Works on both surfaces. - [llms-testing.txt](https://platformdocs.coinme.com/llms-testing.txt): Every page for testing in stage in one file: the test identities for Coinme KYC, and the Widget test-account guide and expected behavior. ## Files: Coinme-as-a-Service (CaaS) integration - [llms-caas.txt](https://platformdocs.coinme.com/llms-caas.txt): Every page and skill of every CaaS SDK in one file. - [llms-risk.txt](https://platformdocs.coinme.com/llms-risk.txt): Every page and skill for the Risk SDK in one file. Read this rather than llms-full.txt when you are integrating one SDK. - [llms-vault.txt](https://platformdocs.coinme.com/llms-vault.txt): Every page and skill for the Vault SDK in one file. Read this rather than llms-full.txt when you are integrating one SDK. - [llms-onboarding.txt](https://platformdocs.coinme.com/llms-onboarding.txt): Every page and skill for the Onboarding SDK in one file. Read this rather than llms-full.txt when you are integrating one SDK. - [llms-compliance.txt](https://platformdocs.coinme.com/llms-compliance.txt): Every page and skill for the Compliance SDK in one file. Read this rather than llms-full.txt when you are integrating one SDK. In beta: Compliance SDK for JavaScript & React 1.1.3, Compliance SDK for React Native 1.0.2 (published and fine for development builds, not generally available; check with your Coinme integration contact before production). - [llms-api.txt](https://platformdocs.coinme.com/llms-api.txt): Every page and skill for the CaaS API clients in one file. Read this rather than llms-full.txt when you are integrating one SDK. - [llms-wallet.txt](https://platformdocs.coinme.com/llms-wallet.txt): Every page and skill for the Wallet addresses family in one file. Read this rather than llms-full.txt when you are integrating one SDK. Works on both surfaces. ## SDK versions - [versions.json](https://platformdocs.coinme.com/versions.json): The current release of every SDK, with its family, surface, platform, package and peer dependency ranges: the generally available ones, the beta ones (published, not generally available) and the SDKs in development with their status. The same list is the SDK versions page. ## Skills manifest - [skills/index.json](https://platformdocs.coinme.com/skills/index.json): Every skill with its description, surface, family, platform, package and version, and the URL of its SKILL.md. ## Start here - [Start here: the agent primer (definition, decision tree, glossary, routing)](https://platformdocs.coinme.com/agents/primer.md): Agent primer: the Coinme App Platform. Orientation for a coding agent new to Coinme: what the Coinme App Platform is, which of its two surfaces and which SDKs apply, the vocabulary the site uses, what an integrator touches versus internal architecture, what is shipped today, and which page answers which kind of question. - [Start here: Widget / Ramp or CaaS, the two ways to build on Coinme](https://platformdocs.coinme.com/agents/surfaces.md): Two ways to build on Coinme. 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. - [Start here: telling success from failure, error codes and what to do next](https://platformdocs.coinme.com/agents/results.md): Reading results: did the call work? How to tell whether a Coinme call succeeded: why HTTP 200 is not success, the error envelope, what each common error code asks you to do (fix the request, retry, clean up, or stop and ask), lifetimes and limits, confirming by reading back, what reruns collide with, and what to send your Coinme integration contact when something fails. - [Reference for the Widget / Ramp integration: environments, credentials, requirements, go-live](https://platformdocs.coinme.com/agents/ramp-reference.md): Integrator reference: Widget / Ramp integration. For the Widget / Ramp integration: every environment and host, everything to get from Coinme and how to request it, platform and framework requirements, a go-live checklist per SDK and platform, and what this site does not state. - [Reference for the Coinme-as-a-Service (CaaS) integration: environments, credentials, requirements, go-live](https://platformdocs.coinme.com/agents/caas-reference.md): Integrator reference: Coinme-as-a-Service (CaaS) integration. For the Coinme-as-a-Service (CaaS) integration: every environment and host, everything to get from Coinme and how to request it, platform and framework requirements, a go-live checklist per SDK and platform, and what this site does not state. - [Start here: the Coinme App Platform at a glance](https://platformdocs.coinme.com/pages/landing.md): Crypto payments, inside your app. Turnkey, compliant, regulated on and off ramps that live inside your product, so you focus on your business. Size the integration surface yourself: as loose as a hosted web frame, as tight as a native bridge. ## Explainers - [Explainers: index](https://platformdocs.coinme.com/pages/explainers/index.md): Many applications from shared parts. A layered platform for building crypto applications on top of Coinme. The transactional core is built once, decomposed into versioned parts, and composed at runtime into whatever a market or a partner needs. Start with the explainers; go to the build guides when you are ready to integrate. - [Explainer: The Coinme App Platform](https://platformdocs.coinme.com/pages/explainers/platform.md): Many applications from shared parts. A layered platform for building crypto applications on top of Coinme. The transactional core is built once, decomposed into versioned parts, and composed at runtime into whatever a market or a partner needs. - [Explainer: Orchestrator](https://platformdocs.coinme.com/pages/explainers/orchestrator.md): One widget runs the whole customer experience. Orchestrator is the application behind the Coinme Widget. It runs everything your customer does with Coinme, from identity verification to buying, selling and sending, as one experience. What it offers is set by your Ramp, a configuration Coinme sets up for you and identifies by a Ramp ID. A Ramp is a configuration, not a codebase. Pick one below and watch the same widget become a different application. - [Explainer: Configuration](https://platformdocs.coinme.com/pages/explainers/configuration.md): What a user can do is composed, not coded. Three inputs decide what any given person sees and can do in a session. None of them live in a branch inside the app. Change one input and the behavior changes with it, with no new build and no new code. - [Explainer: Flows](https://platformdocs.coinme.com/pages/explainers/flows.md): Features that travel. The Coinme Widget is made of flows. A flow is one complete part of the customer experience, such as identity verification, buying with a debit card, sending, or transaction history. Your Ramp decides which flows run. You never build or host a flow yourself. - [Explainer: The Bridge](https://platformdocs.coinme.com/pages/explainers/bridges.md): Two ways to embed the widget. The right choice depends on what you want your integration to do. The bridge keeps a live channel open between your app and the widget. The proxy opens no channel: it loads a fixed configuration as a URL and reports back through backend webhooks. This page lays out what that difference means, so you can pick the one that fits your goals. - [FAQ](https://platformdocs.coinme.com/pages/explainers/faq.md): FAQs. Questions that come up while reading the explainers or trying the demo apps, answered in a paragraph or two. ## Build - [Build: the Widget SDKs, the bridge, CoinmeConfig fields and events](https://platformdocs.coinme.com/pages/build/index.md): Drop in. Wire up. Transact. Web, iOS and Android each get a native SDK that loads the Coinme Widget, runs the bridge handshake and hands you typed events. The configuration you send and the events you receive are identical on all three. Get started in minutes not days. - [Library: every SDK and its documents](https://platformdocs.coinme.com/pages/build/library.md): Every SDK. Every document. One entry per SDK; each holds all of its documents, from the overview to the interface reference. Narrow by family, platform or document type, or just type. - [SDK versions](https://platformdocs.coinme.com/pages/build/versions.md): The current release of every Coinme SDK, generally available or in beta, and the SDKs still in development. Install the version listed here: it is the one this site documents. - [Build with an agent](https://platformdocs.coinme.com/pages/build/agents.md): Every page on this site is also published as plain Markdown from the same source, so a coding agent can read the real guides rather than a summary. Point it at the index, tell it what you are building, and it has what it needs, apart from the credentials only Coinme can give you. ## Widget / Ramp integration: Widget SDK on the web (framekit) - [Widget SDK on the web (framekit): Overview](https://platformdocs.coinme.com/pages/build/web/overview.md): Embed Coinme Widget with Framekit. This page demonstrates how the Coinme Widget can be embedded in a partner web application using the Coinme Framekit SDK. - [Widget SDK on the web (framekit): How it works](https://platformdocs.coinme.com/pages/build/web/how-it-works.md): One iframe, one SDK, the whole ramp. The widget in this demo is a full Coinme Orchestrator deployment running in an iframe. Framekit (@coinme/coinme-bridge-framekit) is the TypeScript SDK that puts it there and keeps a secure, typed message channel, the bridge, open between the host app and the widget. - [Widget SDK on the web (framekit): How to use](https://platformdocs.coinme.com/pages/build/web/how-to-use.md): From zero to embedded in six steps. Everything below is copy-paste ready. If you want the concepts behind it, read How it works; when your embed is up, verify it with the framekit-doctor CLI (see Doctor). - [Widget SDK on the web (framekit): Doctor](https://platformdocs.coinme.com/pages/build/web/doctor.md): Diagnose your integration from the command line. framekit-doctor ships with the SDK. It answers the two questions every integrator eventually asks: did I implement this correctly? and why doesn't my deployed integration work? Nothing to mount on your site, nothing to deploy; it runs from your terminal. If `framekit-doctor` is not found, update @coinme/coinme-bridge-framekit (the CLI ships with every stable release). ## Widget / Ramp integration: Widget SDK on iOS (CoinmeBridge) - [Widget SDK on iOS (CoinmeBridge): Overview](https://platformdocs.coinme.com/pages/build/native/ios/overview.md): The widget, inside your app. (iOS). CoinmeBridge loads the Orchestrator in a WebView, runs the bridge handshake, sends one configuration object and reports back through typed callbacks. You decide whether it takes the screen or sits inside your own chrome. - [Widget SDK on iOS (CoinmeBridge): How it works](https://platformdocs.coinme.com/pages/build/native/ios/how-it-works.md): One session, many purchases. (iOS). Create the SDK view once, keep it alive, and push each new purchase into it. This page walks through what your app does, what the SDK does, and what comes back. - [Widget SDK on iOS (CoinmeBridge): How to use](https://platformdocs.coinme.com/pages/build/native/ios/how-to-use.md): An afternoon to a first session. (iOS). Add the package, build a config, create the view, set the callback, and watch for session ready. Five steps; each one is a few lines. - [Widget SDK on iOS (CoinmeBridge): Patterns](https://platformdocs.coinme.com/pages/build/native/ios/patterns.md): What the demo app learned. (iOS). Six integration patterns lifted from the Coinme demo app, each with the SDK call it depends on, and the one lifecycle that outlives the session: cash barcodes. ## Widget / Ramp integration: Widget SDK on Android (CoinmeBridge) - [Widget SDK on Android (CoinmeBridge): Overview](https://platformdocs.coinme.com/pages/build/native/android/overview.md): The widget, inside your app. (Android). CoinmeBridge loads the Orchestrator in a WebView, runs the bridge handshake, sends one configuration object and reports back through typed callbacks. You decide whether it takes the screen or sits inside your own chrome. - [Widget SDK on Android (CoinmeBridge): How it works](https://platformdocs.coinme.com/pages/build/native/android/how-it-works.md): One session, many purchases. (Android). Create the SDK view once, keep it alive, and push each new purchase into it. This page walks through what your app does, what the SDK does, and what comes back. - [Widget SDK on Android (CoinmeBridge): How to use](https://platformdocs.coinme.com/pages/build/native/android/how-to-use.md): An afternoon to a first session. (Android). Add the package, build a config, create the view, set the callback, and watch for session ready. Five steps; each one is a few lines. - [Widget SDK on Android (CoinmeBridge): Patterns](https://platformdocs.coinme.com/pages/build/native/android/patterns.md): What the demo app learned. (Android). Six integration patterns lifted from the Coinme demo app, each with the SDK call it depends on, and the one lifecycle that outlives the session: cash barcodes. ## Widget / Ramp integration: Widget SDK documents - [Framekit quick start](https://platformdocs.coinme.com/docs/web-quick-start.md): A five-step integration of the Widget SDK for the web, `@coinme/coinme-bridge-framekit`. For a deeper walk-through see the integration guide. - [Framekit integration guide](https://platformdocs.coinme.com/docs/web-integration-guide.md): End-to-end reference for partners embedding the Coinme Widget in a web page with the Widget SDK for the web, `@coinme/coinme-bridge-framekit`. For the shortest path, start with the quick start. - [Quick Start for iOS](https://platformdocs.coinme.com/docs/ios-quick-start.md): Get CoinmeBridge running in your iOS app in 4 steps. - [CoinmeBridge for iOS: Integration Guide](https://platformdocs.coinme.com/docs/ios-integration-guide.md): Add Coinme's cryptocurrency purchase flow to your native iOS app in under 10 minutes. - [Quick Start for Android](https://platformdocs.coinme.com/docs/android-quick-start.md): Get CoinmeBridge running in your Android app in 4 steps. - [CoinmeBridge for Android: Integration Guide](https://platformdocs.coinme.com/docs/android-integration-guide.md): Add Coinme's cryptocurrency purchase flow to your native Android app in under 10 minutes. ## Coinme-as-a-Service (CaaS) integration: Risk SDK documents - [Coinme Risk SDK](https://platformdocs.coinme.com/docs/coinme-risk-sdk.md): The Coinme Risk SDKs integrate your application with the Coinme Risk Engine — a system that aggregates device, location, connection, and behavioral data to assess the risk of users and transactions in real time. This allows Coinme to detect fraud signals such as automation, VPN usage, and suspicious interaction patterns before processing a transaction. - [Coinme Risk SDK for Web](https://platformdocs.coinme.com/docs/using-the-coinme-risk-sdk-for-web.md): The Coinme Risk Engine SDK is a library, distributed as an NPM package, that allows you to interact with the Coinme Risk Engine from your application. It provides utilities that allow you to integrate against the Coinme risk engine for the various transactional flows in your application so that Coinme may appropriately assess transactional risk when processing transactions. - [Coinme Risk SDK for iOS Native Apps](https://platformdocs.coinme.com/docs/risk-sdk-for-ios-native-apps.md): The iOS Coinme Risk Engine SDK is a Swift library, distributed privately via Cloudsmith, that allows you to interact with the Coinme Risk Engine from your application. It provides utilities that allow you to integrate against the Coinme risk engine for the various transactional flows in your application so that Coinme may appropriately assess transactional risk when processing transactions. - [Coinme Risk SDK for Android Native Apps](https://platformdocs.coinme.com/docs/risk-sdk-for-android-native-apps.md): The Android Coinme Risk Engine SDK is a Kotlin library, distributed privately via Cloudsmith, that allows you to interact with the Coinme Risk Engine from your application. It provides utilities that allow you to integrate against the Coinme risk engine for the various transactional flows in your application so that Coinme may appropriately assess transactional risk when processing transactions. - [Coinme Risk SDK for React Native](https://platformdocs.coinme.com/docs/coinme-risk-sdk-for-react-native.md): Real-time fraud detection and risk assessment for React Native apps; a thin native-module bridge over Coinme's production iOS and Android risk SDKs, exposed as a typed JS/TS API. ## Coinme-as-a-Service (CaaS) integration: Vault SDK documents - [Coinme Vault SDK](https://platformdocs.coinme.com/docs/coinme-vault-sdk.md): The Coinme Vault SDK lets your application collect sensitive information like payment card data - card number, expiry, CVC, cardholder name, and billing address - without any of those values ever touching your code, your logs, or your servers. Data is entered into secure input fields managed by the SDK and travels directly to Coinme's PCI-compliant vault; your application receives only a confirmation response and non-sensitive metadata (such as a payment card's last four digits and brand). - [Coinme Vault SDK for Javascript](https://platformdocs.coinme.com/docs/coinme-vault-sdk-for-javascript.md): `@coinme-security/vault-sdk-js` is a typed, framework-agnostic JavaScript wrapper that lets any web app capture debit card data - card number, expiry, CVC, billing address, and other sensitive values - without those values ever touching your JavaScript, your DOM, your logs, or your backend. You render containers for the secure fields; the SDK mounts VGS-hosted inputs into them; your code receives only a confirmation response. - [Coinme Vault SDK for iOS Native](https://platformdocs.coinme.com/docs/coinme-vault-sdk-for-ios-native.md): The Coinme Vault SDK for iOS is a Swift SDK that wraps the VGS Collect iOS SDK, pre-binds Coinme's VGS vault configuration, and exposes a small, secure data-collection API. It lets your application securely collect sensitive card and payment-method data (card number, expiry, CVV, cardholder name, billing address) and submit it directly to Coinme's vault without that data ever entering your application process. - [Coinme Vault SDK for Android Native](https://platformdocs.coinme.com/docs/coinme-vault-sdk-for-android-native.md): The Coinme Vault SDK is a Kotlin library for Android that wraps the VGS Collect Android SDK, pre-binds Coinme's VGS vault configuration, and exposes a small, secure data-collection API. It lets your application securely collect sensitive card and payment-method data (card number, expiry, CVV, cardholder name, billing address) and submit it directly to Coinme's vault without that data ever entering your application process. - [Coinme Vault SDK for React Native](https://platformdocs.coinme.com/docs/coinme-vault-sdk-for-react-native.md): `@coinme-security/vault-sdk-react-native` is a typed JavaScript wrapper that lets your React ## Coinme-as-a-Service (CaaS) integration: Onboarding SDK documents - [Coinme Onboarding SDK](https://platformdocs.coinme.com/docs/coinme-onboarding-sdk.md): The Coinme Onboarding SDK onboards a new customer to Coinme-as-a-Service (CAAS) from your own application and takes them through non-documentary KYC. Identity is verified from the details the customer types, with no document upload: your app collects email, name, address, phone and date of birth in ordinary inputs, the Social Security Number goes into a secure field hosted by the Coinme Vault, and the SDK submits everything to Coinme and hands you back the new `customerId`. It then verifies the customer's phone with a code texted to the number they onboarded with; until that code checks out, the customer has not completed KYC. - [Onboarding SDK for JavaScript & React](https://platformdocs.coinme.com/docs/onboarding-sdk-react.md): The Coinme Onboarding SDK onboards a customer to Coinme-as-a-Service (CAAS) from your web app, returns the new `customerId`, and then verifies the customer's phone with a code texted to the number they onboarded with. Use it from a React app through its drop-in form, field components and hooks, or from any JavaScript web app (vanilla JS, Vue, Angular, Svelte, …) through the framework-agnostic core the React layer is built on; see Core API (without React). Either way it is the one package, `@coinme-security/onboarding-sdk-react`. - [Example: linking onboarding to your backend session](https://platformdocs.coinme.com/docs/onboarding-sdk-session-example.md): A complete example of the pieces you build to link an onboarded customer to your backend's sign-up session: the token endpoint, the completion endpoint with the recommended checks, the frontend that calls them, and the database table. - [Onboarding SDK for React Native](https://platformdocs.coinme.com/docs/onboarding-sdk-react-native.md): The Coinme Onboarding SDK for React Native onboards a customer to Coinme-as-a-Service (CAAS) from your iOS or Android app built with React Native, returns the new `customerId`, and then verifies the customer's phone with a code texted to the number they onboarded with. It is one package, `@coinme-security/onboarding-sdk-react-native`, with the same drop-in form, field components and hooks as the JavaScript & React SDK, built from native components. - [Onboarding SDK examples](https://platformdocs.coinme.com/docs/onboarding-sdk-examples.md): Every way to put the Onboarding SDK on a page, each as the code you would write and the form it produces. The forms are live: the secure SSN field is the real vault field, and submits are simulated, so nothing reaches Coinme. ## Coinme-as-a-Service (CaaS) integration: Compliance SDK documents - [Coinme Compliance SDK](https://platformdocs.coinme.com/docs/coinme-compliance-sdk.md): The Coinme Compliance SDK gives your own application the compliance rules Coinme applies in each jurisdiction, so your screens can follow them instead of re-implementing them: which regions Coinme operates in and where new customers can onboard, which payment rails, operations and assets a region excludes, which consents and transactional disclosures a customer must see, which custom receipt applies, the localized text of each, and a record of what the customer accepted. - [Compliance SDK for JavaScript & React](https://platformdocs.coinme.com/docs/compliance-sdk-react.md): The Coinme Compliance SDK gives your web app the compliance rules Coinme applies in each jurisdiction, so you can apply them in your own interface instead of re-implementing them. Use it from a React app through its provider and hooks, or from any JavaScript app through the framework-agnostic core the React layer is built on. Either way it is the one package, `@coinme-security/compliance-sdk-react`. - [Compliance SDK for React Native](https://platformdocs.coinme.com/docs/compliance-sdk-react-native.md): The Coinme Compliance SDK for React Native gives your iOS or Android app built with React Native the compliance rules Coinme applies in each jurisdiction, so you can apply them in your own screens instead of re-implementing them. It is one package, `@coinme-security/compliance-sdk-react-native`, with the same rules, provider and hooks as the JavaScript & React SDK, and a native component for the compliance copy. ## Coinme-as-a-Service (CaaS) integration: CaaS API clients documents - [CaaS API clients](https://platformdocs.coinme.com/docs/caas-api-clients.md): The CaaS API clients are typed TypeScript packages for calling the Coinme-as-a-Service (CAAS) API from your backend. Each package wraps one area of the API, so instead of building requests by hand you call a method such as `getTransactionalQuote` or `send`, and you get back typed data or a typed error. - [Transient Auth Token](https://platformdocs.coinme.com/docs/transient-auth-token.md): The Vault SDK and the Onboarding SDK submit straight from the customer's browser or app to Coinme, so card numbers and Social Security Numbers never touch your code or your servers, and the Compliance SDK's attestation store reads and records what a customer accepted the same way. Those calls need a credential, and your partner access token is far too powerful to put in a web page or an app. The Transient Auth Token is the credential they carry instead: your backend trades its partner access token for a token that can make one kind of call, for one customer, for ten minutes. - [Core API client](https://platformdocs.coinme.com/docs/caas-core-api-client.md): The `@coinme/core-api-client` package provides a client for interacting with the Coinme Core APIs, including authentication and data retrieval. - [Prove onboarding API client](https://platformdocs.coinme.com/docs/caas-prove-onboarding-api-client.md): The `@coinme/prove-onboarding-api-client` package provides a client for interacting with the Coinme Prove Onboarding APIs. - [Quotes API client](https://platformdocs.coinme.com/docs/caas-quotes-api-client.md): The `@coinme/quotes-api-client` package provides a client for interacting with the Coinme Quotes APIs. - [Transactions API client](https://platformdocs.coinme.com/docs/caas-transactions-api-client.md): The `@coinme/transactions-api-client` package provides a client for interacting with the Coinme Transactions APIs. - [History API client](https://platformdocs.coinme.com/docs/caas-history-api-client.md): The `@coinme/history-api-client` package provides a client for interacting with the Coinme History APIs. - [Locations API client](https://platformdocs.coinme.com/docs/caas-locations-api-client.md): The `@coinme/locations-api-client` package provides a client for interacting with the Coinme Locations APIs. - [Send API client](https://platformdocs.coinme.com/docs/caas-send-api-client.md): The `@coinme/send-api-client` package provides a client for interacting with the Coinme Send APIs. - [Custody API client](https://platformdocs.coinme.com/docs/caas-custody-api-client.md): The `@coinme/custody-api-client` package provides a client for interacting with the Coinme custody APIs: customer wallets, sends to external wallets, and the partner's own (enterprise) balances. It covers the custody operations in one client. - [Cash ramp API client](https://platformdocs.coinme.com/docs/caas-cash-ramp-api-client.md): The `@coinme/cash-ramp-api-client` package provides a client for interacting with the Coinme cash on and off ramp APIs: cash locations and order templates. An order template is the barcode a customer presents at a cash location to buy or sell crypto with cash. ## Both integrations (Widget / Ramp and CaaS): Wallet addresses documents - [Wallet address validator](https://platformdocs.coinme.com/docs/wallet-address-validator.md): Check that a cryptocurrency wallet address is well-formed before you store it or send funds to it. One typed function covers 160+ coins and tokens across more than 60 chains. It runs offline with zero runtime dependencies and works the same in the browser, Node.js, and React Native. - [Wallet address validator: supported assets and chains](https://platformdocs.coinme.com/docs/wallet-address-validator-supported-assets.md): Every chain and asset the wallet address validator accepts, from the same registry `validateAddress` uses. The same data is available at runtime from `getSupportedAssets()` and `getSupportedChains()`, and the package carries this list as `docs/supported-assets.md`. ## Widget / Ramp integration: Testing documents - [Creating Widget test accounts in stage](https://platformdocs.coinme.com/docs/widget-test-accounts.md): How to sign up a test customer inside the stage Coinme Widget and take them through identity verification, so you can test your integration end to end without a real person's details. - [Test identities for Coinme KYC](https://platformdocs.coinme.com/docs/widget-test-identities.md): Fake customer identities for testing Coinme's identity verification (KYC). In the Coinme Widget, use them with Creating Widget test accounts in stage. - [Expected behavior in stage](https://platformdocs.coinme.com/docs/widget-stage-behavior.md): What to expect when you test a Widget integration in stage, so a result that looks like a bug can be told apart from stage working as designed. ## Skills: Widget / Ramp integration - [Coinme Widget on the web with framekit](https://platformdocs.coinme.com/skills/coinme-widget-web/SKILL.md): Embed the Coinme Widget in a web app with @coinme/coinme-bridge-framekit: install from the private registry, mount CoinmeFrame (React) or createCoinmeFrame (plain script), handle typed events, change settings live, and verify with the Doctor checks. Use when asked to add, embed, integrate or scaffold the Coinme widget on a website or web app. - [Coinme Widget on iOS with CoinmeBridge](https://platformdocs.coinme.com/skills/coinme-widget-ios/SKILL.md): Integrate the Coinme Widget into an iOS app with the CoinmeBridge Swift package: add the package, build a CoinmeConfig, create the CoinmeViewController once, implement the four-method delegate, and verify the session becomes ready. Use when asked to add, embed, integrate or scaffold the Coinme widget in an iOS, Swift, UIKit or SwiftUI app. - [Coinme Widget on Android with CoinmeBridge](https://platformdocs.coinme.com/skills/coinme-widget-android/SKILL.md): Integrate the Coinme Widget into an Android app with the CoinmeBridge Kotlin library: add the Gradle dependency and permissions, build a CoinmeConfig, create the fragment once, implement the four-method listener, and verify the session becomes ready. Use when asked to add, embed, integrate or scaffold the Coinme widget in an Android or Kotlin app. ## Skills: Coinme-as-a-Service (CaaS) integration - [Customer onboarding in a web app with the Onboarding SDK](https://platformdocs.coinme.com/skills/coinme-onboarding-react/SKILL.md): Add Coinme customer onboarding with non-documentary KYC to a React or JavaScript web app using @coinme-security/onboarding-sdk-react: install from the private registry, render the drop-in CustomerOnboardingForm or compose the headless pieces, supply the onboarding token through getHeaders, link the returned customerId to the backend's sign-up session, verify the customer's phone with PhoneVerificationStep, handle CoinmeOnboardingError kinds, and verify in sandbox. Use when asked to onboard customers, collect KYC or SSN securely, verify a new customer's phone, or integrate the Coinme Onboarding SDK. - [Customer onboarding in a React Native app with the Onboarding SDK](https://platformdocs.coinme.com/skills/coinme-onboarding-react-native/SKILL.md): Add Coinme customer onboarding with non-documentary KYC to an iOS or Android app built with React Native or Expo using @coinme-security/onboarding-sdk-react-native: install it and its @vgs/collect-react-native peer from the private registry, render the drop-in CustomerOnboardingForm or compose the headless pieces, supply the onboarding token through getHeaders, link the returned customerId to the backend's sign-up session, verify the customer's phone with PhoneVerificationStep, handle CoinmeOnboardingError kinds, and verify in sandbox on both platforms. Use when asked to onboard customers, collect KYC or SSN securely, verify a new customer's phone, or integrate the Coinme Onboarding SDK in a React Native or Expo app. - [Coinme compliance rules in a web app with the Compliance SDK](https://platformdocs.coinme.com/skills/coinme-compliance-react/SKILL.md): Apply Coinme's regional compliance rules in a React or JavaScript web app using @coinme-security/compliance-sdk-react: install the 1.1.3 beta from the private registry, mount ComplianceProvider, gate on getRegionStatus (ISO 3166-2 region codes only, unknown fails closed), offer only onboardable states, find missing consents and the disclosures to present, render Coinme's localized copy with ComplianceHtml, record attestations after onboarding with an attestation store authorized by the backend, and check each transaction with evaluateTransaction. Use when asked about state or jurisdiction availability, consents, disclosures, custom receipts, attestations or the Coinme Compliance SDK. - [Coinme compliance rules in a React Native app with the Compliance SDK](https://platformdocs.coinme.com/skills/coinme-compliance-react-native/SKILL.md): Apply Coinme's regional compliance rules in a React Native or Expo app (iOS and Android) using @coinme-security/compliance-sdk-react-native: install the 1.0.2 beta from the private registry, create the platform with createNativePlatform and a store such as AsyncStorage, mount ComplianceProvider, gate on getRegionStatus (ISO 3166-2 region codes only, unknown fails closed), offer only onboardable states, find missing consents and the disclosures to present, render Coinme's localized copy with ComplianceText, record attestations after onboarding with an attestation store authorized by the backend, and check each transaction with evaluateTransaction. For a React or JavaScript web app use the coinme-compliance-react skill. Use when asked about state or jurisdiction availability, consents, disclosures, attestations or the Coinme Compliance SDK in a React Native app. - [Coinme Risk SDK on the web](https://platformdocs.coinme.com/skills/coinme-risk-web/SKILL.md): Add the Coinme Risk SDK to a web app: install from the private registry, set up the Risk Engine with the client ID, tag the inputs it should observe, and get a session tag right before each add-payment-method call and each order. Use when asked to add risk, fraud or device signals, a session tag or the Coinme Risk Engine to a website or web app. - [Coinme Risk SDK on iOS](https://platformdocs.coinme.com/skills/coinme-risk-ios/SKILL.md): Add the Coinme Risk SDK to an iOS app: add the dependency, meet the App Store privacy and permission requirements, initialise the engine with the client ID, track inputs, and submit data before every transaction. Use when asked to add risk, fraud or device signals or the Coinme Risk Engine to an iOS, Swift or SwiftUI app. - [Coinme Risk SDK on Android](https://platformdocs.coinme.com/skills/coinme-risk-android/SKILL.md): Add the Coinme Risk SDK to an Android app: add the repository and dependency, meet the Google Play data-safety and permission requirements, configure ProGuard, initialise the engine with the client ID, track inputs, and submit data before every transaction. Use when asked to add risk, fraud or device signals or the Coinme Risk Engine to an Android or Kotlin app. - [Coinme Risk SDK in React Native](https://platformdocs.coinme.com/skills/coinme-risk-react-native/SKILL.md): Add the Coinme Risk SDK to a React Native or Expo app: install the package and its native setup on both platforms, honour the fingerprint contract, use the tracked inputs, and submit data before every transaction. Use when asked to add risk, fraud or device signals or the Coinme Risk Engine to a React Native or Expo app. - [Coinme Vault SDK in JavaScript](https://platformdocs.coinme.com/skills/coinme-vault-js/SKILL.md): Add card capture to a web app with the Coinme Vault SDK: install from the private registry, mount secure fields, style and validate them, and submit the payment method to Coinme with the transient auth token. Use when asked to collect card details, add a payment method or integrate Coinme's vault in a website or web app, in plain JavaScript, React, Vue or an SSR framework. - [Coinme Vault SDK on iOS](https://platformdocs.coinme.com/skills/coinme-vault-ios/SKILL.md): Add card capture to an iOS app with the Coinme Vault SDK: add the package, configure the vault, build and bind the secure fields, observe form state, and submit the payment method to Coinme with the transient auth token. Use when asked to collect card details, add a payment method or integrate Coinme's vault in an iOS or Swift app. - [Coinme Vault SDK on Android](https://platformdocs.coinme.com/skills/coinme-vault-android/SKILL.md): Add card capture to an Android app with the Coinme Vault SDK: add the repository and dependency, configure the vault, build the fields in Kotlin, XML or Compose, observe form state, and submit the payment method to Coinme with the transient auth token. Use when asked to collect card details, add a payment method or integrate Coinme's vault in an Android or Kotlin app. - [Coinme Vault SDK in React Native](https://platformdocs.coinme.com/skills/coinme-vault-react-native/SKILL.md): Add card capture to a React Native or Expo app with the Coinme Vault SDK: install the packages, wrap the app in the provider, use the secure field components and hooks, and submit the payment method to Coinme with the transient auth token. Use when asked to collect card details, add a payment method or integrate Coinme's vault in a React Native or Expo app. - [Coinme CaaS API clients on a Node.js server](https://platformdocs.coinme.com/skills/coinme-caas-api-clients/SKILL.md): Call the Coinme-as-a-Service API from a Node.js backend with version 2 of the typed @coinme CaaS API clients: install 2.x from the private registry, create one AuthService per partner and environment, construct the client for each area of the API with the environment base URL, and handle APIError. Use when asked to integrate Coinme CaaS, CAAS or Coinme-as-a-Service onboarding, quotes, transactions or history into a server, or to move an integration off the deprecated 1.x clients. ## Skills: Both integrations (Widget / Ramp and CaaS) - [Wallet address validation with the wallet address validator](https://platformdocs.coinme.com/skills/coinme-wallet-address-validator/SKILL.md): Check that a cryptocurrency wallet address is well-formed for its asset and chain before the app stores it or sends funds to it, using @coinme/wallet-address-validator: install from the private registry, call validateAddress in strict mode with chainType for multi-chain assets such as USDC and USDT, trim the input, treat valid, invalid and unsupported differently, and check the app's asset list with isSupported at startup. Offline and format-only, for browsers, Node.js and React Native, on both the Widget and the CaaS integrations. Use when asked to validate, check or verify a wallet, crypto or destination address, or to add the Coinme wallet address validator.