---
title: "Build with an agent"
url: "https://platformdocs.coinme.com/#/build/agents"
markdown: "https://platformdocs.coinme.com/pages/build/agents.md"
summary: "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."
---

# Build with an agent.

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.

## Pick the integration first

Coinme has two ways to build, and nearly every skill below belongs to exactly one of them. Which one the human is on decides which skills apply, so settle it before choosing a skill: [the agent primer](https://platformdocs.coinme.com/agents/primer.md) has the decision tree, and [Two ways to build on Coinme](https://platformdocs.coinme.com/agents/surfaces.md) the side-by-side comparison.

- **Widget / Ramp integration** (`surface: "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. Skills: [coinme-widget-web](https://platformdocs.coinme.com/skills/coinme-widget-web/SKILL.md), [coinme-widget-ios](https://platformdocs.coinme.com/skills/coinme-widget-ios/SKILL.md), [coinme-widget-android](https://platformdocs.coinme.com/skills/coinme-widget-android/SKILL.md). It needs none of the Onboarding, Vault or Risk SDKs and no CaaS API calls: the widget does sign-in, KYC, payment and risk inside its frame.
- **Coinme-as-a-Service (CaaS) integration** (`surface: "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. Skills: [coinme-onboarding-react](https://platformdocs.coinme.com/skills/coinme-onboarding-react/SKILL.md), [coinme-onboarding-react-native](https://platformdocs.coinme.com/skills/coinme-onboarding-react-native/SKILL.md), [coinme-compliance-react](https://platformdocs.coinme.com/skills/coinme-compliance-react/SKILL.md), [coinme-compliance-react-native](https://platformdocs.coinme.com/skills/coinme-compliance-react-native/SKILL.md), [coinme-risk-web](https://platformdocs.coinme.com/skills/coinme-risk-web/SKILL.md), [coinme-risk-ios](https://platformdocs.coinme.com/skills/coinme-risk-ios/SKILL.md), [coinme-risk-android](https://platformdocs.coinme.com/skills/coinme-risk-android/SKILL.md), [coinme-risk-react-native](https://platformdocs.coinme.com/skills/coinme-risk-react-native/SKILL.md), [coinme-vault-js](https://platformdocs.coinme.com/skills/coinme-vault-js/SKILL.md), [coinme-vault-ios](https://platformdocs.coinme.com/skills/coinme-vault-ios/SKILL.md), [coinme-vault-android](https://platformdocs.coinme.com/skills/coinme-vault-android/SKILL.md), [coinme-vault-react-native](https://platformdocs.coinme.com/skills/coinme-vault-react-native/SKILL.md), [coinme-caas-api-clients](https://platformdocs.coinme.com/skills/coinme-caas-api-clients/SKILL.md). There is no widget, so no `rampId`, `partnerKey`, widget URL or embed allowlist: those belong to the Widget / Ramp integration only.
- **Both integrations (Widget / Ramp and CaaS)** (`surface: "both"`). Skills for an SDK that works the same on either integration and uses neither one's credentials or services, so it adds to whichever the human is on: [coinme-wallet-address-validator](https://platformdocs.coinme.com/skills/coinme-wallet-address-validator/SKILL.md).

Each skill's front matter, and its entry in `skills/index.json`, names its `surface`: `ramp`, `caas`, or `both` for a skill that applies on either. If the human is unsure which integration they have, ask them, or have them ask their Coinme integration contact.

## Point your agent at the docs

These are examples, one per platform, to adapt to what you are building. Each hands the agent a skill, or the skills index where an SDK has one skill per platform, and names the task; the skill carries the prerequisites, the code and how to check the result.

### Web: Widget SDK, Widget / Ramp integration

```
Follow the skill at https://platformdocs.coinme.com/skills/coinme-widget-web/SKILL.md to embed the Coinme widget in my web app with framekit. Ask me for the ramp id and partner key when you reach them.
```

### iOS: Widget SDK, Widget / Ramp integration

```
Follow the skill at https://platformdocs.coinme.com/skills/coinme-widget-ios/SKILL.md to integrate the Coinme widget into my iOS app with CoinmeBridge. Ask me for the registry token, the ramp id and the partner key when you reach them.
```

### Android: Widget SDK, Widget / Ramp integration

```
Follow the skill at https://platformdocs.coinme.com/skills/coinme-widget-android/SKILL.md to integrate the Coinme widget into my Android app with CoinmeBridge. Ask me for the registry token, the ramp id and the partner key when you reach them.
```

### React: Onboarding SDK, CaaS integration

```
Follow the skill at https://platformdocs.coinme.com/skills/coinme-onboarding-react/SKILL.md to add customer onboarding to my React app with the drop-in form. Ask me for the registry token and for how my backend will supply the transient auth token, which the Onboarding SDK's guides call the onboarding token.
```

### React Native: Onboarding SDK, CaaS integration

```
Follow the skill at https://platformdocs.coinme.com/skills/coinme-onboarding-react-native/SKILL.md to add customer onboarding to my React Native app with the drop-in form, on iOS and Android. Ask me for the registry token and for how my backend will supply the transient auth token, which the Onboarding SDK's guides call the onboarding token.
```

### React: Compliance SDK, CaaS integration

```
Follow the skill at https://platformdocs.coinme.com/skills/coinme-compliance-react/SKILL.md to apply Coinme's compliance rules in my React app with the Compliance SDK: offer only onboardable states, show and record the consents and disclosures a customer owes, and check each transaction before it reaches my backend. Ask me for the registry token and for how my backend will supply the transient auth token the attestation store sends.
```

### React Native: Compliance SDK, CaaS integration

```
Follow the skill at https://platformdocs.coinme.com/skills/coinme-compliance-react-native/SKILL.md to apply Coinme's compliance rules in my React Native app with the Compliance SDK, on iOS and Android: offer only onboardable states, show and record the consents and disclosures a customer owes, and check each transaction before it reaches my backend. Ask me for the registry token and for how my backend will supply the transient auth token the attestation store sends.
```

### Risk: Risk SDK, CaaS integration

```
Read the skills index at https://platformdocs.coinme.com/skills/index.json, pick the coinme-risk skill for my platform and follow it, so a session tag is ready before every transaction. Ask me for the registry token and the client ID when you reach them.
```

### Vault: Vault SDK, CaaS integration

```
Read the skills index at https://platformdocs.coinme.com/skills/index.json, pick the coinme-vault skill for my platform and follow it to add card capture and submit the payment method to Coinme. Ask me for the registry token and for how my backend will supply the transient auth token.
```

### Server: CaaS API clients, CaaS integration

```
Follow the skill at https://platformdocs.coinme.com/skills/coinme-caas-api-clients/SKILL.md to call the Coinme CaaS API from my Node.js backend with version 2 of the CaaS API clients. Ask me for the CaaS registry token, the partner ID, the client secret and the base URLs when you reach them.
```

## What the agent finds

The build that publishes this site also writes a Markdown rendition of it, generated from the same content the pages render, so the two cannot drift. The index lists every page with a one-line summary; each page carries its headings, prose, tables and code samples, with a short header naming the platform, the package and, for imported documents, the canonical source and its last update.

An agent that can fetch a URL needs nothing else. Those that read a site through its `llms.txt` convention find the index on their own; the page head also advertises it.

| File | What it holds |
| --- | --- |
| [llms.txt](https://platformdocs.coinme.com/llms.txt) | The index: every page with its title, a one-line summary and the link to its Markdown. |
| [llms-full.txt](https://platformdocs.coinme.com/llms-full.txt) | Every page in one file. It is large; most agents do better with the slice for their SDK. |
| `llms-<sdk>.txt` | One SDK's pages and skills in one file: `llms-widget.txt`, `llms-risk.txt`, `llms-vault.txt`, `llms-onboarding.txt`, `llms-compliance.txt`, `llms-api.txt` and `llms-wallet.txt`. |
| `docs/<slug>.md` | One file per SDK document: the Risk, Vault, Onboarding and Compliance SDKs, the CaaS API clients, the wallet address validator, and the CoinmeBridge quick starts and guides. |
| `pages/<area>/<page>.md` | The Build guides for the web, iOS and Android, and the explainers. |
| [skills/index.json](https://platformdocs.coinme.com/skills/index.json) | Every skill with its description, platform, package and version, and the URL of its `SKILL.md`. |

## What the agent cannot get on its own

These come from your Coinme integration contact, not from the docs. The agent will stop and ask for them; have them ready, and keep them out of the files it writes.

- **`COINME_REGISTRY_TOKEN`** (Registry): The registry token that installs the Coinme SDKs from the private registry: framekit, CoinmeBridge, the Onboarding, Compliance, Vault and Risk SDKs, and the wallet address validator. It belongs in an environment variable or a gitignored file, never in a commit.
- **`rampId`** (Widget): Which Ramp the widget loads. Issued at onboarding, with the environment it belongs to.
- **`partnerKey`** (Widget): Identifies your integration to the widget. Issued at onboarding alongside the ramp id.
- **`clientId`** (Risk SDK): Identifies your integration to the Risk Engine; the SDK refuses to initialise without it. Issued at onboarding, one per environment.
- **`transient auth token`** (Onboarding, Vault and Compliance SDKs): The 10-minute token your backend mints for each submit and hands to the page or app: it exchanges your API client ID and client secret for a partner access token, then calls Coinme's `browserAuth` endpoint. The Onboarding SDK and the Compliance SDK's attestation store send it through `getHeaders`; the Vault SDK as the `Authorization` header of the payment-method submit. Never pass the partner access token to any of them. The Compliance SDK's attestations are not available in the beta at this time. The agent can write the backend route; the client ID and secret are yours.
- **`partnerId / clientSecret`** (CaaS API clients): The partner credentials your backend exchanges for a CaaS API bearer token. One pair per environment, kept in your server's secret store and never in a browser or an app.
- **`COINME_CAAS_REGISTRY_TOKEN`** (CaaS API clients): The token that installs the CaaS API clients from their own registry. Like the SDK token, it belongs in an environment variable, never in a commit.

## Skills

The pages tell an agent what the platform is and how each SDK works. A skill tells it what to do: a procedure in the open Agent Skills format, with the prerequisites to check, the credentials to ask you for, the exact code in the right files, and how to verify the result. Each is generated from the same guides as the pages, so the two cannot disagree. Give your agent the URL, or drop the folder into your project where it keeps its skills.

- [coinme-widget-web](https://platformdocs.coinme.com/skills/coinme-widget-web/SKILL.md): Embeds the Coinme Widget in a web app with framekit: install, mount, events, live settings, Doctor checks.
- [coinme-widget-ios](https://platformdocs.coinme.com/skills/coinme-widget-ios/SKILL.md): Integrates the Coinme Widget into an iOS app with CoinmeBridge: package, config, view controller, delegate, session ready.
- [coinme-widget-android](https://platformdocs.coinme.com/skills/coinme-widget-android/SKILL.md): Integrates the Coinme Widget into an Android app with CoinmeBridge: dependency, config, fragment, listener, session ready.
- [coinme-onboarding-react](https://platformdocs.coinme.com/skills/coinme-onboarding-react/SKILL.md): Adds customer onboarding with non-documentary KYC to a React or JavaScript web app with the Onboarding SDK.
- [coinme-onboarding-react-native](https://platformdocs.coinme.com/skills/coinme-onboarding-react-native/SKILL.md): Adds customer onboarding with non-documentary KYC to a React Native or Expo app with the Onboarding SDK: install with its secure field peer, drop-in form or headless pieces, the onboarding token, error kinds, sandbox checks on both platforms.
- [coinme-compliance-react](https://platformdocs.coinme.com/skills/coinme-compliance-react/SKILL.md): Applies Coinme's compliance rules in a React or JavaScript web app with the Compliance SDK: provider, region status, rule helpers, localized consent and disclosure copy rendered safely, attestations after onboarding, and a checked transaction.
- [coinme-compliance-react-native](https://platformdocs.coinme.com/skills/coinme-compliance-react-native/SKILL.md): Applies Coinme's compliance rules in a React Native or Expo app with the Compliance SDK: the native platform and its storage, provider, region status, rule helpers, localized consent and disclosure copy rendered natively, attestations after onboarding, and disclosures before a transaction.
- [coinme-risk-web](https://platformdocs.coinme.com/skills/coinme-risk-web/SKILL.md): Adds the Risk SDK to a web app: install, set up the engine with your client ID, tag inputs, and get a session tag before each transaction.
- [coinme-risk-ios](https://platformdocs.coinme.com/skills/coinme-risk-ios/SKILL.md): Adds the Risk SDK to an iOS app: dependency, App Store disclosures, permissions, initialise, track inputs, submit before transactions.
- [coinme-risk-android](https://platformdocs.coinme.com/skills/coinme-risk-android/SKILL.md): Adds the Risk SDK to an Android app: dependency, Play requirements, permissions, ProGuard, initialise, track inputs, submit before transactions.
- [coinme-risk-react-native](https://platformdocs.coinme.com/skills/coinme-risk-react-native/SKILL.md): Adds the Risk SDK to a React Native or Expo app: native setup on both platforms, the fingerprint contract, tracked inputs, submit before transactions.
- [coinme-vault-js](https://platformdocs.coinme.com/skills/coinme-vault-js/SKILL.md): Adds card capture to a web app with the Vault SDK: secure fields, styling, validity, and submitting the payment method to Coinme with the transient auth token.
- [coinme-vault-ios](https://platformdocs.coinme.com/skills/coinme-vault-ios/SKILL.md): Adds card capture to an iOS app with the Vault SDK: package, configuration, fields, form state, and submitting with the transient auth token.
- [coinme-vault-android](https://platformdocs.coinme.com/skills/coinme-vault-android/SKILL.md): Adds card capture to an Android app with the Vault SDK: repository, dependency, fields in Kotlin, XML or Compose, and submitting with the transient auth token.
- [coinme-vault-react-native](https://platformdocs.coinme.com/skills/coinme-vault-react-native/SKILL.md): Adds card capture to a React Native or Expo app with the Vault SDK: provider, secure field components, hooks, and submitting with the transient auth token.
- [coinme-caas-api-clients](https://platformdocs.coinme.com/skills/coinme-caas-api-clients/SKILL.md): Calls the CaaS API from a Node.js backend with version 2 of the CaaS API clients: registry, AuthService, one client per area, environments, error handling and the move off 1.x.
- [coinme-wallet-address-validator](https://platformdocs.coinme.com/skills/coinme-wallet-address-validator/SKILL.md): Checks a wallet address for its asset and chain before your app stores it or sends to it, with the wallet address validator: strict mode, chainType for multi-chain assets, trimmed input and the three outcomes. Offline, for the Widget and CaaS alike.
