Skip to content

IAPI 1.4

Anezka Pejlova edited this page Nov 25, 2021 · 1 revision

Product IAPI APIs v1

Overview

Version information

Swagger YAML Version : 1.4.0-SNAPSHOT

Contact information

Contact : Monet+

URI scheme

Host : ${BASE_URL}
BasePath : /

Tags

  • case-iapi-int-rest-controller : Case Iapi Int Rest Controller
  • 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
Header x-tenant-id
required
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
"idport"

Example HTTP response

Response 200
{
  "code" : 0,
  "data" : {
    "list" : [ {
      "id" : "string",
      "type" : "string"
    } ],
    "tenant" : "idport"
  },
  "message" : "string",
  "status" : "string"
}

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
Header x-tenant-id
required
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
"idport"
Request body
{
  "instanceId" : "9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3",
  "methodType" : "PASSWORD",
  "muid" : "64728948"
}

Example HTTP response

Response 200
{
  "code" : 0,
  "data" : {
    "instanceInfo" : {
      "activated" : "string",
      "blocked" : "string",
      "deactivated" : "string",
      "instanceId" : "string",
      "instanceName" : "string",
      "lastAccess" : "string",
      "methodType" : "string",
      "state" : "string",
      "validTo" : "string"
    }
  },
  "message" : "string",
  "status" : "string"
}

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
Header x-tenant-id
required
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
"idport"
Request body
{
  "methodSpecific" : {
    "algType" : 2
  },
  "methodType" : "PASSWORD",
  "muid" : "64728948"
}

Example HTTP response

Response 200
{
  "code" : 0,
  "data" : {
    "instanceInfo" : {
      "activated" : "string",
      "blocked" : "string",
      "deactivated" : "string",
      "instanceId" : "string",
      "instanceName" : "string",
      "lastAccess" : "string",
      "methodType" : "string",
      "state" : "string",
      "validTo" : "string"
    },
    "methodSpecific" : {
      "id" : "string"
    }
  },
  "message" : "string",
  "status" : "string"
}

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
Header x-tenant-id
required
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
"idport"
Request body
{
  "muid" : "64728948"
}

Example HTTP response

Response 200
{
  "code" : 0,
  "data" : {
    "code" : "240537",
    "qrData" : "UVI1fDF8QTAzNDk0QkV8Y2cydDFAbW9uZXRwbHVzLmN6fDIzNzQyMQ==",
    "userId" : "cg2t1@monetplus.cz"
  },
  "message" : "string",
  "status" : "string"
}

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
Header x-tenant-id
required
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
"idport"
Request body
{
  "instanceId" : "9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3",
  "methodType" : "PASSWORD",
  "muid" : "64728948"
}

Example HTTP response

Response 200
{
  "code" : 0,
  "message" : "string",
  "status" : "string"
}

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
Header x-tenant-id
required
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
"idport"
Request body
{
  "methodType" : "PASSWORD",
  "muid" : "64728948"
}

Example HTTP response

Response 200
{
  "code" : 0,
  "message" : "string",
  "status" : "string"
}

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
Header x-tenant-id
required
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
"idport"
Request body
{
  "caseId" : "41QHE14SDOdId+d+g9isQVRgpkPKRRAoYWcaLVt//BdW4VjjSf0QfEmMMPzRGo6wl1TCcx5GUtGFr8sfh315Tuj4AT/ea4sSyv9z7Tgklo2RhV9zMhDOh7bBI5vp+uPf",
  "muid" : "64728948",
  "reason" : "SWAGGER test"
}

Example HTTP response

Response 200
{
  "code" : 0,
  "message" : "string",
  "status" : "string"
}

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
Header x-tenant-id
required
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
"idport"
Request body
{
  "instanceId" : "9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3",
  "methodType" : "PASSWORD",
  "muid" : "64728948"
}

Example HTTP response

Response 200
{
  "code" : 0,
  "message" : "string",
  "status" : "string"
}

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
Header x-tenant-id
required
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
"idport"
Request body
{
  "methodType" : "PASSWORD",
  "muid" : "64728948"
}

Example HTTP response

Response 200
{
  "code" : 0,
  "message" : "string",
  "status" : "string"
}

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
Header x-tenant-id
required
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
"idport"
Request body
{
  "methodSpecific" : {
    "string" : "[serializable](#serializable)"
  },
  "methodType" : "PASSWORD",
  "muid" : "64728948",
  "name" : "Swagger instance test name",
  "validTo" : "2018-07-13T09:28:01Z"
}

Example HTTP response

Response 200
{
  "code" : 0,
  "data" : {
    "instanceInfo" : {
      "activated" : "string",
      "blocked" : "string",
      "deactivated" : "string",
      "instanceId" : "string",
      "instanceName" : "string",
      "lastAccess" : "string",
      "methodType" : "string",
      "state" : "string",
      "validTo" : "string"
    }
  },
  "message" : "string",
  "status" : "string"
}

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
Header x-tenant-id
required
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
"idport"
Request body
{
  "methodType" : "PASSWORD",
  "muid" : "64728948",
  "notificationDestination" : "IAM",
  "operationType" : "AUTHENTICATION",
  "processingOptions" : {
    "authorizationFlow" : "ONLINE_OFFLINE",
    "offlineChallenge" : "QR"
  },
  "transactionData" : {
    "data" : "U1RYMCVUUk5fSUQlJVRSTl9USU1FJVMwJENBU0VNb2JpbGUgdGVjaG5pY2FsIHRyYW5zYWN0aW9uJCo=",
    "locale" : "cs",
    "template" : "AUTHENTICATION"
  },
  "type" : "PIN",
  "validity" : "2018-07-17T12:44:10.173Z"
}

Example HTTP response

Response 200
{
  "code" : 0,
  "data" : {
    "caseId" : "41QHE14SDOdId+d+g9isQVRgpkPKRRAoYWcaLVt//BdW4VjjSf0QfEmMMPzRGo6wl1TCcx5GUtGFr8sfh315Tuj4AT/ea4sSyv9z7Tgklo2RhV9zMhDOh7bBI5vp+uPf",
    "encryptionHeader" : {
      "alg" : "string",
      "enc" : "string",
      "epk" : {
        "crv" : "string",
        "kid" : "string",
        "kty" : "string",
        "x" : "string",
        "y" : "string"
      }
    },
    "expiration" : {
      "seconds" : 0,
      "timestamp" : "string"
    },
    "methodSpecific" : {
      "salt" : "ZyzptbmtG7VnA9621BbhcsWMAVFp6BKkHwK0FqxmB3U=",
      "cipherPublicKey" : "MIHfMA0GCSqGSIb3DQEBAQUAA4HNADCByQKBwQCbA+nA4Oyfe4OiFeYGRK8O02+q3ObJ3IZPhYw7SJ5ULhygpZNhIcL5X0c1c2/yHuVoD7PKmoguQUu5Jj5uRC2ovvC8+X+xPRfohrhw8IXQ/DJC8AqRifCCUWshL8qzA4NNzIDIcMG+gLstSHdcMt6+opQb7AemGPfKiWVYw8wsTI9omkfT5QeMWTGJjBD38DFTLzEua/E56lm4MKDM4rk2PxD0Va0h2aZG7T0F6RwqhM7YYLhbc9LVwr840U9/EfUCAwEAAQ==",
      "algType" : 2,
      "nonce" : "l9ned9tLn4hpytmcXjLS2hiYcs85iPDwM6Kx5QRxiPoNilzlAi8BoDxt7YJ/nQ1o"
    }
  },
  "message" : "string",
  "status" : "string"
}

instanceIdentity

instanceIdentity

POST /v1/instanceIdentity

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
Header x-tenant-id
required
string
Body req
required
req GetInstanceIdentityRequest

Responses

HTTP Code Description Schema
200 OK GetInstanceIdentityResponse

Consumes

  • application/json

Produces

  • application/json

Tags

  • case-iapi-rest-controller

Example HTTP request

Request path
/v1/instanceIdentity
Request header
"idport"
Request body
{
  "instanceId" : "string",
  "methodType" : "string"
}

Example HTTP response

Response 200
{
  "code" : 0,
  "data" : {
    "muid" : "string"
  },
  "message" : "string",
  "status" : "string"
}

int_initiateTransaction

int_initiateTransaction

POST /v1/int/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
Header x-tenant-id
required
string
Body req
required
req InternalInitiateTransactionRequest

Responses

HTTP Code Description Schema
200 OK InitiateTransactionResponse

Consumes

  • application/json

Produces

  • application/json

Tags

  • case-iapi-int-rest-controller

Example HTTP request

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

Example HTTP response

Response 200
{
  "code" : 0,
  "data" : {
    "caseId" : "41QHE14SDOdId+d+g9isQVRgpkPKRRAoYWcaLVt//BdW4VjjSf0QfEmMMPzRGo6wl1TCcx5GUtGFr8sfh315Tuj4AT/ea4sSyv9z7Tgklo2RhV9zMhDOh7bBI5vp+uPf",
    "encryptionHeader" : {
      "alg" : "string",
      "enc" : "string",
      "epk" : {
        "crv" : "string",
        "kid" : "string",
        "kty" : "string",
        "x" : "string",
        "y" : "string"
      }
    },
    "expiration" : {
      "seconds" : 0,
      "timestamp" : "string"
    },
    "methodSpecific" : {
      "salt" : "ZyzptbmtG7VnA9621BbhcsWMAVFp6BKkHwK0FqxmB3U=",
      "cipherPublicKey" : "MIHfMA0GCSqGSIb3DQEBAQUAA4HNADCByQKBwQCbA+nA4Oyfe4OiFeYGRK8O02+q3ObJ3IZPhYw7SJ5ULhygpZNhIcL5X0c1c2/yHuVoD7PKmoguQUu5Jj5uRC2ovvC8+X+xPRfohrhw8IXQ/DJC8AqRifCCUWshL8qzA4NNzIDIcMG+gLstSHdcMt6+opQb7AemGPfKiWVYw8wsTI9omkfT5QeMWTGJjBD38DFTLzEua/E56lm4MKDM4rk2PxD0Va0h2aZG7T0F6RwqhM7YYLhbc9LVwr840U9/EfUCAwEAAQ==",
      "algType" : 2,
      "nonce" : "l9ned9tLn4hpytmcXjLS2hiYcs85iPDwM6Kx5QRxiPoNilzlAi8BoDxt7YJ/nQ1o"
    }
  },
  "message" : "string",
  "status" : "string"
}

int_verifyTransaction

int_verifyTransaction

POST /v1/int/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
Header x-tenant-id
required
string
Body req
required
req InternalVerifyTransactionRequest

Responses

HTTP Code Description Schema
200 OK InternalVerifyTransactionResponse

Consumes

  • application/json

Produces

  • application/json

Tags

  • case-iapi-int-rest-controller

Example HTTP request

Request path
/v1/int/verifyTransaction
Request header
"idport"
Request body
{
  "authorizationFlow" : "64728948",
  "caseId" : "41QHE14SDOdId+d+g9isQVRgpkPKRRAoYWcaLVt//BdW4VjjSf0QfEmMMPzRGo6wl1TCcx5GUtGFr8sfh315Tuj4AT/ea4sSyv9z7Tgklo2RhV9zMhDOh7bBI5vp+uPf",
  "code" : { },
  "deviceInfo" : {
    "appVersion" : "string",
    "authenticationMethods" : [ "string" ],
    "deviceManufacturer" : "string",
    "deviceModel" : "string",
    "flags" : "string",
    "geoLocation" : {
      "latitude" : 0.0,
      "longitude" : 0.0
    },
    "hwId" : "string",
    "osVersion" : "string",
    "platform" : "string"
  },
  "instanceId" : "9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3",
  "methodTypes" : "PASSWORD",
  "muid" : "64728948"
}

Example HTTP response

Response 200
{
  "code" : 0,
  "data" : {
    "instanceInfo" : [ {
      "activated" : "string",
      "blocked" : "string",
      "deactivated" : "string",
      "instanceId" : "string",
      "instanceName" : "string",
      "lastAccess" : "string",
      "methodType" : "string",
      "state" : "string",
      "validTo" : "string"
    } ]
  },
  "message" : "string",
  "status" : "string"
}

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
Header x-tenant-id
required
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
"idport"
Request body
{
  "methodTypes" : [ "PASSWORD" ],
  "muid" : "64728948"
}

Example HTTP response

Response 200
{
  "code" : 0,
  "data" : {
    "methodInfo" : [ {
      "methodType" : "PASSWORD",
      "state" : "ACTIVE",
      "activeInstances" : 1,
      "instances" : [ {
        "instanceId" : "9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3",
        "state" : "ACTIVE",
        "instanceName" : "Swagger instance test name"
      }, {
        "instanceId" : "9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3_2",
        "state" : "INITIATED",
        "instanceName" : "Swagger instance test name_2"
      } ],
      "failedAttempts" : 0,
      "remainingAttempts" : 3
    } ]
  },
  "message" : "string",
  "status" : "string"
}

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
Header x-tenant-id
required
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
"idport"
Request body
{
  "methodType" : "PASSWORD",
  "muid" : "64728948"
}

Example HTTP response

Response 200
{
  "code" : 0,
  "data" : {
    "methodSpecific" : { }
  },
  "message" : "string",
  "status" : "string"
}

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
Header x-tenant-id
required
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
"idport"

Example HTTP response

Response 200
{ }

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
Header x-tenant-id
required
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
"idport"
Request body
{
  "instanceId" : "9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3",
  "methodType" : "PASSWORD",
  "muid" : "64728948",
  "name" : "Swagger instance test name",
  "validTo" : "2018-07-13T09:28:01Z"
}

Example HTTP response

Response 200
{
  "code" : 0,
  "message" : "string",
  "status" : "string"
}

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
Header x-tenant-id
required
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
"idport"
Request body
{
  "caseId" : "41QHE14SDOdId+d+g9isQVRgpkPKRRAoYWcaLVt//BdW4VjjSf0QfEmMMPzRGo6wl1TCcx5GUtGFr8sfh315Tuj4AT/ea4sSyv9z7Tgklo2RhV9zMhDOh7bBI5vp+uPf",
  "muid" : "64728948"
}

Example HTTP response

Response 200
{
  "code" : 0,
  "data" : {
    "muid" : "64728948",
    "state" : "INITIATED"
  },
  "message" : "string",
  "status" : "string"
}

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
Header x-tenant-id
required
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
"idport"
Request body
{
  "instanceId" : "9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3",
  "methodType" : "PASSWORD",
  "muid" : "64728948"
}

Example HTTP response

Response 200
{
  "code" : 0,
  "message" : "string",
  "status" : "string"
}

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
Header x-tenant-id
required
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
"idport"
Request body
{
  "methodType" : "PASSWORD",
  "muid" : "64728948"
}

Example HTTP response

Response 200
{
  "code" : 0,
  "message" : "string",
  "status" : "string"
}

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
Header x-tenant-id
required
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
"idport"
Request body
{
  "caseId" : "41QHE14SDOdId+d+g9isQVRgpkPKRRAoYWcaLVt//BdW4VjjSf0QfEmMMPzRGo6wl1TCcx5GUtGFr8sfh315Tuj4AT/ea4sSyv9z7Tgklo2RhV9zMhDOh7bBI5vp+uPf",
  "chap" : {
    "authProtocol" : 1,
    "challenge" : "MzM5MjA1",
    "response" : "MzM5MjA1",
    "username" : "64728948"
  },
  "code" : "kuxejDzuNbSh1z6VGzYqo7Bv90IpfRavzGfxBYN9yl6D549zaSawq6+Cb0RDQLUz+vpFCgPBMHs73AQO1TpkVCACO/XiDfAf6P2ad61pPlXN02+L6fARtxXcOqowuM5AdPQioV4Byo1/guSjsT/BGNL0MpIjw5NgMtpB5NNw24+2PYx+8lzZM25NPTNaylTJNXBiCL3kBV/p68hc2p4EDzSSRjgA0uTH1oNMIqyNXXPOFGCKU9RSylrBnwLpCUkq",
  "methodType" : "PASSWORD",
  "muid" : "64728948"
}

Example HTTP response

Response 200
{
  "code" : 0,
  "data" : {
    "instanceInfo" : {
      "activated" : "string",
      "blocked" : "string",
      "deactivated" : "string",
      "instanceId" : "string",
      "instanceName" : "string",
      "lastAccess" : "string",
      "methodType" : "string",
      "state" : "string",
      "validTo" : "string"
    }
  },
  "message" : "string",
  "status" : "string"
}

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 : "idport" 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 : "64728948" 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>} < string, Serializable > map
methodType
required
Example : "PASSWORD" enum (PASSWORD, ACTIVATION_CODE, SMS, CM, SPNEGO, TLS_CLIENT)
muid
required
Example : "64728948" 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

AuthorizationCodeObject

Type : object

BinaryCode

Polymorphism : Composition

Name Description Schema
encryption
optional
Example : "string" enum (NONE, AES, RSA, JWE)
value
optional
Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"
Example : "string"
string (byte)

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 : "64728948" 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 : "64728948" 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
Example : "41QHE14SDOdId+d+g9isQVRgpkPKRRAoYWcaLVt//BdW4VjjSf0QfEmMMPzRGo6wl1TCcx5GUtGFr8sfh315Tuj4AT/ea4sSyv9z7Tgklo2RhV9zMhDOh7bBI5vp+uPf" string
muid
optional
it is empty for the case of an anonymous transaction
Example : "64728948"
string
reason
optional
Example : "SWAGGER test" 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 : "64728948" string

ComponentAccess

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

Data

Name Description Schema
muid
optional
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 : "64728948" 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 : "64728948" string

DeactivateMethodResponse

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

DeviceInfo

Name Description Schema
appVersion
optional
Example : "string" string
authenticationMethods
optional
Example : [ "string" ] < enum (PIN, BIOMETRICS, NO_PIN, CONFIRM) > array
deviceManufacturer
optional
Example : "string" string
deviceModel
optional
Example : "string" string
flags
optional
Example : "string" string
geoLocation
optional
Example : "[geolocation](#geolocation)" GeoLocation
hwId
optional
Example : "string" string
osVersion
optional
Example : "string" string
platform
optional
Example : "string" enum (ANDROID, IOS, WIN_PHONE)

ECPublicKey

Name Description Schema
crv
optional
Example : "string" string
kid
optional
Example : "string" string
kty
optional
Example : "string" string
x
optional
Example : "string" string
y
optional
Example : "string" string

EncryptionHeader

Name Description Schema
alg
optional
Example : "string" string
enc
optional
Example : "string" string
epk
optional
Example : "[ecpublickey](#ecpublickey)" ECPublicKey

Expiration

Name Description Schema
seconds
required
Example : 0 integer (int64)
timestamp
required
Example : "string" string

GeoLocation

Name Description Schema
latitude
optional
Example : 0.0 number (double)
longitude
optional
Example : 0.0 number (double)

GetActivationCodeRequest

Name Description Schema
muid
required
Example : "64728948" 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 : "cg2t1@monetplus.cz" string

GetInstanceIdentityRequest

Name Description Schema
instanceId
optional
Example : "string" string
methodType
optional
Example : "string" enum (PASSWORD, ACTIVATION_CODE, SMS, CM, SPNEGO, TLS_CLIENT)

GetInstanceIdentityResponse

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

GetMethodInfoRequest

Name Description Schema
methodTypes
required
Example : [ "PASSWORD" ] < enum (PASSWORD, ACTIVATION_CODE, SMS, CM, SPNEGO, TLS_CLIENT) > array
muid
required
Example : "64728948" 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 : "64728948" 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 : "[methodspecifics](#methodspecifics)" MethodSpecifics

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 : "64728948"
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 : "64728948" 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 : {<br> "string" : "[serializable](#serializable)"<br>}
< string, Serializable > map
methodType
required
Example : "PASSWORD" enum (PASSWORD, ACTIVATION_CODE, SMS, CM, SPNEGO, TLS_CLIENT)
muid
required
Example : "64728948" string
name
optional
Example : "Swagger instance test name" 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 : "64728948"
string
notificationDestination
optional
Example : "IAM" string
operationType
optional
Example : "AUTHENTICATION" enum (AUTHENTICATION, AUTHORIZATION)
processingOptions
optional
Example : "[processingoptions](#processingoptions)" ProcessingOptions
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
Example : "41QHE14SDOdId+d+g9isQVRgpkPKRRAoYWcaLVt//BdW4VjjSf0QfEmMMPzRGo6wl1TCcx5GUtGFr8sfh315Tuj4AT/ea4sSyv9z7Tgklo2RhV9zMhDOh7bBI5vp+uPf" string
encryptionHeader
optional
Example : "[encryptionheader](#encryptionheader)" EncryptionHeader
expiration
optional
Example : "[expiration](#expiration)" Expiration
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>} < string, Serializable > map

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)
methodType
optional
Example : "string" enum (PASSWORD, ACTIVATION_CODE, SMS, CM, SPNEGO, TLS_CLIENT)
state
optional
Example : "string" enum (ACTIVE, BLOCKED_MAN, DEACTIVATED, EXPIRED, INITIATED)
validTo
optional
Example : "string" string (date-time)

InternalInitiateTransactionRequest

Name Description Schema
methodTypes
required
Example : "PASSWORD" < enum (PASSWORD, SMS, CM) > array
muid
optional
it is empty for the case of an anonymous transaction
Example : "64728948"
string
notificationDestination
optional
Example : "IAM" string
operationType
optional
Example : "AUTHENTICATION" enum (AUTHENTICATION, AUTHORIZATION)
processingOptions
optional
Example : "[processingoptions](#processingoptions)" ProcessingOptions
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)

InternalVerifyTransactionRequest

Name Description Schema
authorizationFlow
required
Example : "64728948" enum (ONLINE, OFFLINE, ONLINE_OFFLINE)
caseId
required
it is get from /initiateTransaction response
Example : "41QHE14SDOdId+d+g9isQVRgpkPKRRAoYWcaLVt//BdW4VjjSf0QfEmMMPzRGo6wl1TCcx5GUtGFr8sfh315Tuj4AT/ea4sSyv9z7Tgklo2RhV9zMhDOh7bBI5vp+uPf"
string
code
required
Example : "[authorizationcodeobject](#authorizationcodeobject)" AuthorizationCodeObject
deviceInfo
optional
Example : "[deviceinfo](#deviceinfo)" DeviceInfo
instanceId
optional
Example : "9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3" string
methodTypes
required
Example : "PASSWORD" < enum (PASSWORD, ACTIVATION_CODE, SMS, CM, SPNEGO, TLS_CLIENT) > array
muid
optional
Example : "64728948" string

InternalVerifyTransactionResponse

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

InternalVerifyTransactionResponse.Data

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

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 : [ "[serializable](#serializable)" ] < Serializable > 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)

MethodSpecifics

Type : object

OnlineCode

Polymorphism : Composition

Name Description Schema
digest
optional
Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"
Example : "string"
string (byte)
signature
optional
Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"
Example : "string"
string (byte)

ProcessingOptions

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

Serializable

Type : object

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 : "64728948" string
name
optional
Example : "Swagger instance test name" 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)

TextCode

Polymorphism : Composition

Name Description Schema
encryption
optional
Example : "string" enum (NONE, AES, RSA, JWE)
value
optional
Example : "string" string

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 : "cs"
string
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 : "64728948" 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 : "64728948" 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
Example : "41QHE14SDOdId+d+g9isQVRgpkPKRRAoYWcaLVt//BdW4VjjSf0QfEmMMPzRGo6wl1TCcx5GUtGFr8sfh315Tuj4AT/ea4sSyv9z7Tgklo2RhV9zMhDOh7bBI5vp+uPf"
string
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 : "64728948" 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

Clone this wiki locally