> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.withpersona.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.withpersona.com/_mcp/server. # Android SDK v1 Integration Guide > **Warning** > > #### Looking for v2? > > If your Template starts with `tmpl_`, you're on v1. > > **We will stop making updates to v1 on December 31, 2022**. You will still be able to create inquiries, but no new features or fixes will be available. We recommend moving to v2 for access to the latest product improvements- please see [migration to v2 section](/migrate-from-android-sdk-v1-to-v2) or [contact us](https://app.withpersona.com/dashboard/contact-us). > **Info** > > If you want to dive right in to the Javadocs, [you can do so here](https://sdk.withpersona.com/android/v1/docs/com/withpersona/sdk/inquiry/package-summary.html). The Persona Inquiry flow lets you securely and seamlessly collect your user's information. ## Integration Integrate the Persona Inquiry flow directly into your Android app with our native SDK. ### Requirements - Make sure the SDK is compatible Your application needs to have a minSdkVersion set to API 21 (Lollipop, 5.0) or higher. ### Dependencies - Adding Persona to your project In your `app/build.gradle` file (or wherever you plan on using the SDK) include the following: **`groovy`** ```groovy groovy repositories { google() jcenter() maven { url 'https://sdk.withpersona.com/android/releases' } } android { // ... compileOptions { sourceCompatibility JavaVersion.VERSION_1_8 targetCompatibility JavaVersion.VERSION_1_8 } } dependencies { // ... implementation 'com.withpersona.sdk:inquiry:X.Y.Z' // ... } ``` ![Inquiry SDK latest](https://img.shields.io/maven-metadata/v?versionPrefix=1\&label=Inquiry%20SDK\&metadataUrl=https%3A%2F%2Fsdk.withpersona.com%2Fandroid%2Freleases%2Fcom%2Fwithpersona%2Fsdk%2Finquiry%2Fmaven-metadata.xml) ## Usage ### Launching the Inquiry flow The `Inquiry` flow is initiated with a builder pattern based on either template or inquiry. Everything on the builder is optional: `theme`, `referenceId`, `accountId`, and `environment` (which defaults to `PRODUCTION`). #### Kotlin **`kotlin`** ```kotlin kotlin // pick any number and then use it later to retrieve the response val VERIFY_REQUEST_CODE = 43 // Get the template ID from the Dashboard // https://withpersona.com/dashboard/integration val TEMPLATE_ID = "tmpl_JAZjHuAT738Q63BdgCuEJQre" // ... Inquiry.fromTemplate(TEMPLATE_ID) .environment(Environment.SANDBOX) .build() .start(this, VERIFY_REQUEST_CODE) ``` #### Java ``` // pick any number and then use it later to retrieve the response static final int VERIFY_REQUEST_CODE = 43; // Get the template ID from the Dashboard // https://withpersona.com/dashboard/integration static final String TEMPLATE_ID = "tmpl_JAZjHuAT738Q63BdgCuEJQre"; // ... Inquiry.fromTemplate(TEMPLATE_ID) .environment(Environment.SANDBOX) .build() .start(this, VERIFY_REQUEST_CODE); ``` ### Receiving the response #### Kotlin **`kotlin`** ```kotlin kotlin // overwriting the Activity#onActivityResult override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) { super.onActivityResult(requestCode, resultCode, data) if (requestCode == VERIFY_REQUEST_CODE) { when(val result = Inquiry.onActivityResult(data)) { is Inquiry.Response.Success -> { // ... } is Inquiry.Response.Failure -> { // ... } Inquiry.Response.Cancel -> { // ... } is Inquiry.Response.Error -> { // ... } } } } ``` #### Java ``` @Override protected void onActivityResult(int requestCode, int resultCode, @Nullable Intent data) { super.onActivityResult(requestCode, resultCode, data); if (requestCode == VERIFY_REQUEST_CODE) { Inquiry.Response response = Inquiry.onActivityResult(data); if (response instanceof Inquiry.Response.Success) { Inquiry.Response.Success success = (Inquiry.Response.Success) response; // ... } else if (response instanceof Inquiry.Response.Failure) { Inquiry.Response.Failure failure = (Inquiry.Response.Failure) response; // ... } else if (response instanceof Inquiry.Response.Cancel) { // ... } else if (response instanceof Inquiry.Response.Error) { Inquiry.Response.Error error = (Inquiry.Response.Error) response; // ... } } } ``` ## Customization Make the Persona Inquiry flow look and feel like your app. ### Theming Set your own colors, buttons, fonts, and more. First, make a style in your `styles.xml` file that extends the Persona style. The following example would generate `R.style.BlueDemoTheme`. ``` ``` Then set in as the theme in `Inquiry` builder. **`kotlin`** ```kotlin kotlin Inquiry.fromTemplate(TEMPLATE_ID) .theme(R.style.BlueDemoTheme) .build() .start(this, VERIFY_REQUEST_CODE) ``` Customizable attributes include colors, fonts, text alignments, images, and animations. ### Customizing Fonts In order to specify fonts on Android, the fonts either must be system fonts or fonts bundled into your application. #### Providing a custom font If you would like to provide your own custom font, first create a font resource by following the follow guide: [https://developer.android.com/guide/topics/ui/look-and-feel/fonts-in-xml](https://developer.android.com/guide/topics/ui/look-and-feel/fonts-in-xml). Then you can supply your custom font in `styles.xml`: ``` ``` ### Replacing Strings Replace any title, body, or button text by overwriting our strings in your `strings.xml` file. ``` This is the start screen title. This is below that in the body. I\'m a button! ``` #### Available String Keys * persona\_contact\_support\_body * persona\_contact\_support\_button * persona\_contact\_support\_title * persona\_countryselect\_body * persona\_countryselect\_button * persona\_countryselect\_title * persona\_governmentid\_failed\_title * persona\_governmentid\_start\_body * persona\_governmentid\_start\_title * persona\_governmentid\_submitting\_body * persona\_governmentid\_submitting\_title * persona\_inquiry\_complete\_body * persona\_inquiry\_complete\_button * persona\_inquiry\_complete\_title * persona\_inquiry\_failed\_body * persona\_inquiry\_failed\_button * persona\_inquiry\_failed\_title * persona\_inquiry\_start\_body * persona\_inquiry\_start\_button * persona\_inquiry\_start\_title * persona\_selfie\_failed\_body * persona\_selfie\_failed\_button * persona\_selfie\_failed\_title * persona\_selfie\_start\_body * persona\_selfie\_start\_button * persona\_selfie\_start\_title * persona\_selfie\_submitting\_body * persona\_selfie\_submitting\_title * persona\_database\_start\_body * persona\_database\_start\_button * persona\_database\_start\_title