How to get unique device id in flutter?
Asked Answered
R

14

120

In Android we have, Settings.Secure.ANDROID_ID. I do not know the iOS equivalent. Is there a flutter plugin or a way to get a unique device id for both Android and IOS in flutter?

Rhoea answered 11/7, 2017 at 10:7 Comment(5)
Does this unique ID be changed in any case or would remain same and never changed? If changed, what are the scenarios in which it would change?Bacteriolysis
UPDATE: Because this thread has a very high Google ranking I wanted to mention here that the device_id package has been discontinued. The package platform_device_id looks like it works about the same way though, and has very recent activity. We're switching over to that after seeing errors in the log after iOS crashes which point to the old package.Farman
On Android devices, there can be multiple users for the device. Is there a way to get a unique ID per user on the device?Attendance
@spycbanda did you find the answer of your question, I have the same question like yoursMisjoinder
I have been using device_info_plus for a while and came to realize the android Id is not unique.Users with similar devices have similar Ids.Tamtama
P
142

Null safe code

Use device_info_plus plugin developed by Flutter community. This is how you can get IDs on both platform.

In your pubspec.yaml file add this:

dependencies:
  device_info_plus: ^3.2.3

Create a method:

Future<String?> _getId() async {
  var deviceInfo = DeviceInfoPlugin();
  if (Platform.isIOS) { // import 'dart:io'
    var iosDeviceInfo = await deviceInfo.iosInfo;
    return iosDeviceInfo.identifierForVendor; // unique ID on iOS
  } else if(Platform.isAndroid) {
    var androidDeviceInfo = await deviceInfo.androidInfo;
    return androidDeviceInfo.androidId; // unique ID on Android
  }
}

Usage:

String? deviceId = await _getId();
Pelletier answered 17/10, 2019 at 15:22 Comment(11)
Does this unique ID be changed in any case or would remain same and never changed? If changed, what are the scenarios in which it would change?Bacteriolysis
It's known to be null sometimes, it's documented as "can change upon factory reset". Use at your own risk, and it can be easily changed on a rooted phone.Homeomorphism
@spycbanda Google Play Store release had a different ID vs debug development for me.Scriptwriter
Just tested this: The ID stays the same until the program is deleted. If re-installed, the ID is different.Homoiousian
After adding this plugin app not working in iPhone emulatorArbogast
@Arbogast It may not work on the iPhone simulator, you need to use it in real device.Pelletier
The serial number returned by iosDeviceInfo.identifierForVendor seems to change every time I upgrade the IOS version/build in Xcode Identity block on my app. Anyone knows a way to avoid this serial change?Hanforrd
Is there a way to get an ID that stays the same across installs?Conchita
Looks like androidDeviceInfo.androidId does not exist in 4.1.2.Pegeen
For device_info_plus: "Remove androidId (that already got removed from the method channel in 4.0.0, thus always returned null) There is a new, separate pub.dev package for getting the correct androidId" , so you now need to get it from the package "android_id"Manners
@Manners are you sure that AndroidDeviceInfo.id is not that androidId that we need? Also the version of android_id package is currently 0.3.3 which honestly scares me a little bit to use it in productionCassell
L
100

There is a plugin called device_info. You can get it here.

Check the official example here

 static Future<List<String>> getDeviceDetails() async {
    String deviceName;
    String deviceVersion;
    String identifier;
    final DeviceInfoPlugin deviceInfoPlugin = new DeviceInfoPlugin();
    try {
      if (Platform.isAndroid) {
        var build = await deviceInfoPlugin.androidInfo;
        deviceName = build.model;
        deviceVersion = build.version.toString();
        identifier = build.androidId;  //UUID for Android
      } else if (Platform.isIOS) {
        var data = await deviceInfoPlugin.iosInfo;
        deviceName = data.name;
        deviceVersion = data.systemVersion;
        identifier = data.identifierForVendor;  //UUID for iOS
      }
    } on PlatformException {
      print('Failed to get platform version');
    }

//if (!mounted) return;
return [deviceName, deviceVersion, identifier];
}

You can store this UUID in the Keychain. This way you can set an unique ID for your device.

UPDATE

device_info is now device_info_plus

Lafontaine answered 9/3, 2018 at 5:40 Comment(11)
How do I get the android device id? can it be retrieved from device_info?Meditate
if (Platform.isAndroid) { .... identifier = build.androidId; ...} else if (Platform.isIOS) { ..... }Sarajane
Does this require any permissions from the user?Asleep
@ScottF Did you ever figure out if it is legal and requires any permission from the user?Jahveh
@Chaythanya example_here link is not working, i think it is broken. Please check and update it. Thanks.Homeomorphism
@Chaythanya Does this unique ID be changed in any case or would remain same and never changed? If changed, what are the scenarios in which it would change?Bacteriolysis
It's known to be null sometimes, it's documented as "can change upon factory reset". Use at your own risk, and it can be easily changed on a rooted phone.Homeomorphism
now you should use device_info_plus: pub.dev/packages/device_info_plusPompon
On iOS devices, identifierForVendor does change if the user uninstalls, then reinstalls your app, so it's not a 100% reliable constant.Lindie
build.version will return an instance, which variable that we should use?Gleda
On the latest version of the plugin androidId was replaced with just id and is no longer unigue, i learned it the hard way identifier = build.androidId -> identifier = build.id;Unawares
A
17

Update 1/3/2021: The recommended way is now the extended community plugin called device_info_plus. It supports more platforms than device_info and aims to support all that are supported by flutter. Here is an example usage:

import 'package:flutter/foundation.dart' show kIsWeb;
import 'package:device_info_plus/device_info_plus.dart';
import 'dart:io';

Future<String> getDeviceIdentifier() async {
  String deviceIdentifier = "unknown";
  DeviceInfoPlugin deviceInfo = DeviceInfoPlugin();

  if (Platform.isAndroid) {
    AndroidDeviceInfo androidInfo = await deviceInfo.androidInfo;
    deviceIdentifier = androidInfo.androidId;
  } else if (Platform.isIOS) {
    IosDeviceInfo iosInfo = await deviceInfo.iosInfo;
    deviceIdentifier = iosInfo.identifierForVendor;
  } else if (kIsWeb) {
    // The web doesnt have a device UID, so use a combination fingerprint as an example
    WebBrowserInfo webInfo = await deviceInfo.webBrowserInfo;
    deviceIdentifier = webInfo.vendor + webInfo.userAgent + webInfo.hardwareConcurrency.toString();
  } else if (Platform.isLinux) {
    LinuxDeviceInfo linuxInfo = await deviceInfo.linuxInfo;
    deviceIdentifier = linuxInfo.machineId;
  } 
  return deviceIdentifier;
}
Amen answered 4/1, 2021 at 10:22 Comment(2)
As stated in Android and IOS documentations, androidId and identifierForVendor can change over time.Epicycle
For device_info_plus: "Remove androidId (that already got removed from the method channel in 4.0.0, thus always returned null) There is a new, separate pub.dev package for getting the correct androidId" , so you now need to get it from the package "android_id"Manners
C
10

As of 2022, December, last status about getting device id :

device_info_plus don't give unique device id anymore. So I started to use platform_device_id package.

I tested it on Android and it worked as same as device_info previously and provide the same id value. It also has a simple usage :

   String deviceId = await PlatformDeviceId.getDeviceId;

This package uses updated android embedding version and also has null safety support.

Cerography answered 3/12, 2022 at 5:40 Comment(3)
that package has been abandoned because last update is 20 months agoDecalcify
device_info: ^2.0.3 platform_device_id: ^1.0.1 These both packages are depricated and old. However everyone can use android_id: ^0.1.3+1 package just for android.Delrosario
eventhough platform_device_id is an old package, it is Dart 3 compatible and got me unique deviceId unlike device_info_plus. Thank you @Cerography for mentioning itCallahan
Z
9

Latest:

The plugin device_info has given deprecation notice and replaced by device_info_plus

Example:

dependencies:
  device_info_plus: ^9.0.2

How to use:

import 'package:device_info_plus/device_info_plus.dart';

DeviceInfoPlugin deviceInfo = DeviceInfoPlugin();

AndroidDeviceInfo androidInfo = await deviceInfo.androidInfo;
print('Running on ${androidInfo.model}');  // e.g. "Moto G (4)"

IosDeviceInfo iosInfo = await deviceInfo.iosInfo;
print('Running on ${iosInfo.utsname.machine}');  // e.g. "iPod7,1"

WebBrowserInfo webBrowserInfo = await deviceInfo.webBrowserInfo;
print('Running on ${webBrowserInfo.userAgent}');  // e.g. "Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:61.0) Gecko/20100101 Firefox/61.0"

You can check here full example:

For Unique ID:

You can use following code to get Unique ID:

String deviceIdentifier = '';
DeviceInfoPlugin deviceInfo = DeviceInfoPlugin();
if (kIsWeb) {
  final WebBrowserInfo webInfo = await deviceInfo.webBrowserInfo;
  deviceIdentifier = webInfo.vendor! +
      webInfo.userAgent! +
      webInfo.hardwareConcurrency.toString();
} else {
  if (Platform.isAndroid) {
    final AndroidDeviceInfo androidInfo = await deviceInfo.androidInfo;
    deviceIdentifier = androidInfo.id;
  } else if (Platform.isIOS) {
    final IosDeviceInfo iosInfo = await deviceInfo.iosInfo;
    deviceIdentifier = iosInfo.identifierForVendor!;
  } else if (Platform.isLinux) {
    final LinuxDeviceInfo linuxInfo = await deviceInfo.linuxInfo;
    deviceIdentifier = linuxInfo.machineId!;
  }
}

edit: There is no androidId on since v4.1.0.

Zara answered 8/7, 2021 at 6:40 Comment(5)
It's not a good solution because iosInfo changes with each app upgrade/reinstall.Competition
hardwareConcurrency is not a good example. It will return the number of cores on the machine, not very unique..Competition
For device_info_plus: "Remove androidId (that already got removed from the method channel in 4.0.0, thus always returned null) There is a new, separate pub.dev package for getting the correct androidId" , so you now need to get it from the package "android_id"Manners
UPDATE: device_info_plus does not give unique androidId anymoreMohammedanism
IMO for platform web you should not use browser info or user agent, instead generate a unique identifier using uuid packageTrantham
C
7

Use device_id plugin

  1. Add in your following code in your .yaml file.

    device_id: ^0.1.3
    
  2. Add import in your class

    import 'package:device_id/device_id.dart';
    
  3. Now get device id from:

    String deviceid = await DeviceId.getID;
    
Cuckoopint answered 9/8, 2019 at 10:54 Comment(2)
This will force your app to have android.permission.READ_PHONE_STATE. And this will cause a warning while publishinh your app to Play Store as Apps using these permissions in an APK are required to have a privacy policy set.Winifredwinikka
This plugin is discontinuedThebes
B
7

Use device_info_plus package developed by Flutter community. This is how you can get IDs on both platform.

In your pubspec.yaml file add this:

dependencies:
  device_info_plus: ^3.2.3

Create a method:

Future<String> getUniqueDeviceId() async {
  String uniqueDeviceId = '';

  var deviceInfo = DeviceInfoPlugin();

  if (Platform.isIOS) { // import 'dart:io'
    var iosDeviceInfo = await deviceInfo.iosInfo;
    uniqueDeviceId = '${iosDeviceInfo.name}:${iosDeviceInfo.identifierForVendor}'; // unique ID on iOS
  } else if(Platform.isAndroid) {
    var androidDeviceInfo = await deviceInfo.androidInfo;
    uniqueDeviceId = '${androidDeviceInfo.name}:${androidDeviceInfo.id}' ; // unique ID on Android
  }
  
  return uniqueDeviceId;

}

Usage:

String deviceId = await getUniqueDeviceId();

Output:

M2102J20SG::SKQ1.211006.001

Note:

  1. Do not use androidDeviceInfo.androidId. This would change when your mac address changes. Mobile devices above Android OS 10/11 will generate a randomized MAC. This feature is enabled by default unless disabled manually. This would cause the androidId to change when switiching networks. You can confirm this by yourself by changing androidDeviceInfo.id to androidDeviceInfo.androidId above.

  2. you can probably get away with using only androidDeviceInfo.name as it would not change ever.

  3. androidDeviceInfo.id can also change if OS is updated as it is an android os version.

  4. androidDeviceInfo.androidId should only be used if device uses fix mac address as mentioned in point 1. Otherwise, either use *.name only or androidDeviceInfo.id alongside with *.name.

Berner answered 20/5, 2022 at 7:58 Comment(0)
S
6

I release a new flutter plugin client_information might help. It provide a simple way to get some basic device information from your application user.

  1. add to pubspec.yaml
  dependencies:
    ...
    client_information: ^1.0.1
  1. import to your project
import 'package:client_information/client_information.dart';
  1. then you can get device ID like this
/// Support on iOS, Android and web project
Future<String> getDeviceId() async {
  return (await ClientInformation.fetch()).deviceId;
}

Stencil answered 28/1, 2021 at 1:37 Comment(2)
if I reinstalled APP, will androidId change here?Justle
it is always return nullFibril
M
6

androidID is removed since v4.1.0. Check the changelog.

android_id package is recommanded to get the correct androidId.

Multilateral answered 23/9, 2022 at 10:21 Comment(0)
G
4

Add the following code in your .yaml file.

device_info_plus: ^1.0.0

I used the following approach to get the device info that support in all platforms (i.e.) Android, IOS and Web.

import 'dart:io';  
import 'package:device_info_plus/device_info_plus.dart';  
import 'package:flutter/foundation.dart' show kIsWeb;  

Future<String> getDeviceIdentifier() async { 

    String deviceIdentifier = "unknown";  
    DeviceInfoPlugin deviceInfo = DeviceInfoPlugin();  

    if (kIsWeb) {
      WebBrowserInfo webInfo = await deviceInfo.webBrowserInfo;
      deviceIdentifier = webInfo.vendor +
          webInfo.userAgent +
          webInfo.hardwareConcurrency.toString();
    } else {
      if (Platform.isAndroid) {
        AndroidDeviceInfo androidInfo = await deviceInfo.androidInfo;
        deviceIdentifier = androidInfo.androidId;
      } else if (Platform.isIOS) {
        IosDeviceInfo iosInfo = await deviceInfo.iosInfo;
        deviceIdentifier = iosInfo.identifierForVendor;
      } else if (Platform.isLinux) {
        LinuxDeviceInfo linuxInfo = await deviceInfo.linuxInfo;
        deviceIdentifier = linuxInfo.machineId;
      }
    }
    return deviceIdentifier;
}
Gregg answered 15/4, 2021 at 12:59 Comment(0)
D
3

android_id: ^0.1.3+1 Use this package but it only works on android.

device_info_plus: ^8.0.0 Use this package it works on IOS, Android, Web.

Delrosario answered 6/12, 2022 at 10:42 Comment(1)
for device_info_plus androidId is already removed.Harwill
H
1

It's 2023, UUIDs are still hard apparently.

Use https://pub.dev/packages/app_set_id which uses the Android AppSetID and the iOS IDfV.

Each of android_id, device_info, device_info_plus have major issues, as described in other answers here.

Homogenesis answered 15/12, 2023 at 17:28 Comment(0)
F
0

In You Main.dart File Just these codes You will Get the Player Id of the Your Flutter App//

  final status = await OneSignal.shared.getDeviceState();` final String? osUserID = status?.userId;

print(osUserID);

Furthest answered 17/6, 2023 at 17:33 Comment(0)
B
-2

If you're serving ads you can use ASIdentifierManager. You should only use it for ads. There is no general UDID mechanism provided by the OS on iOS, for privacy reasons.

If you're using firebase_auth plugin you could signInAnonymously and then use the id of the FirebaseUser. This will give you an identifier that is specific to your Firebase app.

Berneicebernelle answered 11/7, 2017 at 15:5 Comment(3)
I am not using firebase , neither I am serving ads. I need a unique identifier to id the device like Settings.Secure.ANDROID_ID in android. I want to know if there a plugin out there for this or shall I have to make a new one for this ?Rhoea
I don't think what you are asking for is possible on iOS. You can easily identify an app install by writing a guid to a file, though.Berneicebernelle
Firebase token has been changed automatically when we uninstall and reinstall mobile app so uniqueness of token does not work. We cannot use it to identify the same user.Homeomorphism

© 2022 - 2024 — McMap. All rights reserved.