---
title: "Coinme Onboarding SDK"
url: "https://platformdocs.coinme.com/#/docs/coinme-onboarding-sdk"
markdown: "https://platformdocs.coinme.com/docs/coinme-onboarding-sdk.md"
summary: "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."
surface: "caas"
updated: "2026-10-25"
---

# Coinme Onboarding SDK

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.

## What it does

The SDK covers the onboarding call and everything around it that would otherwise put your app in scope for handling an SSN. The customer types the SSN into the vault's secure field, and it travels from that field to the vault without passing through your code or your servers. On the web the field is an iframe, so the SSN never enters your page; in React Native it is a JavaScript component, so the SSN is in your app's runtime until the vault receives it, and the [React Native guide](https://platformdocs.coinme.com/docs/onboarding-sdk-react-native.md#security) lists what to keep away from it. Your code sees whether the SSN is valid, never the number.

Every other field is a plain input whose value you own, so you can prefill it, read it and validate it. Client-side validation runs before anything is sent, and every failure, from a malformed ZIP code to a sanctions match, arrives as one typed error with a `kind` you can branch on and a flag that tells you whether retrying is worth it.

You choose how much of the form you build. A drop-in form collects every field and calls you back with the customer ID. Headless building blocks, a provider, individual field components and one hook, let teams that own their UI wire the same behaviour into their own layout. Styling passes straight through to the elements underneath, with no theme contract and no Coinme branding.

Phone verification follows the same pattern: a drop-in step texts the code, takes it in one box per digit and calls you back once it checks out, and a hook gives teams that own their UI the same calls. It always verifies the number the customer onboarded with, which the form hands back alongside the `customerId`, and it runs again whenever a customer who never verified signs back in.

## What you need first

Before a customer reaches your onboarding form:

1. **Two tokens from your backend.** The onboarding request carries an `Authorization` header with a [Transient Auth Token](https://platformdocs.coinme.com/docs/transient-auth-token.md) your backend mints with `scope=onboarding` for the customer's sign-up session. Phone verification needs a second one, minted the same way for the `customerId` that onboarding returns. Your app fetches each from your backend just in time for each request and never stores it in the browser or on the device. Never give the SDK your partner access token in their place.
2. **A place for phone verification.** Plan the verification step right after onboarding, and on later sign-ins of a customer whose phone is not verified yet. Keep the `customerId` and the phone number on your backend so you can send that customer back to it.

The onboarding endpoint itself is described in Coinme's [customer onboarding guide](https://docs.coinme.com/docs/customer-onboarding-overview).

## Platforms

| Platform | Package | Status |
| --- | --- | --- |
| JavaScript: React, or any web app through the core API | `@coinme-security/onboarding-sdk-react` | Available |
| React Native: iOS and Android apps, Expo included | `@coinme-security/onboarding-sdk-react-native` | Available |

The JavaScript & React SDK is one package with two layers. The React layer is the drop-in form, the field components, the `useCustomerOnboarding` hook, and the `PhoneVerificationStep` and `usePhoneVerification` hook for phone verification. Underneath it is a framework-agnostic core that the React layer is built on and that any web app can call directly: `createOnboardingVault`, the secure SSN field, `validateCustomerOnboardingInput`, `submitCustomerOnboarding`, `sendPhoneVerificationCode`, `validatePhoneVerificationCode` and the typed errors. A plain JavaScript or non-React framework app imports it from the package's `/core` entry, which contains no React code, and does not install React: React is a peer dependency of the React layer only. The React Native SDK has the same drop-in form, field components, phone verification step and hooks, built from native components, and shares the fields, validation rules and error kinds; its secure SSN field is a React Native component from the vault rather than an iframe.

## How it relates to the other SDKs

The secure SSN field is a hosted field from the [Coinme Vault SDK](https://platformdocs.coinme.com/docs/coinme-vault-sdk.md), which the Onboarding SDK installs and configures for you; you never set up a vault yourself. The Onboarding SDK is one of the Coinme-as-a-Service SDKs, for apps that keep their own customers: alongside it, 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 device and behavioural signals Coinme requires before transactional calls. It is not used with the Coinme Widget, which onboards its users itself.

## Where to go next

Start with the [JavaScript & React SDK](https://platformdocs.coinme.com/docs/onboarding-sdk-react.md): the quickstart puts the drop-in form on a page in a few lines, and the rest of the document covers layout control, the headless API, styling, the core API, validation and error handling. For an iOS or Android app built with React Native, start with the [React Native SDK](https://platformdocs.coinme.com/docs/onboarding-sdk-react-native.md), which covers the same ground with native components.
