Initiate Device Registration

Mobile device registration in PL is done through the InitiateRegisterDevice API and CompleteRegisterDevice API.

1. After getting credentials from the end user in Mobile App registration page, invoke the InitiateRegisterDevice API

2. On invoking InitiateRegisterDevice API,

   • the ledger validates the given end user credentials and sends an OTP to end user registered email id

   • the API returns an OTP_TOKEN to Mobile App

3. After getting the OTP from the end user, generate a private and public key pair in Mobile device app

4. Store private key securely in the mobile device and invoke the CompleteRegisterDevice API with OTP, OTP_TOKEN, PublicKey, DeviceInfo details

note

OTP, OTP_TOKEN, PublicKey will be used to complete the Mobile device registration in CompleteRegisterDevice API.

Method: POST

{{URL}}/jsonrpc

Headers

Name	Value
Content-Type	application/json

Example

Payload Parameters

Parameter	Description
method Mandatory	String API method that is being called to initiate device registration through key service Constant value: "KeyService.InitiateRegisterDevice"
id Mandatory	String Unique ID of API request Sample value: "1"
params Mandatory	Object
api Mandatory	Object
signature Mandatory	String Signature for request validation Sample value: "signature"
keyId Mandatory	String API key used for request authentication Sample value: "ApplicationKeyId"
credential Mandatory	String API credential provided by NetXD Sample value: "Credential"
payload Mandatory	Object

cURL

curl --location --globoff '{{URL}}/jsonrpc' \
--header 'Content-Type: application/json' \
--data '{"method":"KeyService.InitiateRegisterDevice","id":"1","params":{"api":{"signature":"{{signature}}","keyId":"{{ApplicationKeyId}}","credential":"{{Credential}}"},"payload":{}}}'

C#

var options = new RestClientOptions("{{URL}}/jsonrpc")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/json");
var body = @"{
" + "\n" +
@"  ""method"": ""KeyService.InitiateRegisterDevice"",
" + "\n" +
@"  ""id"": ""1"",
" + "\n" +
@"  ""params"": {
" + "\n" +
@"    ""api"": {
" + "\n" +
@"      ""signature"": ""{{signature}}"",
" + "\n" +
@"      ""keyId"": ""{{ApplicationKeyId}}"",
" + "\n" +
@"      ""credential"": ""{{Credential}}""
" + "\n" +
@"    },
" + "\n" +
@"    ""payload"": {}
" + "\n" +
@"  }
" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

Go

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "{{URL}}/jsonrpc"
  method := "POST"

  payload := strings.NewReader(`{`+"
"+`
  "method": "KeyService.InitiateRegisterDevice",`+"
"+`
  "id": "1",`+"
"+`
  "params": {`+"
"+`
    "api": {`+"
"+`
      "signature": "{{signature}}",`+"
"+`
      "keyId": "{{ApplicationKeyId}}",`+"
"+`
      "credential": "{{Credential}}"`+"
"+`
    },`+"
"+`
    "payload": {}`+"
"+`
  }`+"
"+`
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

NodeJs

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
  'method': 'POST',
  'hostname': '{{URL}}',
  'path': '/jsonrpc',
  'headers': {
    'Content-Type': 'application/json'
  },
  'maxRedirects': 20
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function (chunk) {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });

  res.on("error", function (error) {
    console.error(error);
  });
});

var postData = JSON.stringify({
  "method": "KeyService.InitiateRegisterDevice",
  "id": "1",
  "params": {
    "api": {
      "signature": "{{signature}}",
      "keyId": "{{ApplicationKeyId}}",
      "credential": "{{Credential}}"
    },
    "payload": {}
  }
});

req.write(postData);

req.end();

Body

{
  "method": "KeyService.InitiateRegisterDevice",
  "id": "1",
  "params": {
    "api": {
      "signature": "{{signature}}",
      "keyId": "{{ApplicationKeyId}}",
      "credential": "{{Credential}}"
    },
    "payload": {}
  }
}

Response: 200

Response Parameters

Parameter	Description
id	String Response ID echoed from the request ID Sample value: "1"
result	Object
Status	Enum Status of the initiation of device registration Possible Values: Sample value: SUCCESS
OtpToken	String Token generated during OTP generation process Sample value: c1a8247b6afe4ee081e66935ef8c6660

{
  "id": "1",
  "result": {
    "Status": "SUCCESS",
    "OtpToken": "c1a8247b6afe4ee081e66935ef8c6660"
  }
}