MdlAddDevice (service) [v2]

API version: 2

Availability: DIGIPASS Gateway 5.0 and later

Authentication: The service is secured by the back-end and front-end API key.

The MdlAddDevice service registers a new device that supports Secure Channel activation. It retrieves Activation Message 2 (instance).

URL

https://dpgateway_host:dpgateway_port/rest/v2/provisioning/MdlAddDevice

Request

MdlAddDevice parameters
Parameter name Data type Description
registrationIdentifier String Required. The unique identifier of a user for a given activation process.
deviceCode String Required. The device code generated by the mobile application using the Digipass SDK. This is needed for validation and derivation purposes.
description String

Optional. The description of the Digipass instance being activated.

Up to 255 characters. Special characters are replaced with spaces.

Example

{
  "registrationIdentifier": "myRegistrationID",
  "deviceCode": "12345678901234567890123456"
  "description": "myDigipassInstance"
}

Response

MdlAddDevice return values
Return value Description
resultCodes A JSON object that contains the return and status codes of the service.
result

A JSON object that contains the instance activation message (i.e. Activation Message 2).

Example

{
  "resultCodes":
    {
      "returnCodeEnum": "RET_SUCCESS",
      "statusCodeEnum": "STAT_SUCCESS",
      "returnCode": 0,
      "statusCode": 0
    },
  "result":
    {
      "instanceActivationMessage": "AA82DD554C7A39356FC033203A9F7EB6...",
    }
}