> For the complete documentation index, see [llms.txt](https://valify.gitbook.io/valify-ios-sdk-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://valify.gitbook.io/valify-ios-sdk-documentation/document-capture/react-native-plugin/installation-guide.md).

# Installation Guide

### iOS **Minimum Requirements**

* iOS Version: 12
* Xcode Version: 15
* Camera access is mandatory

### Android **Minimum Requirements**

* Jetpack Library: AndroidX
* Java Version: 11
* API Level: 21 or higher (Android 5.0)
* Compile SDK: 32 or higher
* Camera access is mandatory (**NOTE :** The SDK handles permission requests, so you don't need to implement them in your app).

### **Installation**

Add the following commands in your terminal to download the plugin

1. npm install @valifysolutions/react-native-vidvocr@\<LATEST\_VERSION>
2. npm pod-install (ONLY FOR IOS)

{% hint style="info" %}
Latest Version: 3.5.1
{% endhint %}

#### iOS Project

In info.plist add the following permissions:

* Required: “NSCameraUsageDescription”
* Optional: “NSLocationWhenInUseUsageDescription” **Only if you’re willing to use “collect\_user\_info” option**

#### Android Project

Open the file `Gradle Scripts | gradle.properties` enable the following:

```groovy
android.enableJetifier=true
android.useAndroidX=true
```

Please note that location access needs to be granted if you’re welling to use “collect\_user\_info” option to collect the user's geolocation and timezone

Add this code into your AndroidManifest.xml file :<br>

```xml
<manifest xmlns:android="http://s...content-available-to-author-only...d.com/apk/res/android"
    xmlns:tools="http://s...content-available-to-author-only...d.com/tools">
    <!-- Add the meta-data element here with tools:replace -->
        <meta-data
            android:name="com.google.mlkit.vision.DEPENDENCIES"
            android:value="ocr"
        tools:replace="android:value" />
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://valify.gitbook.io/valify-ios-sdk-documentation/document-capture/react-native-plugin/installation-guide.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
