Skip to Content
Onshore is in early access. Don’t load real customer data until the items in Known limits are closed.
DevelopersSDKsReact Native

React Native SDK Early access

@onshorehq/react-native collects and shows sensitive values in a React Native app using single-use client tokens. It holds no credentials.

Package@onshorehq/react-native
Sourcegithub.com/Onshore-HQ/onshore-react-native 
Peer dependenciesreact 18+, react-native 0.72+
Native codeNone. Works in Expo Go and bare apps
ExportscreateClient, CollectForm, RevealView, VaultError and types

Install

npm install @onshorehq/react-native

List your app under Vaults → Secure components as rvapp:// plus its ID in lower case (rvapp://com.yourbank.wallet), and have your server mint client tokens for that origin with createClientToken.

createClient

import { createClient } from "@onshorehq/react-native"; export const onshore = createClient({ baseUrl: "https://vault.yourbank.example", appOrigin: "rvapp://com.yourbank.wallet", timeoutMs: 15000, // default // fetch: myFetch, // e.g. one that pins certificates });
MethodReturns
describe(clientToken){ kind: "collect" | "reveal", fields: { name, data_type }[], tokens: number }. Doesn’t spend the token
collect(clientToken, values)Record<string, string>: a token per field. Spends the token unless a value fails its check
reveal(clientToken){ decision?, value?, error?: { code } }[]. Spends the token

CollectForm

import { CollectForm, VaultError } from "@onshorehq/react-native"; export function AddIdScreen({ route }) { const [message, setMessage] = useState<string>(); return ( <> <CollectForm client={onshore} clientToken={route.params.clientToken} labels={{ national_id: "National Insurance number" }} submitLabel="Save" onTokens={(t) => api.saveIdToken(t.national_id)} onError={(e: VaultError) => { if (e.code === "validation_failed") return; // fields are marked; fix and resubmit if (e.code === "invalid_client_token") setMessage("This form expired. Open it again."); else setMessage("Couldn't save. Try again."); }} /> {message && <Text>{message}</Text>} </> ); }
PropTypeDefault
clientfrom createClientrequired
clientTokenstringrequired
labelsRecord<string, string>{}
submitLabelstring"Continue"
onTokens(tokens) => voidrequired
onError(e: VaultError) => voidnone

Fields have autocorrect, autofill, suggestions and context menus turned off, use a number pad for numeric data types, and are cleared when the component unmounts.

RevealView

<RevealView client={onshore} clientToken={revealToken} hideAfter={30} onError={(e) => log(e.code)} />

Values are removed after hideAfter seconds, when the app goes to the background (AppState), and on unmount. A denied value shows “You do not have access to this”.

VaultError

class VaultError extends Error { code: "invalid_client_token" | "validation_failed" | "policy_denied" | "rate_limited" | "server" | "transport"; fields: string[]; // for validation_failed: names only status: number; }

Network errors become transport, without the underlying error, because it can carry the request.

Limits

Weaker than native and web. All JavaScript in a React Native app shares one context, so any library in the bundle could read a value while it’s typed. There’s no screenshot blocking (use a native module such as react-native-screenshot-prevent if you need it). rvapp:// is a name, not proof of which app is calling; set bind_ip when minting.

Tested: the client in Node against a live install, and the components with react-test-renderer. It hasn’t yet run inside a React Native app. Test on real devices before release.

Last updated on