Native Android & iOS Apps

Overview

To integrate our onboarding UI in your native Android and iOS apps, you can call our API to create a session and we'll return the onbording URL which you will have to display in WebView.

AiPrise hosts the entire flow on its servers so PII never flows through your app.

References for loading WebView in your app:

Android Guide: https://developer.android.com/develop/ui/views/layout/webapps/webview
iOS Guide: https://developer.apple.com/documentation/webkit/wkwebview

Getting the URL

Use the Get User Verification URL API to get the URL. In the request, you send us the template_id (provided to you by AiPrise) and the redirect_uri. If you are using it on an Android app, the redirect uri should be android and for iOS it should be ios.

You can also pass in more information like theme options, user data, etc.

Following shows a sample cURL request to get the Verification URL. More here.

curl --request POST \
     --url https://api-sandbox.aiprise.com/api/v1/verify/get_user_verification_url \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --header 'X-API-KEY: <YOUR_API_KEY>' \
     --data '
{
     "redirect_uri": "android",
     "template_id": "cc82dfa0-6134-4b8a-b6ea-19d9ad8704ac",
     "theme_options": { // Optional
        ..
     }
}
'

NOTE: The verification URL is only active for 24 hours.

Sample Response:

{
    "message": "success",
    "verification_url": "https://verify-sandbox.aiprise.com/?verification_session_id=4dec3ec0-4214-4fe3-9a33-64bd176dd355"
}

After this, you just have to show it in a webview. For futher instructions, check the iOS settings and Android settings guide.