---
title: "Integrator reference: Coinme-as-a-Service (CaaS) integration"
url: "https://platformdocs.coinme.com/agents/caas-reference.md"
markdown: "https://platformdocs.coinme.com/agents/caas-reference.md"
summary: "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."
---

# Integrator reference: Coinme-as-a-Service (CaaS) integration

<a id="environments"></a>

## Environments

| Scope | Environment | Value you set | Host | Notes | Stated in |
| --- | --- | --- | --- | --- | --- |
| Onboarding SDK (web) | sandbox | `'sandbox'` | `https://secure.apis.coinme.org` | `environment` is required on `CustomerOnboardingForm`, `CoinmeOnboardingProvider` and `createOnboardingVault`, read once on mount, and picks the onboarding vault and the Coinme onboarding endpoint, both built into the package; you never configure a vault ID or URL. Sandbox is for testing, with a sandbox onboarding token and a sandbox test identity from Coinme. | [source](https://platformdocs.coinme.com/docs/onboarding-sdk-react.md) |
| Onboarding SDK (web) | live | `'live'` | `https://secure.apis.coinme.com` | For real customers. Remount the provider to switch environments. | [source](https://platformdocs.coinme.com/docs/onboarding-sdk-react.md) |
| Onboarding SDK (React Native) | sandbox | `'sandbox'` | `https://secure.apis.coinme.org` | `environment` is required on `CustomerOnboardingForm`, `CoinmeOnboardingProvider` and `createOnboardingVault`, read once on mount, and picks the onboarding vault and the Coinme onboarding endpoint, both built into the package; you never configure a vault ID or URL. Sandbox is for testing, with a sandbox onboarding token and a sandbox test identity from Coinme. | [source](https://platformdocs.coinme.com/docs/onboarding-sdk-react-native.md) |
| Onboarding SDK (React Native) | live | `'live'` | `https://secure.apis.coinme.com` | For real customers. Mount the provider again to switch environments. | [source](https://platformdocs.coinme.com/docs/onboarding-sdk-react-native.md) |
| Onboarding SDK phone verification (web and React Native) | sandbox | `'sandbox'` | `https://caas-staging.coinme.com` | The phone verification calls go to the Coinme API host, a different host from the onboarding submit; the same `environment` picks it, built into the package. On the web, allow it in `connect-src`. | [source](https://platformdocs.coinme.com/docs/onboarding-sdk-react.md) |
| Onboarding SDK phone verification (web and React Native) | live | `'live'` | `https://caas.coinme.com` | For real customers; switch `environment` on the phone verification step together with the form. | [source](https://platformdocs.coinme.com/docs/onboarding-sdk-react.md) |
| Compliance SDK (web) | stage | `environment: 'stage'` |  | `environment` is required on `ComplianceProvider`, `createComplianceClient` and `createHttpAttestationStore`. The SDK carries the Coinme hosts for each environment; there is no host or route to set. Use `stage` and `prod` only. | [source](https://platformdocs.coinme.com/docs/compliance-sdk-react.md) |
| Compliance SDK (web) | prod | `environment: 'prod'` |  | Production, for real customers. | [source](https://platformdocs.coinme.com/docs/compliance-sdk-react.md) |
| Compliance SDK (React Native) | stage | `environment: 'stage'` |  | `environment` is required on `ComplianceProvider`, `createComplianceClient` and `createHttpAttestationStore`, the same values as on the web. The SDK carries the Coinme hosts for each environment; there is no host or route to set. Use `stage` and `prod` only. | [source](https://platformdocs.coinme.com/docs/compliance-sdk-react-native.md) |
| Compliance SDK (React Native) | prod | `environment: 'prod'` |  | Production, for real customers. | [source](https://platformdocs.coinme.com/docs/compliance-sdk-react-native.md) |
| Vault SDK (JavaScript, React Native) | sandbox | `'sandbox'` |  | `createCoinmeVault({ environment })` or `<CoinmeVaultProvider environment>` selects the vault, ingress host and submit path, all pre-bound by the SDK; the guides call sandbox "stage (testing)". The ingress host is not named in these guides. Test with VGS test card `4111 1111 1111 1111`, any future expiry and any 3-digit CVC. Do not pass a custom ingress (`config`) unless Coinme directs you to. | [source](https://platformdocs.coinme.com/docs/coinme-vault-sdk-for-javascript.md) |
| Vault SDK (JavaScript, React Native) | live | `'live'` |  | Production. Nothing else needs configuring. | [source](https://platformdocs.coinme.com/docs/coinme-vault-sdk-for-react-native.md) |
| Vault SDK (iOS, Android) | sandbox | `.sandbox` (iOS), `CoinmeVaultEnvironment.SANDBOX` (Android) | `secure.payments-stage.coinme.com` | The SDK selects the ingress host and submit path (`/caas/v2/paymentmethods`) for each environment. Do not pass a custom ingress or `RuntimeVaultConfig` unless Coinme directs you to. | [source](https://platformdocs.coinme.com/docs/coinme-vault-sdk-for-ios-native.md) |
| Vault SDK (iOS, Android) | live | `.live` (iOS), `CoinmeVaultEnvironment.LIVE` (Android) | `secure.payments.coinme.com` | Production; submit path `/caas/v2/paymentmethods`. | [source](https://platformdocs.coinme.com/docs/coinme-vault-sdk-for-android-native.md) |
| Risk SDK (web, iOS, Android, React Native) | test | `'test'` (web, React Native), `.Test` (iOS), `Mode.Test` (Android) |  | Set as `mode` in `setupCoinmeRiskEngine` with the development `clientId`. Passing the wrong mode or clientId streams behavioural data to the wrong environment and harms transaction approvals. On iOS, Android and React Native, `getPartnerSessionTag` resolves its host from `mode`; the hosts are not stated. | [source](https://platformdocs.coinme.com/docs/using-the-coinme-risk-sdk-for-web.md) |
| Risk SDK (web, iOS, Android, React Native) | prod | `'prod'` (web, React Native), `.Prod` (iOS), `Mode.Prod` (Android) |  | Production builds, with the production `clientId`. | [source](https://platformdocs.coinme.com/docs/risk-sdk-for-android-native-apps.md) |
| Transient Auth Token (backend) | sandbox |  | `https://caas-staging.coinme.com` | Your backend calls `POST /services/authorize` and `POST /services/browserAuth` on this host. The production base URL is provided at onboarding. | [source](https://platformdocs.coinme.com/docs/transient-auth-token.md) |
| CaaS API clients (server) | staging | `baseUrl: 'https://caas-staging.coinme.com/services'` | `https://caas-staging.coinme.com/services` | Every `APIClient` and `AuthService` takes the base URL, `/services` path included, and throws a `TypeError` at construction without one; nothing is fixed at build time, so one installation can call staging and production side by side. Create one `AuthService` per partner and environment. | [source](https://platformdocs.coinme.com/docs/caas-api-clients.md) |
| CaaS API clients (server) | production | `baseUrl: 'https://caas.coinme.com/services'` | `https://caas.coinme.com/services` | With the production partner ID and client secret. | [source](https://platformdocs.coinme.com/docs/caas-api-clients.md) |
| CaaS API clients (server) | secure onboarding host (both environments) | `onboardingBaseUrl` (`@coinme/prove-onboarding-api-client`) |  | Customer onboarding goes to its own secure host because it carries identity data; the URL includes `/services`, and every other call in that package uses `baseUrl`. The URL is not on this site. | [source](https://platformdocs.coinme.com/docs/caas-api-clients.md) |
| Wallet address validator | none |  |  | Has no environment: it makes no network requests and talks to no Coinme service, so the same package and calls run in development and production. `network: 'testnet'` selects testnet address formats, not a Coinme environment. | [source](https://platformdocs.coinme.com/docs/wallet-address-validator.md) |

<a id="credentials"></a>

## What you get from Coinme, and how

Ask for all of these before you start. Keep each one where its row says; none belongs in source control.

### SDK registry token (npm)

- **For**: Onboarding SDK (web and React Native), Compliance SDK, Vault SDK for JavaScript and React Native, Risk SDK for Web and React Native
- **Purpose**: Authenticates the private npm registry `https://npm.coinme.com/coinme-security-wrapper/` for the `@coinme-security` scope. Used only at install time. Each guide's install steps read it from an environment variable they name; use that name. The Risk React Native guide says the same token also authenticates its CocoaPods and Maven artifacts.
- **Keep it in**: An environment variable read by a committed `.npmrc` or `.yarnrc.yml`; CI reads it from a secret. Never commit the token.
- **How to get it**: Issued by Coinme, not self-serve; ask your Coinme integration contact.

[source](https://platformdocs.coinme.com/docs/onboarding-sdk-react.md)

### Mobile registry entitlement token

- **For**: Vault SDK for iOS and Android, Risk SDK for iOS and Android
- **Purpose**: Authenticates the `coinme/coinme-sdk-mobile` registries: Swift (`https://swift.cloudsmith.io/coinme/coinme-sdk-mobile/`), CocoaPods and Maven. Each guide's setup steps name the variable or Gradle property they read; use that name.
- **Keep it in**: A gitignored `coinme.properties` or `local.properties`, or an environment variable; the Swift registry login on each machine; CI secrets. Never commit it.
- **How to get it**: Issued by Coinme; ask your Coinme integration contact.

[source](https://platformdocs.coinme.com/docs/coinme-vault-sdk-for-ios-native.md)

### API client ID and client secret

- **For**: Your backend, for the Onboarding, Vault and Compliance SDKs (all platforms)
- **Purpose**: Exchanged with HTTP Basic at `POST /services/authorize` for a partner access token (30 minutes in sandbox, 60 in production; read `expires_in`), which authorizes every CaaS endpoint and mints Transient Auth Tokens. The client ID is not your partner ID and not the Risk SDK `clientId`.
- **Keep it in**: Your backend's secret store. Neither they nor the partner access token ever reach a browser or an app. Never pass the partner access token to any Coinme SDK.
- **How to get it**: Issued by Coinme for API access; ask your Coinme integration contact.

[source](https://platformdocs.coinme.com/docs/transient-auth-token.md)

### Transient Auth Token (onboarding token, attestation token)

- **For**: Onboarding SDK, Vault SDK, Compliance SDK attestation store (all platforms; attestations are not available in the beta at this time)
- **Purpose**: Minted by your backend at `POST /services/browserAuth?customerId=…` with the partner access token, and sent as `Authorization: Bearer <token>` on the Vault payment-method submit (`headers`, scope `payment-methods`, the default) or the onboarding submit (`getHeaders`, `scope=onboarding`, with your sign-up session identifier as `customerId`), and on the Onboarding SDK's phone verification calls (the step's or hook's `getHeaders`, `scope=onboarding`, with the `customerId` onboarding returned, read from your backend's own record and never from the client; the sign-up session token does not work there, and that token is the only thing that ties the send and the check to the customer: neither carries a customer ID, challenge ID, session or cookie), and on the Compliance SDK's attestation reads and records (the attestation store's `getHeaders`, which you write, `scope=attestations`, with the onboarded customer's `customerId`). Never the partner access token in its place. Lasts 10 minutes, cannot be refreshed, is bound to that `customerId` and accepted by one kind of call only. A failed mint can return HTTP 200 with `{"status":400}` and no `access_token`.
- **Keep it in**: In memory in the page or app, handed over by your backend for the signed-in customer or sign-up session it was minted for; never in `localStorage`, `sessionStorage`, cookies, device storage or logs.
- **How to get it**: Your backend mints a fresh one when the add-card, onboarding or consent screen opens, for each phone verification call, and again after a call fails as unauthorized (`401`/`403` for Vault, `unauthorized` for Onboarding and Compliance), retrying once.

[source](https://platformdocs.coinme.com/docs/transient-auth-token.md)

### `clientId` (Risk)

- **For**: Risk SDK (web, iOS, Android, React Native)
- **Purpose**: Identifies your integration to the Risk Engine in `setupCoinmeRiskEngine`; the SDK throws and refuses to initialise without it. Different from `partnerId`. It is not a secret and is meant to run in the browser; the partner access token and client secret never go there with it.
- **Keep it in**: Runtime configuration, not source, with the development and production values kept apart and paired with the matching `mode`.
- **How to get it**: Issued by Coinme during onboarding, two per integration (development and production); ask your Coinme integration contact.

[source](https://platformdocs.coinme.com/docs/using-the-coinme-risk-sdk-for-web.md)

### `x-partner-id` / `partnerId`

- **For**: Risk SDK (web, iOS, Android, React Native)
- **Purpose**: Partner identifier. On the web it is a required header in `getSessionTag` `additionalHeaders`; on iOS, Android and React Native `partnerId` is optional in `RiskEngineSetupOptions` and required in `getPartnerSessionTag`.
- **Keep it in**: Runtime configuration passed to the SDK; never hard-coded.
- **How to get it**: Provided by Coinme; ask your Coinme integration contact.

[source](https://platformdocs.coinme.com/docs/using-the-coinme-risk-sdk-for-web.md)

### `x-ramp-id`

- **For**: Risk SDK for Web (`getSessionTag`); `rampId` option of `getPartnerSessionTag` on iOS, Android and React Native
- **Purpose**: Identifies the Ramp on session-tag requests, for Ramp partners only.
- **Keep it in**: Runtime configuration passed as an additional header.
- **How to get it**: Provided by Coinme to Ramp partners; ask your Coinme integration contact.

[source](https://platformdocs.coinme.com/docs/using-the-coinme-risk-sdk-for-web.md)

### `apiBaseUrl` (Risk)

- **For**: Risk SDK for Web (`getSessionTag`)
- **Purpose**: Base URL of the API that serves the public `/pub/get-session-tag` endpoint.
- **Keep it in**: Runtime configuration, per environment.
- **How to get it**: Not stated on this site; ask your Coinme integration contact.

[source](https://platformdocs.coinme.com/docs/using-the-coinme-risk-sdk-for-web.md)

### `paymentProviderId` (Vault)

- **For**: Vault SDK `submitPaymentMethod` (JavaScript, React Native, iOS, Android)
- **Purpose**: Payment provider identifier, sent as `providerId` in the payment-method request body.
- **Keep it in**: App state or runtime configuration at submit time.
- **How to get it**: Not stated on this site; ask your Coinme integration contact.

[source](https://platformdocs.coinme.com/docs/coinme-vault-sdk-for-javascript.md)

### Partner ID and client secret (`partnerId`, `clientSecret`)

- **For**: CaaS API clients (`AuthService` in `@coinme/core-api-client`; every `APIClient` also takes `partnerId`)
- **Purpose**: `AuthService` exchanges them for a bearer token, caches it and fetches a new one once it expires; clients take the token and send the partner and token headers on every call. Pass a refreshed token to `updateToken`, or create clients per request.
- **Keep it in**: Your backend's secret store, out of source control and out of anything shipped to a browser or a device; one pair per environment.
- **How to get it**: Issued by Coinme per environment; ask your Coinme integration contact.

[source](https://platformdocs.coinme.com/docs/caas-api-clients.md)

### `COINME_CAAS_REGISTRY_TOKEN` (npm)

- **For**: CaaS API clients (`@coinme/*-api-client`)
- **Purpose**: Read token for the private registry `https://npm.coinme.com/coinme-caas/`, which serves the `@coinme` scope for the API clients; a different registry from the SDKs' `coinme-security-wrapper`. Used only at install time.
- **Keep it in**: An environment variable or CI secret read by `.npmrc`; never in a committed `.npmrc`.
- **How to get it**: Issued by Coinme; ask your Coinme integration contact.

[source](https://platformdocs.coinme.com/docs/caas-api-clients.md)

### `COINME_REGISTRY_TOKEN` (`@coinme` scope)

- **For**: Wallet address validator (`@coinme/wallet-address-validator`)
- **Purpose**: Read-only token for the private npm registry `https://npm.coinme.com/coinme-sdk-frontend/`, which serves the `@coinme` scope; a different registry from the `coinme-security-wrapper` the other CaaS SDKs install from. Used only at install time. The validator needs no other credential: it calls no Coinme service.
- **Keep it in**: An environment variable read by `.npmrc` or `.yarnrc.yml`; CI reads it from a secret. Never commit the token.
- **How to get it**: Issued by Coinme; ask your Coinme integration contact.

[source](https://platformdocs.coinme.com/docs/wallet-address-validator.md#install)

### Phone verification after onboarding

- **For**: Onboarding SDK
- **Purpose**: Coinme does not consider KYC complete until the new customer confirms a code texted to the phone number they onboarded with. The SDK's `PhoneVerificationStep` or `usePhoneVerification` hook sends and checks the code, with a Transient Auth Token minted (`scope=onboarding`) for the `customerId` onboarding returned, not the sign-up session token and never the partner access token. That token is the only thing binding the send and the check to the customer: neither carries a customer ID, so there is no challenge ID or session to pass from the send to the check.
- **Keep it in**: Your onboarding flow, right after the form, and again on the sign-in of a customer whose phone is not verified; keep the `customerId`, the `phoneNumber` and whether it is verified on your backend.
- **How to get it**: Nothing to obtain: the step ships in the Onboarding SDK, and the token is minted by the same backend call as the onboarding token.

[source](https://platformdocs.coinme.com/docs/onboarding-sdk-react.md#phone-verification)

### Phone verification token route (you build)

- **For**: Your backend, for the Onboarding SDK (web and React Native)
- **Purpose**: A route on your backend, not provided by Coinme or the SDK, that the phone verification step's or hook's `getHeaders` calls (`POST /your-api/phone-verification/token` in the examples; the path is yours). It looks up the signed-in user, reads the `customerId` saved for them when onboarding succeeded, mints a Transient Auth Token for that `customerId` (`scope=onboarding`) and returns it. It never takes a `customerId` from the page or app. Each user has one saved `customerId`, so customer IDs cannot be mixed up. Do not pass a `customerId` to the send or the check (neither takes one), never use the partner access token for them, and do not reuse the onboarding token.
- **Keep it in**: Your backend, next to the route that saves the onboarding result. The client gets only the token it returns, in memory.
- **How to get it**: You write it; the Transient Auth Token page has one way to do it, not the only way.

[source](https://platformdocs.coinme.com/docs/transient-auth-token.md#you-build)

### Sandbox test identity

- **For**: Onboarding SDK (sandbox verification)
- **Purpose**: Customer details that onboard successfully in sandbox, used to check that a submit returns a `customerId` and a repeat submit returns `duplicate`.
- **Keep it in**: Test configuration, not shipped code.
- **How to get it**: Published: use the test identity for Coinme KYC marked Yes under Verified. The identities are fake and work wherever Coinme performs identity verification in its test environment.

[source](https://platformdocs.coinme.com/docs/widget-test-identities.md)

### Content-Security-Policy entries

- **For**: Onboarding SDK (web), Vault SDK for JavaScript
- **Purpose**: `script-src` and `frame-src`: `https://js.verygoodvault.com https://js3.verygoodvault.com`; `connect-src`: the same plus `https://vgs-collect-keeper.apps.verygood.systems` and the Coinme hosts: for onboarding, the onboarding host and the Coinme API host for your environment (the submit goes to the first, the phone verification calls to the second); for Vault, the Coinme ingress host. Without them the secure fields fail to render, the submit or phone verification is blocked, or vault creation rejects.
- **Keep it in**: Your site's CSP headers, for example the framework's header config.
- **How to get it**: Nothing to obtain for the onboarding hosts, which the guide lists; the Vault guide does not name its ingress host for the web (see unstated).

[source](https://platformdocs.coinme.com/docs/onboarding-sdk-react.md)

### Store data-declaration CSV

- **For**: Risk SDK for Android and React Native
- **Purpose**: Optional pre-filled import for the Google Play Data Safety section (the React Native guide also mentions one for App Store App Privacy).
- **Keep it in**: Your store-listing workflow.
- **How to get it**: May be provided by Coinme; ask your Coinme integration contact.

[source](https://platformdocs.coinme.com/docs/risk-sdk-for-android-native-apps.md)

<a id="platform-requirements"></a>

## Platform requirements

| SDK | Platform | Requirements | Stated in |
| --- | --- | --- | --- |
| Onboarding SDK for JavaScript & React | Web | React 18 or later for the React API (`react` and `react-dom` peers); a non-React app imports from the `/core` entry and does not install React. Browsers: Chrome / Edge 111+, Firefox 114+, Safari 16.4+ (desktop and iOS). Importing on the server is safe; the secure field is created in the browser after mount. Release on this site: 1.7.1. | [source](https://platformdocs.coinme.com/docs/onboarding-sdk-react.md) |
| Onboarding SDK for React Native | React Native | React Native 0.76 or later and React 18 or later (`react-native` and `react` peers); Expo SDK 52 or later, Expo Go included; iOS and Android; the Old and New Architecture. Install `@vgs/collect-react-native` 1.1.6 or later within `1.x` (tested with 1.2.1) as a peer from the public npm registry. No native module of its own: no config plugin, prebuild, `pod install` or Gradle change. Release on this site: 1.2.1. | [source](https://platformdocs.coinme.com/docs/onboarding-sdk-react-native.md) |
| Compliance SDK for JavaScript & React | Web (React optional) | React 18 or later for the React entry point (`react` and `react-dom` are optional peers); `/core` runs in any JavaScript runtime with `fetch` and timers through a platform object. Safe under server-side rendering. Release on this site: 1.1.3, in beta (published and installable, not generally available). | [source](https://platformdocs.coinme.com/docs/compliance-sdk-react.md) |
| Compliance SDK for React Native | React Native | React Native 0.79 or later and React 18 or later (`react-native` and `react` peers); Expo SDK 53 or later, Expo Go included; iOS and Android; Hermes; the Old and New Architecture. No native module of its own: no config plugin, prebuild, `pod install` or Gradle change. Release on this site: 1.0.2, in beta (published and installable, not generally available). | [source](https://platformdocs.coinme.com/docs/compliance-sdk-react-native.md) |
| Vault SDK for JavaScript | Web | Evergreen Chrome, Firefox, Edge; Safari 10+. Vault creation is browser-only. Node at build time: any version that supports your build tool. VGS Collect.js 4.0.1 is loaded from the VGS CDN at runtime. Release on this site: 1.3.0. | [source](https://platformdocs.coinme.com/docs/coinme-vault-sdk-for-javascript.md) |
| Vault SDK for iOS | iOS | Minimum iOS 15.0, Swift 5.9, VGS Collect `~> 1.18` (resolved transitively). Swift Package Manager (`coinme.CoinmeVaultSDK`) or CocoaPods (`CoinmeVaultSDK`). Xcode version not stated. Release on this site: 1.0.1. | [source](https://platformdocs.coinme.com/docs/coinme-vault-sdk-for-ios-native.md) |
| Vault SDK for Android | Android | Minimum Android 7.0, API level 24; compile SDK 37; JVM target 17; VGS Collect 1.11.0 (re-exported as `api`). No Compose dependency: Compose uses `AndroidView` interop. Artifact `com.coinme:vault-sdk-android`. Kotlin and Android Gradle Plugin versions not stated. Release on this site: 1.0.0. | [source](https://platformdocs.coinme.com/docs/coinme-vault-sdk-for-android-native.md) |
| Vault SDK for React Native | React Native | Node 20+, React 18 or 19, React Native 0.76 or later; peer `@vgs/collect-react-native` ^1.1.6. Pure JavaScript: Expo Go works with no prebuild, and neither React Native architecture needs extra configuration. Bare projects need the usual toolchain (Xcode and CocoaPods; JDK 17 and the Android SDK). Release on this site: 1.3.0. | [source](https://platformdocs.coinme.com/docs/coinme-vault-sdk-for-react-native.md) |
| Risk SDK for Web | Web | No browser or framework minimums are stated. Installed from the `@coinme-security` npm registry with npm, Yarn or pnpm. Release on this site: 1.2.0. | [source](https://platformdocs.coinme.com/docs/using-the-coinme-risk-sdk-for-web.md) |
| Risk SDK for iOS | iOS | The iOS guide states no minimum iOS, Xcode or Swift version; the React Native guide says the underlying `CoinmeRiskSDK` requires iOS 16.0+. Swift Package Manager (`coinme.CoinmeRiskSDK`) or CocoaPods through the `cocoapods-cloudsmith` plugin; includes its bundled risk components. Release on this site: 1.1.2. | [source](https://platformdocs.coinme.com/docs/risk-sdk-for-ios-native-apps.md) |
| Risk SDK for Android | Android | The Android guide states no minimum SDK or Kotlin version; the React Native guide says `risk-sdk-android` is compiled with Kotlin 2.3.0 and needs `minSdkVersion` 24+. Artifact `com.coinme:risk-sdk-android`; ProGuard / R8 keep rules required if you obfuscate. Release on this site: 1.1.2. | [source](https://platformdocs.coinme.com/docs/risk-sdk-for-android-native-apps.md) |
| Risk SDK for React Native | React Native | Node 20.9+, React 18+, React Native 0.72 to 0.81. React Native 0.82+ is not supported: the module targets the legacy (bridge) architecture, so the New Architecture must be disabled on both platforms. iOS 16.0+; Android `minSdkVersion` 24+ with Kotlin forced to 2.3.0. Expo SDK 51+ in the managed workflow with `expo prebuild`. Release on this site: 1.1.0. | [source](https://platformdocs.coinme.com/docs/coinme-risk-sdk-for-react-native.md) |
| CaaS API clients | Server (Node.js) | Node.js 24.22.1 or later (or 22.23.4 or later in the 22.x line), in your backend only: `AuthService` holds the client secret and throws if it is created in a browser, WebView, Electron renderer or React Native app, so front ends reach CaaS through your backend (tests that create one need the `node` environment, not jsdom or happy-dom). Install with `@^2.0.0`; 1.x is deprecated and configured differently, and until 2.0.0 is published the registry serves 1.x. Install only the packages you call, always with `@coinme/core-api-client` for `AuthService`. | [source](https://platformdocs.coinme.com/docs/caas-api-clients.md) |
| Wallet address validator | Web, Node.js, React Native | Node.js 18 or later; current evergreen browsers (ES2020 with `BigInt`); React Native 0.74 or later with Hermes (needs `BigInt` and `TextEncoder`). ESM and CommonJS, with TypeScript declarations for both (`moduleResolution` `node16`/`nodenext` and `bundler`); Vite, webpack, Rollup, esbuild and Metro. No runtime or peer dependencies. Release on this site: 1.2.0. | [source](https://platformdocs.coinme.com/docs/wallet-address-validator.md#compatibility) |

<a id="go-live-checklists"></a>

## Go-live checklists

### Onboarding SDK (web)

1. Pass the sandbox verification first: a sandbox test identity returns a `customerId`, a repeat submit returns `duplicate`, the submit goes to the sandbox host, and phone verification with a token minted for the new `customerId` shows `codeIncorrect` for a wrong code and calls `onVerified` for the right one.
2. Switch `environment` to `'live'` on the form and on the phone verification step.
3. If your site sets a CSP, allow the vault provider domains, `https://secure.apis.coinme.com` and `https://caas.coinme.com` in `connect-src`; phone verification calls the second.
4. Verify the phone right after onboarding, with the `phoneNumber` onboarding returned and no phone input of your own, and treat no customer as onboarded or KYC-complete until it is verified; send an unverified customer who signs back in to verification first.
5. Have your backend mint the onboarding token (a Transient Auth Token with `scope=onboarding` for the sign-up session) and the phone verification token (the same call, for the new `customerId`) from the production base URL Coinme gave you; keep the API client credentials and the partner access token out of the browser.
6. Check that the route behind the phone verification step's `getHeaders` takes no `customerId` from the client and mints the token for the `customerId` your own record holds: the token is the only thing binding the verification calls to the customer, so a client-supplied ID would let one customer verify as another.
7. Do not log form values; `CoinmeOnboardingError` messages are safe to log.

[source](https://platformdocs.coinme.com/docs/onboarding-sdk-react.md)

### Compliance SDK (web)

1. Check with your Coinme integration contact before production use: the SDK is in beta (1.1.3 is published and fine for development builds, but it is not generally available yet).
2. Pass the stage verification first: a configuration with a `policyVersion` loads, only onboardable regions are offered, every region is passed as an ISO 3166-2 code (a short code throws `invalidRegion`), an unlisted region is unavailable, consent copy renders through `ComplianceHtml`, and an excluded rail or asset is refused before your backend call.
3. Switch `environment` to `'prod'` on `ComplianceProvider` and on the attestation store.
4. Attestations are not available in the beta at this time, so do not launch a flow that depends on recording them with Coinme. `getHeaders` must return a Transient Auth Token your backend minted with `scope=attestations` for the customer, never your partner access token.
5. Keep every backend check: the SDK is advisory and Coinme's backend enforces the rules.

[source](https://platformdocs.coinme.com/docs/compliance-sdk-react.md)

### Compliance SDK (React Native)

1. Check with your Coinme integration contact before production use: the React Native SDK is in beta (1.0.2 is published and fine for development builds, but it is not generally available yet).
2. Pass the stage verification on both iOS and Android: a configuration with a `policyVersion` loads, a relaunch in airplane mode starts from the stored configuration, only onboardable regions are offered, every region is passed as an ISO 3166-2 code (a short code throws `invalidRegion`), and consent copy renders through `ComplianceText`.
3. Switch `environment` to `'prod'` on `ComplianceProvider` and on the attestation store.
4. Attestations are not available in the beta at this time, so do not launch a flow that depends on recording them with Coinme. `getHeaders` must return a Transient Auth Token your backend minted with `scope=attestations` for the customer, never your partner access token, and the app never persists it.
5. Keep every backend check: the SDK is advisory and Coinme's backend enforces the rules.

[source](https://platformdocs.coinme.com/docs/compliance-sdk-react-native.md)

### Onboarding SDK (React Native)

1. Pass the sandbox verification on both iOS and Android: a sandbox test identity returns a `customerId`, a repeat submit returns `duplicate`, the submit button enables only once every field, the SSN included, is valid, and phone verification with a token minted for the new `customerId` shows `codeIncorrect` for a wrong code and calls `onVerified` for the right one.
2. In a release build, check that no network logger or inspector is bundled and that monitoring and APM SDKs, and any `fetch` interceptor of your own, do not capture request bodies for the onboarding vault host: until the vault receives it, the SSN is in plain text in the app's JavaScript.
3. Switch `environment` to `'live'` on the form and on the phone verification step.
4. Verify the phone right after onboarding, with the `phoneNumber` onboarding returned and no phone input of your own, and treat no customer as onboarded or KYC-complete until it is verified; send an unverified customer who signs back in to verification first.
5. Have your backend mint the onboarding token (a Transient Auth Token with `scope=onboarding` for the sign-up session) and the phone verification token (the same call, for the new `customerId`) from the production base URL Coinme gave you; keep the API client credentials out of the app and never store either token on the device.
6. Check that the route behind the phone verification step's `getHeaders` takes no `customerId` from the app and mints the token for the `customerId` your own record holds: the token is the only thing binding the verification calls to the customer, so an app-supplied ID would let one customer verify as another.
7. Do not log form values; `CoinmeOnboardingError` messages are safe to log.

[source](https://platformdocs.coinme.com/docs/onboarding-sdk-react-native.md)

### Vault SDK for JavaScript

1. Pass the sandbox verification with the VGS test card: the form becomes valid and a submit returns 2xx or the `CoinmeVaultError` kind you provoked.
2. Create the vault with `environment: 'live'`.
3. If your site sets a CSP, add the VGS domains and the Coinme ingress host.
4. Send a fresh transient auth token as `Authorization: Bearer <token>` on every submit, never the partner access token.
5. Fetch the Risk SDK session tag right before each submit and pass it as `webSessionId` (a tag lives 30 minutes). From 1.3.0, with Risk SDK for Web 1.2.0 or later, the SDK adds the `X-Device-Fingerprint` the Coinme SDKs share; otherwise pass the same value you gave the Risk SDK.
6. Treat a `configuration` `CoinmeVaultError` (from 1.2.3) as an integration fault: the `Authorization` header carried a partner access token, so fix the backend route rather than retrying. Never retry a `network` error with `timedOut: true` (from 1.2.2) without first re-listing the user's payment methods.
7. Do not pass a custom ingress unless Coinme directed you to.

[source](https://platformdocs.coinme.com/docs/coinme-vault-sdk-for-javascript.md)

### Vault SDK for iOS

1. Create the vault with `CoinmeVault.create(environment: .live)`.
2. Send a fresh transient auth token as `Authorization: Bearer <token>` on every submit, never the partner access token; never store it on the device.
3. Do not pass a `RuntimeVaultConfig` unless Coinme directed you to.

[source](https://platformdocs.coinme.com/docs/coinme-vault-sdk-for-ios-native.md)

### Vault SDK for Android

1. Create the vault with `CoinmeVaultEnvironment.LIVE`.
2. Send a fresh transient auth token as `Authorization: Bearer <token>` on every submit, never the partner access token; never store it on the device.
3. Do not pass a `RuntimeVaultConfig` unless Coinme directed you to.

[source](https://platformdocs.coinme.com/docs/coinme-vault-sdk-for-android-native.md)

### Vault SDK for React Native

1. Set `environment="live"` on `CoinmeVaultProvider`.
2. Send a fresh transient auth token as `Authorization: Bearer <token>` on every submit, never the partner access token; never store it on the device.
3. Treat a `configuration` `CoinmeVaultError` (from 1.2.3) as an integration fault: the `Authorization` header carried a partner access token, so fix the backend route rather than retrying. Never retry a `network` error with `timedOut: true` (from 1.2.2) without first re-listing the user's payment methods.
4. Do not pass a custom ingress `config` unless Coinme directed you to.

[source](https://platformdocs.coinme.com/docs/coinme-vault-sdk-for-react-native.md)

### Risk SDK for Web

1. Call `setupCoinmeRiskEngine` with `mode: 'prod'` and the production `clientId`.
2. Send `x-partner-id` (and `x-ramp-id` for Ramp partners) in `getSessionTag` `additionalHeaders`.
3. Call `getSessionTag()` right before each add-payment-method call and each order and send the returned `webSessionID` as `webSessionId` (a tag lives 30 minutes; don't persist one across reloads); update the engine with the `customerId` once the user is onboarded.

[source](https://platformdocs.coinme.com/docs/using-the-coinme-risk-sdk-for-web.md)

### Risk SDK for iOS

1. Initialise with `mode: .Prod`, the production `clientId` and your `partnerId`.
2. In App Store Connect > App Privacy, declare data collection: Coarse and/or Precise Location and Device ID, purpose App Functionality, device ID linked to user identity.
3. Add the guide's required fraud-protection disclosure to your App Store privacy policy.
4. Add `NSLocationAlwaysAndWhenInUseUsageDescription` and `NSLocationWhenInUseUsageDescription` to Info.plist and request location at runtime.
5. If behaviour biometrics are on (the default), have users agree to your privacy policy before collection.
6. Set `setCloudEntitlements` to true only with the CloudKit capability configured; otherwise the SDK crashes.

[source](https://platformdocs.coinme.com/docs/risk-sdk-for-ios-native-apps.md)

### Risk SDK for Android

1. Initialise with `Mode.Prod`, the production `clientId` and your `partnerId`.
2. Add the guide's required fraud-protection disclosure to your Google Play privacy policy.
3. In Play Console > App content > Data safety, declare Location (Approximate and Precise), Device or other IDs, App info and performance, and Files and docs.
4. Declare `INTERNET` and `ACCESS_NETWORK_STATE` (required), and only the optional permissions you disclose in your Data Safety form; request the dangerous ones you declare (location, phone state) at runtime.
5. If you use ProGuard or R8, add the keep rules the guide lists for Google Play Services and its bundled risk components.
6. If behaviour biometrics are on (the default), have users agree to your privacy policy before collection.

[source](https://platformdocs.coinme.com/docs/risk-sdk-for-android-native-apps.md)

### Risk SDK for React Native

1. Initialise with `mode: 'prod'` and the production `clientId`.
2. Every Coinme SDK in the app and your backend calls must send the same `x-device-fingerprint`. From 1.1.0 the SDKs share one for you and expose it as `getDeviceFingerprint()`, which returns a Promise. Read it in the app and send it to your server with each request; a mismatch gets payment-method and order calls rejected.
3. Complete the Google Play privacy policy disclosure and Data Safety declaration, and the App Store Connect App Privacy declarations and privacy policy disclosure.
4. Add the Android permissions and ProGuard / R8 rules, and the iOS location Info.plist keys.
5. Keep React Native at 0.81 or older with the New Architecture disabled.
6. If behaviour biometrics are on (the default), have users agree to your privacy policy before collection.

[source](https://platformdocs.coinme.com/docs/coinme-risk-sdk-for-react-native.md)

### CaaS API clients

1. Point every `AuthService` and `APIClient` at `https://caas.coinme.com/services`.
2. Use the production partner ID and client secret, from your secret store.
3. Set the production `onboardingBaseUrl` if you use the onboarding client.
4. Keep the registry token in CI secrets, never in a committed `.npmrc`.

[source](https://platformdocs.coinme.com/docs/caas-api-clients.md)

### Wallet address validator (both surfaces)

1. Validate with `strict: true`, and pass `chainType` for every asset that lives on more than one chain; strict mode requires it for `usdc` and `usdt`.
2. Trim the input and strip payment URIs before validating; `validateAddress` does neither.
3. Handle the three outcomes apart: `true` goes on to your own ownership and compliance checks, `false` shows a field error, and `UnsupportedCurrencyError` or `UnsupportedChainError` is logged as an integration issue and never lets the user send to the address.
4. Check every currency and chain pair you offer with `isSupported` at startup or in a test.
5. Collect and check memos and destination tags separately where the chain uses them.
6. Pass the checks in "Verify your integration". There is no environment to switch for production.
7. In CaaS screens, check send and withdrawal addresses before your backend uses them; the check is advisory input validation, and your own ownership and screening controls still apply.

[source](https://platformdocs.coinme.com/docs/wallet-address-validator.md#recommended-integration)

<a id="not-stated"></a>

## Not stated on this site

Ask your Coinme integration contact for these; do not guess them.

- **Risk `apiBaseUrl`.** The value for each environment is not stated on this site; ask your Coinme integration contact.
- **Risk session-tag hosts.** Which host each Risk `mode` resolves to is not stated; ask your Coinme integration contact.
- **Environment names.** Onboarding and Vault use `sandbox` / `live`, Risk uses `test` / `prod`, and the Vault guides call sandbox "stage (testing)". Whether Risk `test` pairs with `sandbox`, and whether either is the widget's `stage`, is not stated; ask your Coinme integration contact.
- **Simulated transactions.** Simulated transaction mode is described for the widget only; whether CaaS sandbox moves real funds or behaves the same way is not stated; ask your Coinme integration contact.
- **Partner identifier.** Whether the web `x-partner-id` header value and the native and React Native `partnerId` are the same value is not stated (only that `partnerId` differs from `clientId`); ask your Coinme integration contact.
- **Transient Auth Token in production.** The sandbox base URL for `/services/authorize` and `/services/browserAuth` is `https://caas-staging.coinme.com`; the production base URL is provided at onboarding and is not stated on this site, nor whether it is the CaaS API clients' production host; ask your Coinme integration contact.
- **`paymentProviderId`.** What value to pass, and whether it differs per environment, is not stated; ask your Coinme integration contact.
- **Vault ingress host for web and React Native.** The ingress host to allow in your Content-Security-Policy for the JavaScript and React Native SDKs is not named on this site; ask your Coinme integration contact.
- **Vault configuration on native.** Which vault values, if any, you set in your build configuration on iOS and Android; ask your Coinme integration contact before filling them.
- **Registry token.** If a registry refuses the token you have, ask your Coinme integration contact. The CaaS API clients use their own registry token, `COINME_CAAS_REGISTRY_TOKEN`.
- **Wallet address validator registry.** The validator installs from the `@coinme` registry (`coinme-sdk-frontend`), not the `@coinme-security` one the other CaaS SDKs use; whether one registry token reads both is not stated; ask your Coinme integration contact.
- **Native and web minimums.** The Risk iOS and Android guides state no minimum OS, Xcode, Swift, Kotlin or Gradle versions (only the React Native guide gives iOS 16.0+, minSdk 24 and Kotlin 2.3.0); the Risk web guide states no browser minimums; the Vault iOS guide gives no Xcode version and the Vault Android guide no Kotlin or Android Gradle Plugin version; ask your Coinme integration contact.
- **Go-live.** No CaaS guide has a production checklist or a Coinme sign-off step; the checklists here are assembled from what each guide says changes for production; ask your Coinme integration contact for anything else Coinme requires before live traffic.
- **Compliance SDK hosts.** The Coinme hosts the Compliance SDK loads its configuration, copy and attestations from are carried by the SDK and not stated on this site; if your Content-Security-Policy restricts `connect-src`, ask your Coinme integration contact.
- **API client secure host.** The `onboardingBaseUrl` value is not on this site, for either environment; ask your Coinme integration contact.
- **API client 2.0.0 release.** This site documents 2.0.0, which is not yet published; the registry serves the deprecated 1.x, configured differently. When 2.0.0 ships is not stated; ask your Coinme integration contact.
- **Custody and cash ramp clients.** `@coinme/custody-api-client` and `@coinme/cash-ramp-api-client` are not on the registry yet; ask your Coinme integration contact before planning on them.
- **Raw CaaS REST API.** The CaaS API clients cover it from Node.js; the operations themselves, for calling the API from another language, are described on docs.coinme.com's API reference, not on this site.
