---
title: "Coinme Compliance SDK"
url: "https://platformdocs.coinme.com/#/docs/coinme-compliance-sdk"
markdown: "https://platformdocs.coinme.com/docs/coinme-compliance-sdk.md"
summary: "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."
surface: "caas"
updated: "2026-11-04"
---

# Coinme Compliance SDK

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.

> **Beta.**
>
> Both packages are published and installable (1.1.3 for JavaScript & React, 1.0.2 for React Native), but the Compliance SDK is not generally available yet: the interface can still change and not all functionality is guaranteed. You can use it in development builds but check with your Coinme integration contact before taking it to production.

## Why use it

Coinme is the licensed money transmitter, and the rules it follows differ by region: a state may exclude a payment rail or an asset, require a session consent before a customer transacts, require a disclosure before a particular kind of transaction, or require a custom receipt. A partner that builds its own screens on Coinme-as-a-Service needs those screens to match. Without the SDK that means keeping a copy of the rules by hand and noticing every time they change.

The SDK loads the rules from Coinme and keeps them current while your app runs, so a change Coinme makes reaches your screens without a release. It also applies them the way Coinme does: a region excluding a whole operation excludes every one of its channels, an asset excluded by its base symbol is excluded on every chain, a region Coinme does not list is never treated as available. Your code asks a question, such as "can this customer buy USDC by debit card here?", and gets an answer.

## Advisory, not enforcement

The SDK helps your UI match Coinme's rules; it does not enforce them. Coinme's backend checks every onboarding and every transaction against the same rules and is the authority. Use the SDK to hide what is not available, to show what must be shown and to record what the customer accepted, so customers are not sent down a path the backend will refuse. Never treat an answer from the SDK as permission, and never skip a backend call because the SDK said a check passes.

## What it provides

**Jurisdictions.** Every region Coinme lists, with whether Coinme operates there and whether new customers can onboard, so a state picker never needs a hard-coded list. Every region is an ISO 3166-2 code (`US-NY`): a short code or a name throws an `invalidRegion` error rather than being guessed at, and a region Coinme does not list fails closed: it is never operating and never onboardable.

**Rules.** Helpers that answer the questions a transaction screen asks: whether a payment rail is excluded, whether an asset can be bought or sold, which operations a region allows, which consents a customer still owes, which transactional disclosures to present, which custom receipts to issue and which special requirements apply.

**Content.** The text of every consent, disclosure and custom receipt, maintained by Coinme and published in several languages with an English fallback, plus a renderer that sanitizes it for your page.

**Attestations.** A way to record that a customer accepted a consent or a disclosure, tied to the exact text and policy version they saw, and to read those records back so the rule helpers know what is still owed. Attestations belong to an onboarded customer, so they start after onboarding, and recording or reading them needs a [Transient Auth Token](https://platformdocs.coinme.com/docs/transient-auth-token.md) your backend mints with `scope=attestations`, never your partner access token. Attestations are not available in the beta at this time: Coinme does not issue tokens with that scope, so recording and reading with Coinme do not work.

## Platforms

| Platform | Package | Status |
| --- | --- | --- |
| JavaScript: React, or any JavaScript app through the core API | `@coinme-security/compliance-sdk-react` | Beta (1.1.3) |
| React Native: iOS and Android apps, Expo included | `@coinme-security/compliance-sdk-react-native` | Beta (1.0.2) |

The JavaScript & React package has two entry points. `@coinme-security/compliance-sdk-react/core` runs in any JavaScript environment, with no React or browser dependency. `@coinme-security/compliance-sdk-react` adds a provider, hooks and a component for rendering the compliance copy safely in React. React is an optional peer dependency, needed only for the React entry point. The React Native SDK includes the same core, so both reach the same answers, with the same provider and hooks and a component that renders the compliance copy natively.

## How it relates to the other SDKs

The Compliance SDK is one of the Coinme-as-a-Service SDKs, for apps that keep their own customers and build their own screens. Use its region status before onboarding, to offer only the states where new customers can onboard, and then the [Onboarding SDK](https://platformdocs.coinme.com/docs/coinme-onboarding-sdk.md) to onboard the customer. Once you have the customer's `customerId`, the Compliance SDK records the consents they accept and tells you which disclosures to show before each transaction; the [Vault SDK](https://platformdocs.coinme.com/docs/coinme-vault-sdk.md) captures payment methods and the [Risk SDK](https://platformdocs.coinme.com/docs/coinme-risk-sdk.md) supplies the signals Coinme requires before transactional calls.

It is not used with the Coinme Widget, which applies Coinme's compliance rules inside its own frame.

## Where to go next

Start with the [JavaScript & React SDK](https://platformdocs.coinme.com/docs/compliance-sdk-react.md): it covers installing the package, the configuration client and the React provider, the region and rule helpers, consents and disclosures, receipts, localized copy, attestations, and an end-to-end walkthrough from the provider to a checked transaction. For an iOS or Android app built with React Native, see the [React Native SDK](https://platformdocs.coinme.com/docs/compliance-sdk-react-native.md), which covers the platform, the provider and hooks, and rendering the copy with native components.
