4. Open your strings.xml file. Example path: /app/src/main/res/values/strings.xml and add a new string with the name "partnerKey" and value as your "appKey"

5. Open your AndroidManifest.xml and add a meta-data element to the application element

Copy

<application android:label="@string/app_name" ...>
...
<meta-data android:name="com.truecaller.android.sdk.PartnerKey" android:value="@string/partnerKey"/>
...
</application>

In order to clear the resources taken up by SDK, you can use the method TruecallerSDK.clear(); You can call this method when the activity/fragment in which you have initialised the SDK is getting killed/destroyed.

For example :

Copy

7. Add the following condition in the onActivityResult method TruecallerSDK.getInstance().onActivityResultObtained( this,requestCode, resultCode, data)

Copy

@Override
protected void onActivityResult(int requestCode, int resultCode, @Nullable Intent data) {
    super.onActivityResult(requestCode, resultCode, data);
    if (requestCode == TruecallerSDK.SHARE_PROFILE_REQUEST_CODE) {
       TruecallerSDK.getInstance().onActivityResultObtained(this, requestCode, resultCode, data);
    }
}

Note : In case you passed Fragment in the getUserProfile() method [ point #6 ], override the onActivityResult() method in your corresponding Fragment

8. In your selected Activity/Fragment, either make the component implement ITrueCallback or create an instance of it :

Copy

private final ITrueCallback sdkCallback = new ITrueCallback() {
    
     @Override
     public void onSuccessProfileShared(@NonNull final TrueProfile trueProfile) {
     }

     @Override
     public void onFailureProfileShared(@NonNull final TrueError trueError) {
     }
     
     @Override
     public void onVerificationRequired(@Nullable final TrueError trueError) {
     }
     
 };

onSuccessProfileShared() method will be called in either of the following two scenarios : a.) When the user has agreed to share his profile information with your app by clicking on the "Continue" button on the Truecaller dialog b.) When a non Truecaller user is already verified previously on the same device. This would only happen when the TruecallerSdkScope#SDK_OPTION_WITH_OTP is selected while initialising the SDK to provision for the verification of non-Truecaller users also.

onFailureProfileShared() method will be called when some error occurs or if an invalid request for verification is made. You'll get the respective error code as per the details mentioned here.

onVerificationRequired() method will only be called whenTruecallerSdkScope#SDK_OPTION_WITH_OTP is selected. This will be called when the user is not a Truecaller app user. Also, you'll get a Nullable TrueError only when TC app is installed and user is logged in. For other cases, it would be null. This optional TrueError can be used to determine the user action that led to initiating manual verification. So using this TrueError, you can get to whether the user pressed on the footer CTA on the verification screen OR the system back button.

Write all the relevant logic in the above callback methods to handle the scenarios appropriately.

Truecaller SDK provides you with capabilities to configure the following :

Contextual text prefix [ .loginTextPrefix() ] To provide appropriate context of verification to the Truecaller user, use one of the below mentioned TruecallerSdkScope values to show the corresponding message to the user.

Contextual text suffix [ .loginTextSuffix() ] To provide appropriate context of verification to the Truecaller user and set the suffix string

Button text options [ .ctaTextPrefix() ] To set the prefix on the CTA button

Button shape [ .buttonShapeOptions() ] To chose the shape of the CTA button

Footer CTA text [ .footerType() ] To configure the text of the additional footer CTA present at the bottom

Privacy policy text [ .privacyPolicyUrl() ] To add your privacy policy link on the verification screen ( optional ), you can configure the respective hyperlink as mentioned below

Copy

Terms of service text [ .termsOfServiceUrl() ] To add your terms of service link on the verification screen ( optional ), you can configure the respective hyperlink as mentioned below

Copy

Language To customise the profile dialog in any of the supported Indian languages To do so, add the following lines before calling the "getUserProfile()" method as mentioned in the previous step

Copy

Currently supported languages :

Truecaller SDK does not require any additional app permissions if you are using the SDK for verification of only Truecaller users.

To enable verification flow for non-Truecaller users as well, the SDK needs specific android permissions to enable the drop call based background verification flow. For details, please refer

Once you receive a callback in your VerificationCallback instance with the requestCode TYPE_MISSED_CALL_RECEIVED or TYPE_OTP_RECEIVED , you can complete the verification process by calling the following method from within your activity :

Copy

TrueProfile profile = new TrueProfile.Builder(firstName, lastName).build();

You need to create a TrueProfile instance by passing the user's first and last name as defined above.

Depending on whether the verification medium is drop call or OTP, you need to call one of the following methods respectively:

DropcallOTPCopy

TruecallerSDK.getInstance().verifyMissedCall(profile, apiCallback)

You need to call this method once you have received callback with requestCode as TYPE_MISSED_CALL_RECEIVED in your VerificationCallback instance

After you call the above method, you will receive a callback in your VerificationCallback instance with requestCode as TYPE_VERIFICATION_COMPLETE, which completes your verification process.

Whenever you get the verification callback with requestType as TYPE_VERIFICATION_COMPLETE, you would get an accessToken as a parameter in the verificationDataBundle. You can use this access token to validate the authenticity of the verification flow by making an API call from your server to Truecaller's server. For details on this part, please refer here.

This section defines the steps that can be used to trigger verification of non Truecaller app users which will be powered via Truecaller's drop call based verification flow

In order to verify non Truecaller users, the SDK requires the below mentioned permissions -

Copy

For Android 8 and above :

<uses-permission android:name="android.permission.READ_PHONE_STATE"/>
<uses-permission android:name="android.permission.READ_CALL_LOG"/>
<uses-permission android:name="android.permission.ANSWER_PHONE_CALLS"/>


For Android 7 and below :

<uses-permission android:name="android.permission.READ_PHONE_STATE"/>
<uses-permission android:name="android.permission.READ_CALL_LOG"/>
<uses-permission android:name="android.permission.CALL_PHONE"/>

Once you receive a callback in the ITrueCallback#onVerificationRequired(), you can initiate the verification for the user by calling the following method:

Copy

try{
   TruecallerSDK.getInstance().requestVerification("IN", PHONE_NUMBER_STRING, apiCallback, ExampleActivity.this);
}catch (RuntimeException e){
   Log.i(TAG, e.getMessage());
}

Here -

• the first parameter is the country code of the mobile number for which the verification needs to be triggered

• the second parameter (PHONE_NUMBER_STRING) is the mobile number to be verified. Please ensure proper validations are in place so as to send correct phone number string to the above method, otherwise an exception would be thrown

• the third parameter is an instance of VerificationCallback as defined here

• the fourth parameter is an instance of FragmentActivity

Please note that Truecaller SDK v2.8.0 currently supports the verification for non-Truecaller users for Indian numbers only.

Once you initiate the verification via TruecallerSDK.getInstance().requestVerification() method, you will receive either a callback in your VerificationCallback instance with a specificrequestType as described below

Copy

static final VerificationCallback apiCallback = new VerificationCallback() {

     @Override
     public void onRequestSuccess(int requestCode, @Nullable VerificationDataBundle extras) {
 	    
        if (requestCode == VerificationCallback.TYPE_MISSED_CALL_INITIATED) {
               if(extras != null){
                      extras.getString(VerificationDataBundle.KEY_TTL)
                      extras.getString(VerificationDataBundle.KEY_REQUEST_NONCE)
 	      }
        }
 
        if (requestCode == VerificationCallback.TYPE_MISSED_CALL_RECEIVED) {
 	}
 
        if (requestCode == VerificationCallback.TYPE_VERIFICATION_COMPLETE) {
               if(extras != null) 
                      extras.getString(VerificationDataBundle.KEY_REQUEST_NONCE)
	}
 
        if (requestCode == VerificationCallback.TYPE_PROFILE_VERIFIED_BEFORE) {
               if(extras!=null)
                      extras.getProfile().requestNonce
 	}
 
     }

     @Override
     public void onRequestFailure(final int requestCode, @NonNull final TrueException e) {
     }
     
 };

onRequestSuccess() method is called under any of the following scenarios -

• When drop call is successfully initiated for the input mobile number. In this case, you will get the requestCode as VerificationCallback.TYPE_MISSED_CALL_INITIATED

• When drop call is successfully detected on that device by the SDK present in your app. In this case, you will get the requestCode as VerificationCallback.TYPE_MISSED_CALL_RECEIVED

• When the verification is successful for a particular number. In this case, you will get the requestCode as VerificationCallback.TYPE_VERIFICATION_COMPLETE

• When the user is already verified on that particular device before. In this case, you will get the requestCode as VerificationCallback.TYPE_PROFILE_VERIFIED_BEFORE

When requestCode is VerificationCallback.TYPE_MISSED_CALL_INITIATED, you will receive an additional parameter for the time to live i.e TTL (in seconds) which is passed as String extra in the VerificationDataBundle of onRequestSuccess(). This value determines amount of time left to complete the verification. You can use this value to show a waiting message to your user before they can try for another attempt. Once the TTL expires, you can either auto-retry the verification by calling the requestVerification() method automatically with the same input parameters OR you can also take the user back to the number input screen to enter a different number for verification.

NOTE: Truecaller SDK v2.5.0 & above won't throw timeout exceptions for missed call, so please use the TTL as stated above to control the time out scenario.

When the requestCode is VerificationCallback.TYPE_ALREADY_VERIFIED_BEFORE or VerificationCallback.TYPE_VERIFICATION_COMPLETE, it means that the user verification via Truecaller SDK is complete. In these cases, the SDK will share an additional access token with your application, which you may then use to validate the response at your server end. To fetch the access token, you may use the following code snippet :

//For when the control goes to TYPE_ALREADY_VERIFIED_BEFORE extras.getProfile().accessToken

//For when the control goes to TYPE_VERIFICATION_COMPLETE extras.getString(VerificationDataBundle.KEY_ACCESS_TOKEN)

Post fetching the access token, you may perform the server side validation by referring to the steps mentioned in the later part of the documentation here.

onRequestFailure() method will be called when some error has occurred while verifying the provided mobile number. You will receive the appropriate error message from TrueException using TrueException#getExceptionMessage().For details of different possible error types you may encounter, please refer to the next section.

Advanced steps for validating the request-response correlation:

Every request sent via a Truecaller app that supports Truecaller SDK has a unique identifier. This identifier is bundled into the response for assuring a correlation between a request and a response. If you want you can check this correlation yourself by:

1. You can use your own custom request identifier via the TrueClient with TruecallerSDK.getInstance().setRequestNonce(customHash);

Note : The customHash must be a base64 URL safe string with a minimum character length of 8 and maximum of 64 characters

2. In ITrueCallback.onSuccesProfileShared(TrueProfile) verify that the previously generated identifier matches the one in TrueProfile.requestNonce.

IMPORTANT: Truecaller SDK already verifies the request-response correlation before forwarding it to the your app.

6. Create a TruecallerSdkScope object by using the appropriate configurational settings and use it to initialise the TruecallerSDK in your android activity's onCreate method :

Copy

TruecallerSdkScope trueScope = new TruecallerSdkScope.Builder(this, sdkCallback)
        .consentMode(TruecallerSdkScope.CONSENT_MODE_BOTTOMSHEET)
        .buttonColor(Color.parseColor(colorSpinner.getSelectedItem().toString()))
        .buttonTextColor(Color.parseColor(colorTextSpinner.getSelectedItem().toString()))
        .loginTextPrefix(TruecallerSdkScope.LOGIN_TEXT_PREFIX_TO_GET_STARTED)
        .loginTextSuffix(TruecallerSdkScope.LOGIN_TEXT_SUFFIX_PLEASE_VERIFY_MOBILE_NO)
        .ctaTextPrefix(TruecallerSdkScope.CTA_TEXT_PREFIX_USE)
        .buttonShapeOptions(TruecallerSdkScope.BUTTON_SHAPE_ROUNDED)
        .privacyPolicyUrl("<<YOUR_PRIVACY_POLICY_LINK>>")
        .termsOfServiceUrl("<<YOUR_PRIVACY_POLICY_LINK>>")
        .footerType(TruecallerSdkScope.FOOTER_TYPE_NONE)
        .consentTitleOption(TruecallerSdkScope.SDK_CONSENT_TITLE_LOG_IN)
        .sdkOptions(TruecallerSdkScope.SDK_OPTION_WITHOUT_OTP)
.build();          

TruecallerSDK.init(trueScope);

You will find complete details on the configuration options in the TruecallerSdkScope object as described above, and all the possible available values in the immediate next section of this documentation here.

Truecaller SDK needs to be initialised only once and the same instance can be accessed at any place within your app, without the need to initialise it again, via TruecallerSDK.getInstance()

Once you initialise the TruecallerSDK using the init() method, if you are using the SDK for verification of only Truecaller users ( by setting the sdkOptions scope as TruecallerSdkScope.SDK_OPTION_WITHOUT_OTP ), you can check if the Truecaller app is present on the user's device or not by using the following method

Copy

TruecallerSDK.getInstance().isUsable()

You can trigger the Truecaller profile verification dialog anywhere in your app flow by calling the following method

Copy

TruecallerSDK.getInstance().getUserProfile() 

You can trigger the Truecaller profile verification dialog anywhere in your app flow by calling the following method

Copy

TruecallerSDK.getInstance().getUserProfile() 

In case isUsable() method returns false, implying that Truecaller app is not present on the device, you can take the user to your app screen and continue with the verification flow for non-Truecaller users OR choose to use your own verification flow [ Refer image below ].

1. Ensure that your Minimum SDK version is at least API level 22 or above ( Android 5.1 ). In case your android project compiles for API level below 22, you can include the following line in your AndroidManifest.xml file to avoid any compilation issues :

Copy

Using this would ensure that the sdk works normally for API level 22 & above, and would be disabled for API level < 22 Please make sure that you put the necessary API level checks before accessing the SDK methods in case compiling for API level < 22

2. Add the following dependency in your app level build.gradle file :

Copy

Also, add the following lines of code in your gradle file, if not already present

Copy

Add mavenCentral() in your project level build.gradle file :

Copy

Failure/ Error responses

The "onFailureProfileShared" callback method that you just implemented in the previous step helps you to handle all the possible failure cases when the user couldn't be verified successfully via the Truecaller flow.

Below are some of the possible failure scenarios and the corresponding error response that you receive for each of the cases :

*Error Type 4 and Error Type 10 could arise in different conditions depending on whether the user has not registered on Truecaller app on their smartphone or if the user has deactivated their Truecaller profile at any point of time from the app.

Apart from the above mentioned error cases, there are few other error scenarios that you may encounter under rare circumstances. For complete and exhaustive list of all the error cases, you can refer to TrueError.class within the SDK.

Please note that when you encounter any of the error scenarios and get the control in the "onFailureProfileShared()" method, you should redirect the user to your alternate verification flow.

Exceptions

In case you face any of the following run time exceptions, please follow the recommended steps as mentioned below :

"No compatible client available. Please change your scope"

As the exception suggests, you are trying to call an SDK method even though no client is available to handle it. This usually happens if you have initialised the SDK using WITHOUT_OTP scope option i.e to verify only the Truecaller users, and you are not calling isUsable() method before calling an SDK method. To resolve this, call isUsable() before calling any SDK method if you are using WITHOUT_OTP scope option

"Please call init() on TruecallerSDK first"

This exception suggests that you are trying to call an SDK method before the SDK has been initialised. To resolve it, check for all possible user flows in your app which could lead to calling an SDK method directly before it has been initialised.