Sign In with Device

Our Android SDK offers the easiest way to integrate "Sign in with device" to your android app. You can simply call a function and it does most of the heavy lifting and authentication for you.

Overview
Authenticating users using Trusted Devices with Cotter's Android SDK consists of the following steps:
1.Import and Initialize Cotter
2.Calling functions to register devices a Trusted Device
3.Calling functions to authenticate from Trusted and Non-Trusted Device
What you're building
Trusted Devices on Cotter's Android SDK
Steps
1.​Import Cotter as a dependency​
2.​Set Allowed Methods in the Dashboard to allow Trusted Devices
3.​Create a User: Create a user in Cotter by specifying your user ID.
4.​Initialize Cotter in your MainActivity​
5.​Register current device as a Trusted Device​
6.​Authenticate from a Trusted Device​
Step 1: Import Cotter as a dependency
Add JitPack repository your project level build.gradle at the end of repositories.
1
allprojects {
2
		repositories {
3
			...
4
			maven { url 'https://jitpack.io' }
5
		}
6
	}
Copied!
Add the Cotter's SDK as a dependency in your app level build.gradle .
1
android {
2
  ...
3
  compileOptions {
4
    sourceCompatibility JavaVersion.VERSION_1_8
5
    targetCompatibility JavaVersion.VERSION_1_8
6
  }
7
}
8
​
9
dependencies {
10
  ...
11
  implementation 'com.github.cotterapp:android-sdk:0.3.9'
12
}
Copied!
Check the latest version here https://github.com/cotterapp/android-sdk/releases. Then sync your gradle files.
Step 2: Setting Authentication Methods
You need to set allowed methods for authenticating your users. To allow TRUSTED DEVICES, go to https://dev.cotter.app/rules​
Set Trusted Device as an Allowed Method
Remember to set the correct Project in the dropdown list
Step 3: Creating a User
To use Cotter's sign in with device functionality, you need to first register the user to Cotter.
Registering a User to Cotter
Your server should do this request to Cotter's server during Registration.
Request
Response
1
curl -XPOST \
2
-H 'API_KEY_ID: <your key id>' \
3
-H 'API_SECRET_KEY: <your secret key>' \
4
-H "Content-Type: application/json" \
5
-d '{"client_user_id": "<Your User Identifier (string)>"}' \
6
'https://www.cotter.app/api/v0/user/create'
Copied!
1
{
2
  "ID": "9449e9e9-00e0-4d6b-a4b6-28c5b22b0b0f",
3
  "created_at": "2020-01-21T12:40:21.200727668Z",
4
  "update_at": "2020-01-21T12:40:21.200727668Z",
5
  "deleted_at": null,
6
  "issuer": "<your key ID>",
7
  "client_user_id": "<Your User Identifier (string)>",
8
  "enrolled": [],
9
  "default_method": null
10
}
Copied!
Check out Create a User API Reference for full Description
Step 4: Initialize Cotter
You can now use the SDK to enroll and verify Trusted Devices for the user you just created.
In your MainActivity, initialize Cotter with API keys, Cotter's URL to use (prod/test), and your User ID.
Production Endpoint: https://www.cotter.app/api/v0
1
Cotter.init(
2
    this.getApplicationContext(),
3
    "https://www.cotter.app/api/v0",
4
    "<User ID>", // fill with empty string for Verify EMAIL & PHONE
5
    "<API_KEY_ID>",
6
    "<API_SECRET_KEY>" // fill with empty string for Verify EMAIL & PHONE
7
);
Copied!
Example:
MainActivity.java
1
public class MainActivity extends AppCompatActivity {
2
​
3
    @Override
4
    protected void onCreate(Bundle savedInstanceState) {
5
        ...
6
​
7
        Cotter.init(
8
            this.getApplicationContext(),
9
            "https://www.cotter.app/api/v0",
10
            "[email protected]",
11
            "<API_KEY_ID>",
12
            "<API_SECRET_KEY>");
13
    }
14
    ...
Copied!
​
Step 5: Register this device as a Registered Device
Right after your user finished their registration to your app, you should automatically register the device as a Trusted Device (or prompt your user if they want to make this device as a Trusted Device).
To enroll the current device as a TrustedDevice:
Java
JSON result
1
TrustedDeviceHelper.enrollDevice(this, new Callback() {
2
    @Override
3
    public void onSuccess(JSONObject result) {
4
        Toast.makeText(getApplicationContext(), result.toString(), Toast.LENGTH_SHORT).show();
5
    }
6
​
7
    @Override
8
    public void onError(String error) {
9
        Toast.makeText(getApplicationContext(), error, Toast.LENGTH_SHORT).show();
10
    }
11
});
Copied!
1
{
2
  "ID": "746500ae-a5cd-4692-8fd0-49d57cf7cc57", // User ID from Cotter's system
3
  "created_at": "2020-02-25T04:08:26.174597Z",
4
  "update_at": "2020-02-27T22:20:31.333154814Z",
5
  "deleted_at": null,
6
  "issuer": "afcabd98-745f-4b9e-98de-af968d9951d3", // your API KEY ID
7
  "client_user_id": "1014", // you client's user ID
8
  "enrolled": [ // Enrolled Authentication Methods
9
    "PIN",
10
    "BIOMETRIC",
11
    "TRUSTED_DEVICE" // This should be added to enrolled methods once enrollDevice successful
12
  ],
13
  "default_method": "TRUSTED_DEVICE" // This will automatically be the last enrolled method, which is Trusted Device in this case
14
}
Copied!
This method is only for the first Trusted Device. You will get an error if you attempt to enroll another Trusted Device using enrollDevice when there's already a Trusted Device for the account. To enroll other devices, see Add a new Trusted Device.
Step 6: Authenticate from a Trusted Device
To authenticate a device, call the TrustedDeviceHelper.requestAuth function. This will automatically detect whether the current device is a Trusted Device or not.
Java
JSON result
1
TrustedDeviceHelper.requestAuth(this, "<EVENT NAME>", this, Dashboard.class, new Callback() {
2
    @Override
3
    public void onSuccess(JSONObject result) {
4
        Toast.makeText(getApplicationContext(), result.toString(), Toast.LENGTH_SHORT).show();
5
        
6
        // Pass in the `result` to your backend server when:
7
        // - Logging in your users
8
        // - making a transaction
9
        // - fetching sensitive data
10
    }
11
​
12
    @Override
13
    public void onError(String error) {
14
        Toast.makeText(getApplicationContext(), error, Toast.LENGTH_SHORT).show();
15
    }
16
});
Copied!
1
{
2
  "ID": 1361, // Event ID
3
  "CreatedAt": "2020-02-27T22:22:48.705212512Z",
4
  "UpdatedAt": "2020-02-27T22:22:48.705212512Z",
5
  "DeletedAt": null,
6
  "client_user_id": "1014", // your client's User ID
7
  "issuer": "afcabd98-745f-4b9e-98de-af968d9951d3", // your API Key
8
  "event": "<EVENT NAME>",// requested event (LOGIN, or TRANSACTION, etc)
9
  "ip": "192.168.232.2", 
10
  "location": "Unknown",
11
  "timestamp": "1582842167",
12
  "method": "TRUSTED_DEVICE", // auth method: TRUSTED_DEVICE (other choices are PIN / BIOMETRIC)
13
  "new": false, // Is this a new pending event. More explanation below about Non-Trusted Device
14
  "approved": true, // Is this event approved.
15
  "signature": "oonMGCAxp3..." // Signature to make sure this event comes from Cotter's server
16
}
Copied!
Parameters
1
requestAuth(Context ctx, String event, AppCompatActivity act, Class callbackClass, Callback callback)
Copied!
event: A name to identify the event action type, like "LOGIN" or "TRANSACTION".
callbackClass : The next activity class that you want to redirect to when the authentication request is finished
callback : A custom Callback function that implements 2 methods: onSuccess and onError.
When an Authentication Event is requested using method TRUSTED_DEVICE, there are 2 possible cases:
Case 1: The current device is a Trusted Device
If the current device is a Trusted Device, it should automatically be approved, and you will receive a JSON result containing the requested Event and whether or not it's approved. The approval is based on whether or not the signature included in the request from the SDK is valid.
1
{
2
  ...
3
  "method": "TRUSTED_DEVICE",
4
  "new": false, // Is this a new pending event (should be false).
5
  "approved": true, // Is this event approved (should be true).
6
  
7
  "oauth_token": {
8
    "access_token": "eyJhbGciOiJFUz...", // validate this access token
9
    "id_token": "eyJhbGciOiJFUz...",
10
    "refresh_token": "5:cYIfabtspE1cBeD7KP...",
11
    "expires_in": 3600,
12
    "token_type": "Bearer",
13
    "auth_method": "TRUSTED_DEVICE"
14
  }
15
}
16
​
Copied!
You should see a result that the event is not new, and that it's approved. This is because the signature from the Trusted Device is sufficient to prove that the device is authorized.
When passing this Response to your backend, you need to check if this JSON is valid and if it comes from Cotter's server by validating the access token.
Checkout how to verify the OAuth Tokens from Cotter here:
Verifying JWT Tokens
Case 2: The current device is NOT a Trusted Device
We'll cover this in the next guide:
Authenticate from a Non-Trusted Device
🎉 You're done!
Next Steps
Authenticate from a Non-Trusted Device
Add a new Trusted Device
Customization
Add Biometric / PIN
Biometric/Pin
​

Older SDK Version

Authenticate from a Non-Trusted Device

Last modified 1yr ago

Copy link

Contents

Overview

What you're building

Steps

Step 1: Import Cotter as a dependency

Step 2: Setting Authentication Methods

Step 3: Creating a User

Step 4: Initialize Cotter

Step 5: Register this device as a Registered Device

Step 6: Authenticate from a Trusted Device

🎉 You're done!

Next Steps

Add Biometric / PIN