Getting Started

Prerequisites

Setup your project using the Get API Key guide.
A provider id that you've added to your app from Reclaim Devtools.

Setup your app for using Reclaim InApp SDK

Choose the appropriate installation guide based on your project setup:

React Native (No Framework)

Installation Guide for React Native projects without Expo

Examples

If you prefer to see a complete example of how to use the SDK in a React Native application, you can check out the following:

Basic Usage

Initialize the SDK

Import the package and create an instance of ReclaimVerification.

import { ReclaimVerification } from '@reclaimprotocol/inapp-rn-sdk';
 
const reclaimVerification = new ReclaimVerification();

Start Verification

Choose your preferred method to start the verification flow.

Initialize a session on your backend to keep your APP_SECRET secure.

Export the session config from your backend using request.toJsonString() (see how to setup a request on the backend).
Start verification with the config:

const verificationResult = await reclaimVerification.startVerificationFromJson(
                                        JSON.parse(requestJsonString)
                                    );

Verify the Result

After the verification is completed, you can submit and verify the proofs on your backend server using our JS SDK.

import { verifyProof } from "@reclaimprotocol/js-sdk";
 
// Important: This should happen on your backend server
verifyProof(verificationResult.proofs);

Exception Handling

If the verification ends with an exception, the exception is thrown as a ReclaimVerification.ReclaimVerificationException object.

This error object contains sessionId, reason, and innerError that can be used to get more details about the occurred error.

error.sessionId
error.reason
error.innerError

If you need more help, check out the Troubleshooting guide.

Want to further customize the verification experience? You can configure options, set up overrides, or use authentication with the attestor. Check out the Advanced Configuration guide for more details.

Stay Updated

Join our Telegram community
Follow @reclaimprotocol on Twitter
Watch our GitHub repository