xlg-pat-v-opb-transmit-access-recovery

xlg-pat-v-opb-transmit-access-recovery 1.1.0

0
No votes yet

This purpose of this Microservice is to perform the operations with transmit soft token in SSS to recover customer's access. This is an Orchestrator service.

production
development
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext

Paths

/v1/open-banking/x-global/security/customers/electronic-banking/access/unlock

post /v1/open-banking/x-global/security/customers/electronic-banking/access/unlock
opb-transmit-unlock-customer-access

LOB:Security; Feature:Unlock; Functionality:transmit-soft token

This API is used to unlock a customer access to electronic banking using the transmit soft token through SSS

Client ID
X-IBM-Client-Id
(apiKey located in header)
client_id
Optional in header
string

Client ID generated during application registration

Authorization
Optional in header
string

The Authorization Token received during login

Accept
Required in header
string

Content-Types that are acceptable for the response

uuid
Required in header
string

128 bit UUID that you generate for every request

Accept-Language
Optional in header
string

List of acceptable human languages for response

Content-Type
Required in header
string

Content-Types that are sent in the request

countryCode
Required in header
string

Country code in 2 character ISO 3166 format

businessCode
Required in header
string

Business code identified during application registration

ChannelId
Required in header
string

Channel where request originated

sid
Optional in header
string

SessionId sent by Consumer

unlockCustomerRequest
Required in body
object
UnlockCustomerRequest
204

Successful operation.

400
TypeCodeDetails
errorinvalidRequestMissing or invalid Parameters
errorcannotDecryptData620-Cannot decrypt, please re-check the encrypted value
ErrorResponse
401
TypeCodeDetails
errorunAuthorizedAuthorization credentials are missing or invalid
ErrorResponse
403
TypeCodeDetailsMore Info
erroraccessNotConfiguredThe request operation is not configured to access this resourceChannel/Country/Business provided in the request is not supported currently
ErrorResponse
404
TypeCodeDetailsMore Info
errorresourceNotFoundThe requested resource was not foundEmpty resource/resource not found
ErrorResponse
422
TypeCodeDetails
errorbusinessValidationFailedBusiness validation error occured on one or more parameters
ErrorResponse
500
TypeCodeDetails
fatalserverUnavailableThe request failed due to an internal error/server unavailability
ErrorResponse
Example Request
Example Response
POST https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/open-banking/x-global/security/customers/electronic-banking/access/unlock

Definitions 

{
    "type": "object",
    "properties": {
        "jwtToken": {
            "type": "string",
            "example": "kkhljsdf87sdifskjfsdhkf8fsdf",
            "description": "JWT to validate customer email."
        },
        "grantType": {
            "type": "string",
            "example": "2",
            "maxLength": 2,
            "pattern": "^[0-9]{1,2}$",
            "description": "Id of the token, used for identifying the kind of functional Id also known as applicationId for calling the transmit JWT validator service 
tokenIdDetails
1SMS-OTP functional Id
2binding functional Id
3New Online Transaction functional Id
4Avatar Transaction functional Id
5IVR Transaction functional ID
6AcciTrade Transaction functional ID
7Directo Transaction functional ID
"
        },
        "customer": {
            "$ref": "#/definitions/Customer"
        }
    },
    "required": [
        "jwtToken",
        "customer"
    ]
}
              
{
    "type": "object",
    "properties": {
        "encryptedCustomerId": {
            "description": "Unique identifier of the customer. This value must be encrypted with AES key shared previously using E2E-Encryption API's.",
            "type": "string",
            "example": "LHU52hAAkRgjsNf/ZWTDOhgpUMJsovFTTenIRyOu6y1hKqeoBzlzHbstxSdTN2cCDdGevF0IRlzaGiRuNQSftVu5dQVh8IBCx2hV8bAtMXE=.GmVNmN8A08OEl5uqAgI6I9iVmuADxnm103Cpj1+hxFk="
        },
        "legalRepresentativeId": {
            "description": "Unique identifier for corporate legal Representative. Only for Corporate customers",
            "type": "string",
            "pattern": "^[0-9]{1,2}$",
            "example": "1",
            "maxLength": 2
        }
    },
    "required": [
        "encryptedCustomerId"
    ]
}
              
{
    "properties": {
        "type": {
            "type": "string",
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ]
        },
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "moreInfo": {
            "description": "More Info can be used to pass any additional details",
            "type": "string"
        },
        "uuid": {
            "description": "128 bit UUID that you generate for every request",
            "type": "string"
        },
        "timestamp": {
            "description": "Timestamp of the error",
            "type": "string"
        }
    },
    "required": [
        "type",
        "code"
    ]
}