IAPI 1.3 - monetplus/IDport GitHub Wiki

idport-case-iapi-docker

Overview

Version information

Swagger YAML Version : 1.3.0-M32

Contact information

Contact : Monet+

URI scheme

Host : ${BASE_URL}
BasePath : /

Tags

  • case-iapi-rest-controller : IAPI Rest Controller for CASE

Paths

accessCase

accessCase

GET /v1/accessCase

Parameters

Type Name Schema
Header X-APP-SESSION-ID
optional 		string
Header X-CHANNEL-ID
optional 		string
Header X-FORWARDED-FOR
optional 		string
Header X-SSO-SESSION-ID
optional 		string
Header X-TRN-ID
optional 		string

Responses

HTTP Code Description Schema
200 OK AccessCaseResponse

Produces

  • application/json

Tags

  • case-iapi-rest-controller

Example HTTP request

Request path
/v1/accessCase
Request header
"13485792783"

Example HTTP response

Response 200
{
  "status": "success",
  "data": {
    "tenant": "idport",
    "list": [
      {
        "id": "blockingRules",
        "type": "readwrite"
      },
      {
        "id": "blockMethod",
        "type": "onbehalfof"
      },
      {
        "id": "blockInstance",
        "type": "onbehalfof"
      },
      {
        "id": "deactivateMethod",
        "type": "onbehalfof"
      },
      {
        "id": "deactivateInstance",
        "type": "onbehalfof"
      },
      {
        "id": "initiateInstance",
        "type": "onbehalfof"
      },
      {
        "id": "setInstanceProperty",
        "type": "onbehalfof"
      },
      {
        "id": "getActivationCode",
        "type": "onbehalfof"
      },
      {
        "id": "activateInstance",
        "type": "onbehalfof"
      },
      {
        "id": "activateMethod",
        "type": "onbehalfof"
      },
      {
        "id": "unblockInstance",
        "type": "onbehalfof"
      },
      {
        "id": "unblockMethod",
        "type": "onbehalfof"
      },
      {
        "id": "getMethodInfo",
        "type": "onbehalfof"
      }
    ]
  }
}

activateInstance

activateInstance

POST /v1/activateInstance

Parameters

Type Name Description Schema
Header X-APP-SESSION-ID
optional 		string
Header X-CHANNEL-ID
optional 		string
Header X-FORWARDED-FOR
optional 		string
Header X-SSO-SESSION-ID
optional 		string
Header X-TRN-ID
optional 		string
Body req
required 		req ActivateInstanceRequest

Responses

HTTP Code Description Schema
200 OK ActivateInstanceResponse

Consumes

  • application/json

Produces

  • application/json

Tags

  • case-iapi-rest-controller

Example HTTP request

Request path
/v1/activateInstance
Request header
"13485792783"
Request body
{
  "instanceId": "9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3",
  "methodType": "PASSWORD",
  "muid": "64728948",
  "tenant": "Monet+"
}

Example HTTP response

Response 200
{
  "data": {
    "instanceInfo": {
      "@type": "cz.monetplus.idport.component.model.InstanceInfo",
      "instanceId": "9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3",
      "state": "ACTIVE",
      "instanceName": "LGE LG-H440n"
    }
  },
  "status": "success"
}

activateMethod

activateMethod

POST /v1/activateMethod

Parameters

Type Name Description Schema
Header X-APP-SESSION-ID
optional 		string
Header X-CHANNEL-ID
optional 		string
Header X-FORWARDED-FOR
optional 		string
Header X-SSO-SESSION-ID
optional 		string
Header X-TRN-ID
optional 		string
Body req
required 		req ActivateMethodRequest

Responses

HTTP Code Description Schema
200 OK ActivateMethodResponse

Consumes

  • application/json

Produces

  • application/json

Tags

  • case-iapi-rest-controller

Example HTTP request

Request path
/v1/activateMethod
Request header
"13485792783"
Request body
{
  "methodSpecific" : {
    "algType" : 2
  },
  "methodType" : "PASSWORD",
  "muid" : "64728948",
  "tenant" : "Monet+"
}

Example HTTP response

Response 200
{
  "data": {
    "methodSpecific": {
      "@class": "cz.monetplus.idport.component.model.ActivationProperties$PwdMethodActivationProperties",
      "algType": 2,
      "salt": "ZyzptbmtG7VnA9621BbhcsWMAVFp6BKkHwK0FqxmB3U="
    }
  },
  "status": "success"
}

getActivationCode

getActivationCode

POST /v1/activationCode

Parameters

Type Name Description Schema
Header X-APP-SESSION-ID
optional 		string
Header X-CHANNEL-ID
optional 		string
Header X-FORWARDED-FOR
optional 		string
Header X-SSO-SESSION-ID
optional 		string
Header X-TRN-ID
optional 		string
Body req
required 		req GetActivationCodeRequest

Responses

HTTP Code Description Schema
200 OK GetActivationCodeResponse

Consumes

  • application/json

Produces

  • application/json

Tags

  • case-iapi-rest-controller

Example HTTP request

Request path
/v1/activationCode
Request header
"13485792783"
Request body
{
  "muid" : "64728948",
  "tenant" : "Monet+"
}

Example HTTP response

Response 200
{
  "data" : {
    "code" : "240537",
    "qrData" : "UVI1fDF8QTAzNDk0QkV8Y2cydDFAbW9uZXRwbHVzLmN6fDIzNzQyMQ==",
    "userId" : "[email protected]"
  },
  "status" : "success"
}

blockInstance

blockInstance

POST /v1/blockInstance

Parameters

Type Name Description Schema
Header X-APP-SESSION-ID
optional 		string
Header X-CHANNEL-ID
optional 		string
Header X-FORWARDED-FOR
optional 		string
Header X-SSO-SESSION-ID
optional 		string
Header X-TRN-ID
optional 		string
Body req
required 		req BlockInstanceRequest

Responses

HTTP Code Description Schema
200 OK BlockInstanceResponse

Consumes

  • application/json

Produces

  • application/json

Tags

  • case-iapi-rest-controller

Example HTTP request

Request path
/v1/blockInstance
Request header
"13485792783"
Request body
{
  "instanceId" : "9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3",
  "methodType" : "PASSWORD",
  "muid" : "64728948",
  "tenant" : "Monet+"
}

Example HTTP response

Response 200
{
  "status" : "success"
}

blockMethod

blockMethod

POST /v1/blockMethod

Parameters

Type Name Description Schema
Header X-APP-SESSION-ID
optional 		string
Header X-CHANNEL-ID
optional 		string
Header X-FORWARDED-FOR
optional 		string
Header X-SSO-SESSION-ID
optional 		string
Header X-TRN-ID
optional 		string
Body req
required 		req BlockMethodRequest

Responses

HTTP Code Description Schema
200 OK BlockMethodResponse

Consumes

  • application/json

Produces

  • application/json

Tags

  • case-iapi-rest-controller

Example HTTP request

Request path
/v1/blockMethod
Request header
"13485792783"
Request body
{
  "methodType" : "PASSWORD",
  "muid" : "64728948",
  "tenant" : "Monet+"
}

Example HTTP response

Response 200
{
  "status" : "success"
}

cancelTransaction

cancelTransaction

POST /v1/cancelTransaction

Parameters

Type Name Description Schema
Header X-APP-SESSION-ID
optional 		string
Header X-CHANNEL-ID
optional 		string
Header X-FORWARDED-FOR
optional 		string
Header X-SSO-SESSION-ID
optional 		string
Header X-TRN-ID
optional 		string
Body req
required 		req CancelTransactionRequest

Responses

HTTP Code Description Schema
200 OK CancelTransactionResponse

Consumes

  • application/json

Produces

  • application/json

Tags

  • case-iapi-rest-controller

Example HTTP request

Request path
/v1/cancelTransaction
Request header
"13485792783"
Request body
{
  "caseId" : "41QHE14SDOdId+d+g9isQVRgpkPKRRAoYWcaLVt//BdW4VjjSf0QfEmMMPzRGo6wl1TCcx5GUtGFr8sfh315Tuj4AT/ea4sSyv9z7Tgklo2RhV9zMhDOh7bBI5vp+uPf",
  "muid" : "64728948",
  "reason" : "SWAGGER test",
  "tenant" : "Monet+"
}

Example HTTP response

Response 200
{
  "status" : "success"
}

deactivateInstance

deactivateInstance

POST /v1/deactivateInstance

Parameters

Type Name Description Schema
Header X-APP-SESSION-ID
optional 		string
Header X-CHANNEL-ID
optional 		string
Header X-FORWARDED-FOR
optional 		string
Header X-SSO-SESSION-ID
optional 		string
Header X-TRN-ID
optional 		string
Body req
required 		req DeactivateInstanceRequest

Responses

HTTP Code Description Schema
200 OK DeactivateInstanceResponse

Consumes

  • application/json

Produces

  • application/json

Tags

  • case-iapi-rest-controller

Example HTTP request

Request path
/v1/deactivateInstance
Request header
"13485792783"
Request body
{
  "instanceId" : "9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3",
  "methodType" : "PASSWORD",
  "muid" : "64728948",
  "tenant" : "Monet+"
}

Example HTTP response

Response 200
{
  "status" : "success"
}

deactivateMethod

deactivateMethod

POST /v1/deactivateMethod

Parameters

Type Name Description Schema
Header X-APP-SESSION-ID
optional 		string
Header X-CHANNEL-ID
optional 		string
Header X-FORWARDED-FOR
optional 		string
Header X-SSO-SESSION-ID
optional 		string
Header X-TRN-ID
optional 		string
Body req
required 		req DeactivateMethodRequest

Responses

HTTP Code Description Schema
200 OK DeactivateMethodResponse

Consumes

  • application/json

Produces

  • application/json

Tags

  • case-iapi-rest-controller

Example HTTP request

Request path
/v1/deactivateMethod
Request header
"13485792783"
Request body
{
  "methodType" : "PASSWORD",
  "muid" : "64728948",
  "tenant" : "Monet+"
}

Example HTTP response

Response 200
{
  "status" : "success"
}

initiateInstance

initiateInstance

POST /v1/initiateInstance

Parameters

Type Name Description Schema
Header X-APP-SESSION-ID
optional 		string
Header X-CHANNEL-ID
optional 		string
Header X-FORWARDED-FOR
optional 		string
Header X-SSO-SESSION-ID
optional 		string
Header X-TRN-ID
optional 		string
Body req
required 		req InitiateInstanceRequest

Responses

HTTP Code Description Schema
200 OK InitiateInstanceResponse

Consumes

  • application/json

Produces

  • application/json

Tags

  • case-iapi-rest-controller

Example HTTP request

Request path
/v1/initiateInstance
Request header
"13485792783"
Request body
{
  "methodSpecific": {
    "value": "RDzNDcHmmvrE/qWKYQx0v494ZllOKwMaex+YNr1dpgs="
  },
  "methodType" : "PASSWORD",
  "muid" : "64728948",
  "name" : "Swagger instance test name",
  "tenant" : "Monet+",
  "validTo" : "2018-07-13T09:28:01Z"
}

Example HTTP response

Response 200
{
  "data": {
    "instanceInfo": {
      "@type": "cz.monetplus.idport.component.model.InstanceInfo",
      "instanceId": "9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3",
      "state": "ACTIVE",
      "instanceName": "LGE LG-H440n"
    }
  },
  "status": "success"
}

initiateTransaction

initiateTransaction

POST /v1/initiateTransaction

Parameters

Type Name Description Schema
Header X-APP-SESSION-ID
optional 		string
Header X-CHANNEL-ID
optional 		string
Header X-FORWARDED-FOR
optional 		string
Header X-SSO-SESSION-ID
optional 		string
Header X-TRN-ID
optional 		string
Body req
required 		req InitiateTransactionRequest

Responses

HTTP Code Description Schema
200 OK InitiateTransactionResponse

Consumes

  • application/json

Produces

  • application/json

Tags

  • case-iapi-rest-controller

Example HTTP request

Request path
/v1/initiateTransaction
Request header
"13485792783"
Request body
{
  "methodType" : "PASSWORD",
  "muid" : "cg2t1",
  "notificationDestination" : "IAM",
  "operationType" : "AUTHENTICATION",
  "processingOptions" : {
    "authorizationFlow" : "ONLINE_OFFLINE",
    "offlineChallenge" : "QR"
  },
  "tenant" : "Monet+",
  "transactionData" : {
    "data" : "U1RYMCVUUk5fSUQlJVRSTl9USU1FJVMwJENBU0VNb2JpbGUgdGVjaG5pY2FsIHRyYW5zYWN0aW9uJCo=",
    "locale" : "cs",
    "template" : "AUTHENTICATION"
  },
  "type" : "PIN",
  "validity" : "2018-07-17T12:44:10.173Z"
}

Example HTTP response

Response 200
{
  "data": {
    "caseId": "41QHE14SDOdId+d+g9isQVRgpkPKRRAoYWcaLVt//BdW4VjjSf0QfEmMMPzRGo6wl1TCcx5GUtGFr8sfh315Tuj4AT/ea4sSyv9z7Tgklo2RhV9zMhDOh7bBI5vp+uPf",
    "encryptionHeader": {
      "alg": "ECDH-ES",
      "enc": "A256GCM",
      "epk": {
        "crv": "P-521",
        "kid": "e482445b-9276-4dcd-b602-d55fa3c03d05",
        "kty": "EC",
        "x": "AImgIrUIo4jouXSYc6KDkGFrbCoVYN0bB9m7UmSW_32rIeQvbyKd2tke2YagMePvNm50lQyb4JHWBQXPgXq6Cgzx",
        "y": "ALl3_-nmRaQIB8yNy09wP6WsbYJWsHRuJVOY40kXADjNDWzendO1E_gOR1gNr0J5W5aVMIbbWglRxt4XMl1t_PIT"
      }
    },
    "expiration": {
      "seconds": 600,
      "timestamp": "2018-07-17T12:44:10.173Z"
    },
    "methodSpecific": {
      "salt": "ZyzptbmtG7VnA9621BbhcsWMAVFp6BKkHwK0FqxmB3U=",
      "cipherPublicKey": "MIHfMA0GCSqGSIb3DQEBAQUAA4HNADCByQKBwQCbA+nA4Oyfe4OiFeYGRK8O02+q3ObJ3IZPhYw7SJ5ULhygpZNhIcL5X0c1c2/yHuVoD7PKmoguQUu5Jj5uRC2ovvC8+X+xPRfohrhw8IXQ/DJC8AqRifCCUWshL8qzA4NNzIDIcMG+gLstSHdcMt6+opQb7AemGPfKiWVYw8wsTI9omkfT5QeMWTGJjBD38DFTLzEua/E56lm4MKDM4rk2PxD0Va0h2aZG7T0F6RwqhM7YYLhbc9LVwr840U9/EfUCAwEAAQ==",
      "algType": 2,
      "nonce": "l9ned9tLn4hpytmcXjLS2hiYcs85iPDwM6Kx5QRxiPoNilzlAi8BoDxt7YJ/nQ1o"
    }
  },
  "status": "success"
}

getMethodInfo

getMethodInfo

POST /v1/methodInfo

Parameters

Type Name Description Schema
Header X-APP-SESSION-ID
optional 		string
Header X-CHANNEL-ID
optional 		string
Header X-FORWARDED-FOR
optional 		string
Header X-SSO-SESSION-ID
optional 		string
Header X-TRN-ID
optional 		string
Body req
required 		req GetMethodInfoRequest

Responses

HTTP Code Description Schema
200 OK GetMethodInfoResponse

Consumes

  • application/json

Produces

  • application/json

Tags

  • case-iapi-rest-controller

Example HTTP request

Request path
/v1/methodInfo
Request header
"13485792783"
Request body
{
  "methodTypes" : [ "PASSWORD" ],
  "muid" : "cg2t1",
  "tenant" : "Monet+"
}

Example HTTP response

Response 200
{
  "data" : {
    "methodInfo" : [ {
      "methodType" : "PASSWORD",
      "state" : "ACTIVE",
      "activeInstances" : 1,
      "instances" : [ {
        "@type":  "cz.monetplus.idport.component.model.InstanceInfo",
        "instanceId" : "9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3",
        "state" : "ACTIVE",
        "instanceName" : "LGE LG-H440n"
      }, {
        "instanceId" : "9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3_2",
        "state" : "INITIATED",
        "instanceName" : "LGE LG-H440n_2"
      } ],
      "failedAttempts" : 0,
      "remainingAttempts" : 3
    } ]
  },
  "status" : "success"
}

getMethodParams

getMethodParams

POST /v1/methodParams

Parameters

Type Name Description Schema
Header X-APP-SESSION-ID
optional 		string
Header X-CHANNEL-ID
optional 		string
Header X-FORWARDED-FOR
optional 		string
Header X-SSO-SESSION-ID
optional 		string
Header X-TRN-ID
optional 		string
Body req
required 		req GetMethodParamsRequest

Responses

HTTP Code Description Schema
200 OK GetMethodParamsResponse

Consumes

  • application/json

Produces

  • application/json

Tags

  • case-iapi-rest-controller

Example HTTP request

Request path
/v1/methodParams
Request header
"13485792783"
Request body
{
  "methodType" : "PASSWORD",
  "muid" : "cg2t1",
  "tenant" : "Monet+"
}

Example HTTP response

Response 200
{
  "data" : {
    "methodSpecific" : {                  // this example is PASSWORD method specific
      "algType" : 2,
      "salt" : "ZyzptbmtG7VnA9621BbhcsWMAVFp6BKkHwK0FqxmB3U="
      "complexity": {                     // optional, based on method configuration
        "minLength": 5,
        "maxLength": 8,
        "requiresDigits": true,
        "requiresUppercaseLetters": true,
        "requiresLowercaseLetters": true,
        "requiresOtherCharacters": true
      }
    }
  },
  "status" : "success"
}

ping

ping

GET /v1/ping

Parameters

Type Name Schema
Header X-APP-SESSION-ID
optional 		string
Header X-CHANNEL-ID
optional 		string
Header X-FORWARDED-FOR
optional 		string
Header X-SSO-SESSION-ID
optional 		string
Header X-TRN-ID
optional 		string

Responses

HTTP Code Description Schema
200 OK IdportCaseResponse

Produces

  • application/json

Tags

  • case-iapi-rest-controller

Example HTTP request

Request path
/v1/ping
Request header
"13485792783"

Example HTTP response

Response 200
{
  "status": "success",
  "data": {
    "details": [
      {
        "resource": "APP",
        "code": 0,
        "detail": {
          "version": "1.3.0",
          "module": "IDPORT - CASE IAPI Docker Module"
        }
      },
      {
        "resource": "DB",
        "code": 0
      },
      {
        "resource": "CASECore",
        "code": 0
      }
    ]
  }
}

setInstanceProperty

setInstanceProperty

POST /v1/setInstanceProperty

Parameters

Type Name Description Schema
Header X-APP-SESSION-ID
optional 		string
Header X-CHANNEL-ID
optional 		string
Header X-FORWARDED-FOR
optional 		string
Header X-SSO-SESSION-ID
optional 		string
Header X-TRN-ID
optional 		string
Body req
required 		req SetInstancePropertyRequest

Responses

HTTP Code Description Schema
200 OK SetInstancePropertyResponse

Consumes

  • application/json

Produces

  • application/json

Tags

  • case-iapi-rest-controller

Example HTTP request

Request path
/v1/setInstanceProperty
Request header
"13485792783"
Request body
{
  "instanceId" : "9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3",
  "methodType" : "PASSWORD",
  "muid" : "cg2t1",
  "name" : "Swagger instance test name",
  "tenant" : "Monet+",
  "validTo" : "2018-07-13T09:28:01Z"
}

Example HTTP response

Response 200
{
  "status" : "success"
}

getTransactionState

getTransactionState

POST /v1/transactionState

Parameters

Type Name Description Schema
Header X-APP-SESSION-ID
optional 		string
Header X-CHANNEL-ID
optional 		string
Header X-FORWARDED-FOR
optional 		string
Header X-SSO-SESSION-ID
optional 		string
Header X-TRN-ID
optional 		string
Body req
required 		req GetTransactionStateRequest

Responses

HTTP Code Description Schema
200 OK GetTransactionStateResponse

Consumes

  • application/json

Produces

  • application/json

Tags

  • case-iapi-rest-controller

Example HTTP request

Request path
/v1/transactionState
Request header
"13485792783"
Request body
{
  "caseId" : "41QHE14SDOdId+d+g9isQVRgpkPKRRAoYWcaLVt//BdW4VjjSf0QfEmMMPzRGo6wl1TCcx5GUtGFr8sfh315Tuj4AT/ea4sSyv9z7Tgklo2RhV9zMhDOh7bBI5vp+uPf",
  "muid" : "cg2t1",
  "tenant" : "Monet+"
}

Example HTTP response

Response 200
{
  "data" : {
    "state" : "INITIATED"
  },
  "status" : "success"
}

unblockInstance

unblockInstance

POST /v1/unblockInstance

Parameters

Type Name Description Schema
Header X-APP-SESSION-ID
optional 		string
Header X-CHANNEL-ID
optional 		string
Header X-FORWARDED-FOR
optional 		string
Header X-SSO-SESSION-ID
optional 		string
Header X-TRN-ID
optional 		string
Body req
required 		req UnblockInstanceRequest

Responses

HTTP Code Description Schema
200 OK UnblockInstanceResponse

Consumes

  • application/json

Produces

  • application/json

Tags

  • case-iapi-rest-controller

Example HTTP request

Request path
/v1/unblockInstance
Request header
"13485792783"
Request body
{
  "instanceId" : "9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3",
  "methodType" : "PASSWORD",
  "muid" : "cg2t1",
  "tenant" : "Monet+"
}

Example HTTP response

Response 200
{
  "status" : "success"
}

unblockMethod

unblockMethod

POST /v1/unblockMethod

Parameters

Type Name Description Schema
Header X-APP-SESSION-ID
optional 		string
Header X-CHANNEL-ID
optional 		string
Header X-FORWARDED-FOR
optional 		string
Header X-SSO-SESSION-ID
optional 		string
Header X-TRN-ID
optional 		string
Body req
required 		req UnblockMethodRequest

Responses

HTTP Code Description Schema
200 OK UnblockMethodResponse

Consumes

  • application/json

Produces

  • application/json

Tags

  • case-iapi-rest-controller

Example HTTP request

Request path
/v1/unblockMethod
Request header
"13485792783"
Request body
{
  "methodType" : "PASSWORD",
  "muid" : "cg2t1",
  "tenant" : "Monet+"
}

Example HTTP response

Response 200
{
  "status" : "success"
}

verifyTransaction

verifyTransaction

POST /v1/verifyTransaction

Parameters

Type Name Description Schema
Header X-APP-SESSION-ID
optional 		string
Header X-CHANNEL-ID
optional 		string
Header X-FORWARDED-FOR
optional 		string
Header X-SSO-SESSION-ID
optional 		string
Header X-TRN-ID
optional 		string
Body req
required 		req VerifyTransactionRequest

Responses

HTTP Code Description Schema
200 OK VerifyTransactionResponse

Consumes

  • application/json

Produces

  • application/json

Tags

  • case-iapi-rest-controller

Example HTTP request

Request path
/v1/verifyTransaction
Request header
"13485792783"
Request body
{
  "caseId" : "41QHE14SDOdId+d+g9isQVRgpkPKRRAoYWcaLVt//BdW4VjjSf0QfEmMMPzRGo6wl1TCcx5GUtGFr8sfh315Tuj4AT/ea4sSyv9z7Tgklo2RhV9zMhDOh7bBI5vp+uPf",
  "chap" : {
    "authProtocol" : 1,
    "challenge" : "MzM5MjA1",
    "response" : "MzM5MjA1",
    "username" : "cg2t1"
  },
  "code" : "kuxejDzuNbSh1z6VGzYqo7Bv90IpfRavzGfxBYN9yl6D549zaSawq6+Cb0RDQLUz+vpFCgPBMHs73AQO1TpkVCACO/XiDfAf6P2ad61pPlXN02+L6fARtxXcOqowuM5AdPQioV4Byo1/guSjsT/BGNL0MpIjw5NgMtpB5NNw24+2PYx+8lzZM25NPTNaylTJNXBiCL3kBV/p68hc2p4EDzSSRjgA0uTH1oNMIqyNXXPOFGCKU9RSylrBnwLpCUkq",
  "methodType" : "PASSWORD",
  "muid" : "cg2t1",
  "tenant" : "Monet+"
}

Example HTTP response

Response 200
{
  "data": {
    "instanceInfo": {
      "@type": "cz.monetplus.idport.component.model.InstanceInfo",
      "instanceId": "9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3",
      "state": "ACTIVE",
      "instanceName": "LGE LG-H440n",
      "lastAccess": "2021-06-07T09:13:47.123758Z"
    }
  },
  "status": "success"
}

Definitions

AccessCaseResponse

Name Description Schema
code
optional 		Example : 0 integer (int32)
data
optional 		Example : "[accesscaseresponse-data](#accesscaseresponse-data)" AccessCaseResponse.Data
message
optional 		Example : "string" string
status
optional 		Example : "string" enum (success, fail, error)

AccessCaseResponse.Data

Name Description Schema
list
optional 		Example : [ "[componentaccess](#componentaccess)" ] < ComponentAccess > array
tenant
required 		Example : "Monet+" string

ActivateInstanceRequest

Name Description Schema
instanceId
required 		Example : "9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3" string
methodType
required 		Example : "PASSWORD" enum (PASSWORD, ACTIVATION_CODE, SMS, CM, SPNEGO, TLS_CLIENT)
muid
required 		Example : "cg2t1" string
tenant
optional 		Example : "Monet+" string

ActivateInstanceResponse

Name Description Schema
code
optional 		Example : 0 integer (int32)
data
optional 		Example : "[activateinstanceresponse-data](#activateinstanceresponse-data)" ActivateInstanceResponse.Data
message
optional 		Example : "string" string
status
optional 		Example : "string" enum (success, fail, error)

ActivateInstanceResponse.Data

Name Description Schema
instanceInfo
optional 		Example : "[instanceinfo](#instanceinfo)" InstanceInfo

ActivateMethodRequest

Name Description Schema
methodSpecific
optional 		Example : {<br> "algType" : 2<br>} object
methodType
required 		Example : "PASSWORD" enum (PASSWORD, ACTIVATION_CODE, SMS, CM, SPNEGO, TLS_CLIENT)
muid
required 		Example : "cg2t1" string
tenant
optional 		Example : "Monet+" string

ActivateMethodResponse

Name Description Schema
code
optional 		Example : 0 integer (int32)
data
optional 		Example : "[activatemethodresponse-data](#activatemethodresponse-data)" ActivateMethodResponse.Data
message
optional 		Example : "string" string
status
optional 		Example : "string" enum (success, fail, error)

ActivateMethodResponse.Data

Name Description Schema
instanceInfo
optional 		Example : "[instanceinfo](#instanceinfo)" InstanceInfo
methodSpecific
optional 		Example : "[activationproperties](#activationproperties)" ActivationProperties

ActivationProperties

Name Description Schema
id
optional 		Example : "string" string

BlockInstanceRequest

Name Description Schema
instanceId
required 		Example : "9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3" string
methodType
required 		Example : "PASSWORD" enum (PASSWORD, ACTIVATION_CODE, SMS, CM, SPNEGO, TLS_CLIENT)
muid
required 		Example : "cg2t1" string
tenant
optional 		Example : "Monet+" string

BlockInstanceResponse

Name Description Schema
code
optional 		Example : 0 integer (int32)
message
optional 		Example : "string" string
status
optional 		Example : "string" enum (success, fail, error)

BlockMethodRequest

Name Description Schema
methodType
required 		Example : "PASSWORD" enum (PASSWORD, ACTIVATION_CODE, SMS, CM, SPNEGO, TLS_CLIENT)
muid
required 		Example : "cg2t1" string
tenant
optional 		Example : "Monet+" string

BlockMethodResponse

Name Description Schema
code
optional 		Example : 0 integer (int32)
message
optional 		Example : "string" string
status
optional 		Example : "string" enum (success, fail, error)

CancelTransactionRequest

Name Description Schema
caseId
required 		Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"
Example : "41QHE14SDOdId+d+g9isQVRgpkPKRRAoYWcaLVt//BdW4VjjSf0QfEmMMPzRGo6wl1TCcx5GUtGFr8sfh315Tuj4AT/ea4sSyv9z7Tgklo2RhV9zMhDOh7bBI5vp+uPf" 		string (byte)
muid
optional 		it is empty for the case of an anonymous transaction
Example : "cg2t1" 		string
reason
optional 		Example : "SWAGGER test" string
tenant
optional 		Example : "Monet+" string

CancelTransactionResponse

Name Description Schema
code
optional 		Example : 0 integer (int32)
message
optional 		Example : "string" string
status
optional 		Example : "string" enum (success, fail, error)

Chap

Name Description Schema
authProtocol
required 		Example : 1 integer (int64)
challenge
required 		Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"
Example : "MzM5MjA1" 		string (byte)
response
required 		Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"
Example : "MzM5MjA1" 		string (byte)
username
required 		Example : "cg2t1" string

Character

Type : object

ComponentAccess

Name Description Schema
id
required 		Example : "string" string
type
required 		Example : "string" string

DeactivateInstanceRequest

Name Description Schema
instanceId
required 		Example : "9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3" string
methodType
required 		Example : "PASSWORD" enum (PASSWORD, ACTIVATION_CODE, SMS, CM, SPNEGO, TLS_CLIENT)
muid
required 		Example : "cg2t1" string
tenant
optional 		Example : "Monet+" string

DeactivateInstanceResponse

Name Description Schema
code
optional 		Example : 0 integer (int32)
message
optional 		Example : "string" string
status
optional 		Example : "string" enum (success, fail, error)

DeactivateMethodRequest

Name Description Schema
methodType
required 		Example : "PASSWORD" enum (PASSWORD, ACTIVATION_CODE, SMS, CM, SPNEGO, TLS_CLIENT)
muid
required 		Example : "cg2t1" string
tenant
optional 		Example : "Monet+" string

DeactivateMethodResponse

Name Description Schema
code
optional 		Example : 0 integer (int32)
message
optional 		Example : "string" string
status
optional 		Example : "string" enum (success, fail, error)

GetActivationCodeRequest

Name Description Schema
muid
required 		Example : "cg2t1" string
tenant
optional 		Example : "Monet+" string

GetActivationCodeResponse

Name Description Schema
code
optional 		Example : 0 integer (int32)
data
optional 		Example : "[getactivationcoderesponse-data](#getactivationcoderesponse-data)" GetActivationCodeResponse.Data
message
optional 		Example : "string" string
status
optional 		Example : "string" enum (success, fail, error)

GetActivationCodeResponse.Data

Name Description Schema
code
optional 		Example : "240537" string
qrData
optional 		Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"
Example : "UVI1fDF8QTAzNDk0QkV8Y2cydDFAbW9uZXRwbHVzLmN6fDIzNzQyMQ==" 		string (byte)
userId
optional 		Example : "[email protected]" string

GetMethodInfoRequest

Name Description Schema
methodTypes
required 		Example : [ "PASSWORD" ] < enum (PASSWORD, ACTIVATION_CODE, SMS, CM, SPNEGO, TLS_CLIENT) > array
muid
required 		Example : "cg2t1" string
tenant
optional 		Example : "Monet+" string

GetMethodInfoResponse

Name Description Schema
code
optional 		Example : 0 integer (int32)
data
optional 		Example : "[getmethodinforesponse-data](#getmethodinforesponse-data)" GetMethodInfoResponse.Data
message
optional 		Example : "string" string
status
optional 		Example : "string" enum (success, fail, error)

GetMethodInfoResponse.Data

Name Description Schema
methodInfo
optional 		Example : [ {<br> "methodType" : "PASSWORD",<br> "state" : "ACTIVE",<br> "activeInstances" : 1,<br> "instances" : [ {<br> "instanceId" : "9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3",<br> "state" : "ACTIVE",<br> "instanceName" : "Swagger instance test name"<br> }, {<br> "instanceId" : "9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3_2",<br> "state" : "INITIATED",<br> "instanceName" : "Swagger instance test name_2"<br> } ],<br> "failedAttempts" : 0,<br> "remainingAttempts" : 3<br>} ] < MethodInfo > array

GetMethodParamsRequest

Name Description Schema
methodType
required 		Example : "PASSWORD" enum (PASSWORD, ACTIVATION_CODE, SMS, CM, SPNEGO, TLS_CLIENT)
muid
required 		Example : "cg2t1" string
tenant
optional 		Example : "Monet+" string

GetMethodParamsResponse

Name Description Schema
code
optional 		Example : 0 integer (int32)
data
optional 		Example : "[getmethodparamsresponse-data](#getmethodparamsresponse-data)" GetMethodParamsResponse.Data
message
optional 		Example : "string" string
status
optional 		Example : "string" enum (success, fail, error)

GetMethodParamsResponse.Data

Name Description Schema
methodSpecific
optional 		Example : {<br> "algType" : 2,<br> "salt" : "ZyzptbmtG7VnA9621BbhcsWMAVFp6BKkHwK0FqxmB3U="<br>} object

GetTransactionStateRequest

Name Description Schema
caseId
required 		Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"
Example : "41QHE14SDOdId+d+g9isQVRgpkPKRRAoYWcaLVt//BdW4VjjSf0QfEmMMPzRGo6wl1TCcx5GUtGFr8sfh315Tuj4AT/ea4sSyv9z7Tgklo2RhV9zMhDOh7bBI5vp+uPf" 		string (byte)
muid
optional 		it is empty for the case of an anonymous transaction
Example : "cg2t1" 		string
tenant
optional 		Example : "Monet+" string

GetTransactionStateResponse

Name Description Schema
code
optional 		Example : 0 integer (int32)
data
optional 		Example : "[gettransactionstateresponse-data](#gettransactionstateresponse-data)" GetTransactionStateResponse.Data
message
optional 		Example : "string" string
status
optional 		Example : "string" enum (success, fail, error)

GetTransactionStateResponse.Data

Name Description Schema
muid
optional 		Example : "cg2t1" string
state
required 		Example : "INITIATED" enum (INITIATED, LOADED, EXPIRED, AUTHORIZED, FAILED, CANCELED)

IdportCaseResponse

Type : object

InitiateInstanceRequest

Name Description Schema
methodSpecific
optional 		depends on MethodType
Example : "object" 		object
methodType
required 		Example : "PASSWORD" enum (PASSWORD, ACTIVATION_CODE, SMS, CM, SPNEGO, TLS_CLIENT)
muid
required 		Example : "cg2t1" string
name
optional 		Example : "Swagger instance test name" string
tenant
optional 		Example : "Monet+" string
validTo
optional 		Example : "2018-07-13T09:28:01Z" string (date-time)

InitiateInstanceResponse

Name Description Schema
code
optional 		Example : 0 integer (int32)
data
optional 		Example : "[initiateinstanceresponse-data](#initiateinstanceresponse-data)" InitiateInstanceResponse.Data
message
optional 		Example : "string" string
status
optional 		Example : "string" enum (success, fail, error)

InitiateInstanceResponse.Data

Name Description Schema
instanceInfo
required 		Example : "[instanceinfo](#instanceinfo)" InstanceInfo

InitiateTransactionRequest

Name Description Schema
methodType
required 		Example : "PASSWORD" enum (PASSWORD, SMS, CM)
muid
optional 		it is empty for the case of an anonymous transaction
Example : "cg2t1" 		string
notificationDestination
optional 		Example : "IAM" string
operationType
optional 		Example : "AUTHENTICATION" enum (AUTHENTICATION, AUTHORIZATION)
processingOptions
optional 		Example : "[processingoptions](#processingoptions)" ProcessingOptions
tenant
optional 		Example : "Monet+" string
transactionData
optional 		Example : "[transactiondata](#transactiondata)" TransactionData
type
optional 		Example : "PIN" enum (PIN, NO_PIN, INFORMATION_MESSAGE, ALT_SECRET_ACTIVATION)
validity
optional 		use the appropriate timestamp
Example : "2018-07-17T12:44:10.173Z" 		string (date-time)

InitiateTransactionResponse

Name Description Schema
code
optional 		Example : 0 integer (int32)
data
optional 		Example : "[initiatetransactionresponse-data](#initiatetransactionresponse-data)" InitiateTransactionResponse.Data
message
optional 		Example : "string" string
status
optional 		Example : "string" enum (success, fail, error)

InitiateTransactionResponse.Data

Name Description Schema
caseId
required 		Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"
Example : "41QHE14SDOdId+d+g9isQVRgpkPKRRAoYWcaLVt//BdW4VjjSf0QfEmMMPzRGo6wl1TCcx5GUtGFr8sfh315Tuj4AT/ea4sSyv9z7Tgklo2RhV9zMhDOh7bBI5vp+uPf" 		string (byte)
methodSpecific
optional 		Example : {<br> "salt" : "ZyzptbmtG7VnA9621BbhcsWMAVFp6BKkHwK0FqxmB3U=",<br> "cipherPublicKey" : "MIHfMA0GCSqGSIb3DQEBAQUAA4HNADCByQKBwQCbA+nA4Oyfe4OiFeYGRK8O02+q3ObJ3IZPhYw7SJ5ULhygpZNhIcL5X0c1c2/yHuVoD7PKmoguQUu5Jj5uRC2ovvC8+X+xPRfohrhw8IXQ/DJC8AqRifCCUWshL8qzA4NNzIDIcMG+gLstSHdcMt6+opQb7AemGPfKiWVYw8wsTI9omkfT5QeMWTGJjBD38DFTLzEua/E56lm4MKDM4rk2PxD0Va0h2aZG7T0F6RwqhM7YYLhbc9LVwr840U9/EfUCAwEAAQ==",<br> "algType" : 2,<br> "nonce" : "l9ned9tLn4hpytmcXjLS2hiYcs85iPDwM6Kx5QRxiPoNilzlAi8BoDxt7YJ/nQ1o"<br>} object

InstanceInfo

Name Description Schema
activated
optional 		Example : "string" string (date-time)
blocked
optional 		Example : "string" string (date-time)
deactivated
optional 		Example : "string" string (date-time)
instanceId
optional 		Example : "string" string
instanceName
optional 		Example : "string" string
lastAccess
optional 		Example : "string" string (date-time)
state
optional 		Example : "string" enum (ACTIVE, BLOCKED_MAN, DEACTIVATED, EXPIRED, INITIATED)
validTo
optional 		Example : "string" string (date-time)

Locale

Name Description Schema
country
optional 		Example : "string" string
displayCountry
optional 		Example : "string" string
displayLanguage
optional 		Example : "string" string
displayName
optional 		Example : "string" string
displayScript
optional 		Example : "string" string
displayVariant
optional 		Example : "string" string
extensionKeys
optional 		Example : [ "[character](#character)" ] < Character > array
iso3Country
optional 		Example : "string" string
iso3Language
optional 		Example : "string" string
language
optional 		Example : "string" string
script
optional 		Example : "string" string
unicodeLocaleAttributes
optional 		Example : [ "string" ] < string > array
unicodeLocaleKeys
optional 		Example : [ "string" ] < string > array
variant
optional 		Example : "string" string

MethodInfo

Name Description Schema
activeInstances
optional 		Example : 0 integer (int32)
blockedUntil
optional 		Example : "string" string (date-time)
failedAttempts
optional 		Example : 0 integer (int32)
instances
optional 		Example : [ "object" ] < object > array
methodType
optional 		Example : "string" enum (PASSWORD, ACTIVATION_CODE, SMS, CM, SPNEGO, TLS_CLIENT)
remainingAttempts
optional 		Example : 0 integer (int32)
state
optional 		Example : "string" enum (ACTIVE, BLOCKED_MAN, BLOCKED_USAGE_TEMP, BLOCKED_USAGE_PERM, DEACTIVATED)

ProcessingOptions

Name Description Schema
authorizationFlow
optional 		Example : "ONLINE_OFFLINE" enum (ONLINE, OFFLINE, ONLINE_OFFLINE)
offlineChallenge
optional 		Example : "QR" enum (QR, NONE, QR_NONE)

SetInstancePropertyRequest

Name Description Schema
instanceId
required 		Example : "9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3" string
methodType
required 		Example : "PASSWORD" enum (PASSWORD, ACTIVATION_CODE, SMS, CM, SPNEGO, TLS_CLIENT)
muid
required 		Example : "cg2t1" string
name
optional 		Example : "Swagger instance test name" string
tenant
optional 		Example : "Monet+" string
validTo
optional 		Example : "2018-07-13T09:28:01Z" string (date-time)

SetInstancePropertyResponse

Name Description Schema
code
optional 		Example : 0 integer (int32)
message
optional 		Example : "string" string
status
optional 		Example : "string" enum (success, fail, error)

TransactionData

Name Description Schema
data
required 		Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"
Example : "U1RYMCVUUk5fSUQlJVRSTl9USU1FJVMwJENBU0VNb2JpbGUgdGVjaG5pY2FsIHRyYW5zYWN0aW9uJCo=" 		string (byte)
locale
required 		ISO 639-1
Example : "[locale](#locale)" 		Locale
template
required 		Example : "AUTHENTICATION" string

UnblockInstanceRequest

Name Description Schema
instanceId
required 		Example : "9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3" string
methodType
required 		Example : "PASSWORD" enum (PASSWORD, ACTIVATION_CODE, SMS, CM, SPNEGO, TLS_CLIENT)
muid
required 		Example : "cg2t1" string
tenant
optional 		Example : "Monet+" string

UnblockInstanceResponse

Name Description Schema
code
optional 		Example : 0 integer (int32)
message
optional 		Example : "string" string
status
optional 		Example : "string" enum (success, fail, error)

UnblockMethodRequest

Name Description Schema
methodType
required 		Example : "PASSWORD" enum (PASSWORD, ACTIVATION_CODE, SMS, CM, SPNEGO, TLS_CLIENT)
muid
required 		Example : "cg2t1" string
tenant
optional 		Example : "Monet+" string

UnblockMethodResponse

Name Description Schema
code
optional 		Example : 0 integer (int32)
message
optional 		Example : "string" string
status
optional 		Example : "string" enum (success, fail, error)

VerifyTransactionRequest

Name Description Schema
caseId
required 		it is get from /initiateTransaction response
Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"
Example : "41QHE14SDOdId+d+g9isQVRgpkPKRRAoYWcaLVt//BdW4VjjSf0QfEmMMPzRGo6wl1TCcx5GUtGFr8sfh315Tuj4AT/ea4sSyv9z7Tgklo2RhV9zMhDOh7bBI5vp+uPf" 		string (byte)
chap
optional 		Example : "[chap](#chap)" Chap
code
optional 		it is computed from /initiateTransaction response
Example : "kuxejDzuNbSh1z6VGzYqo7Bv90IpfRavzGfxBYN9yl6D549zaSawq6+Cb0RDQLUz+vpFCgPBMHs73AQO1TpkVCACO/XiDfAf6P2ad61pPlXN02+L6fARtxXcOqowuM5AdPQioV4Byo1/guSjsT/BGNL0MpIjw5NgMtpB5NNw24+2PYx+8lzZM25NPTNaylTJNXBiCL3kBV/p68hc2p4EDzSSRjgA0uTH1oNMIqyNXXPOFGCKU9RSylrBnwLpCUkq" 		string
methodType
required 		Example : "PASSWORD" enum (PASSWORD, ACTIVATION_CODE, SMS, CM, SPNEGO, TLS_CLIENT)
muid
required 		Example : "cg2t1" string
tenant
optional 		Example : "Monet+" string

VerifyTransactionResponse

Name Description Schema
code
optional 		Example : 0 integer (int32)
data
optional 		Example : "[verifytransactionresponse-data](#verifytransactionresponse-data)" VerifyTransactionResponse.Data
message
optional 		Example : "string" string
status
optional 		Example : "string" enum (success, fail, error)

VerifyTransactionResponse.Data

Name Description Schema
instanceInfo
optional 		Example : "[instanceinfo](#instanceinfo)" InstanceInfo
method
optional 		Example : "[methodinfo](#methodinfo)" MethodInfo
⚠️ **GitHub.com Fallback** ⚠️