bcs-authentication-management-api-services

API INFORMATION

Title: authentication-management-api-service

Version: 1.0.5

Protocols: HTTPS

URI Sandbox: https://authentication-management-api-services-dev.us-e1.cloudhub.io/api/authentication-management/v1

URI QA: https://authentication-management-api-services-qa.us-e1.cloudhub.io/api/authenticationManagement/v1

URILive: https://authentication-management-api-services-prd.us-e1.cloudhub.io/api/authenticationManagement/v1

DOWLOAD RAML

DESCRIPTION

The API will offer consumers to log in to the system, which allows the following operations:

Summary

-Client Authentication

Path:

POST

/authentication-management/v1/user:

Headers

X-Invoker-BranchId: Office code

X-Invoker-TerminalId: Term code

X-Invoker-Component: Component

X-Invoker-UserIPAddress: Client IP Address

X-Invoker-ServerIPAddress: Server IP Address

X-Invoker-UserMACAddress: Client MAC Address

X-Invoker-ServerMACAddress: Server MAC Address

X-Invoker-ProcessDate: Process date

X-Invoker-TxId: Id TX

X-Invoker-SessionKey: Session key

X-Invoker-Source: Origin

X-Invoker-Country: Country

X-Invoker-ProcessBpmId: ID BPM process

X-Invoker-ProcessId: Process ID

X-Invoker-Network: Net

X-Invoker-Channel: Channel with which the transaction must be registered (minLength:3 "007").

X-Invoker-subChannel: Subchannel with which the transaction must be registered.

X-Invoker-User: User

X-Invoker-Action: Action

X-Invoker-Destination: Destination

X-Invoker-ModifierUser: Modification user

X-Invoker-ReferencedNumber: Reference number

X-Invoker-RequestNumber: Request number

X-Invoker-CustId: Client code

Headers Security

X-Security-CustLoginId: Used to identify the user who logs in

X-Security-ClientID: The Mule expression to use for obtaining the client ID from

X-Security-ClientSecret: The Mule expression to use for obtaining the client secret from API requests

X-Security-Token: Used to send a valid OAuth 2 access token

Service's Own Headers

X-Invoker-Ally: Ally that is used to be able to decrypt and re-encrypt the client's password with the bank's keys.

X-Ident-DeviceFingerPrint: Field for the encrypted fingerprint.

X-Ident-TransactionDate: Date and time of the transaction.

Body:

engineRiskInfo: Engine Hazard Information.

govIssueIdent: Identification given by the local government.

personInfo: Customer information.

custId: Client code included in the invoker.

custPswd: Information about a user's password.

> Example when sending govIssueIdent value identSerialNum and govIssueIdentType.

 {
"engineRiskInfo":{
        "transactionId":"100001"
    },
    "govIssueIdent": {
        "identSerialNum": "41728985",
        "govIssueIdentType": "CC"
    },
    "personInfo":{
        "nameAddrType":"N"
    },
    "custPswd":{
        "pswd":"63d695215279188ce710fe16e5b11f93"
    }
}

> Example when sending custId value SPName.

{
    "engineRiskInfo":{
        "transactionId":"100001"
    },
    "personInfo":{
        "nameAddrType":"N"
    },
    "custId":{
        "SPName":"ALIAS8985"
    },
    "custPswd":{
        "pswd":"63d695215279188ce710fe16e5b11f93"
    }
}

> Response 200.

{
    "govIssueIdent": {
        "govIssueIdentType": "CC",
        "identSerialNum": "41728985"
    },
    "personName": {
        "fullName": "BLANCA ELVIA RUANO FONSECA",
        "lastAuthInfo": {
            "lastTrnDt": "2022-08-18T08:36:45"
        }
    }
}

Response information:

responseType: Used to return the response.

govIssueIdent: Identification given by the local government.

personName: Customer information.

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the follogin structur.
{
    "responseType": {
        "value": "ER"
    },
    "responseDetail": {
        "errorCode": "1006",
        "errorDesc": "Usuario o clave inválidos.",
        "errorType": "OUD"
    }
}

> Diagram of sequence.

####

- Backbase - Logout v2.

Description:

Service to close user session. Business Service: ADMUSU_CERRSESI

Path:

POST:

/authentication-management/v2/logout:

Headers

Mapping Data:

- Request:

- Response:

Examples:

Example of Body Request:

{
    "govIssueIdent": {
        "identSerialNum": "123456",
        "govIssueIdentType": "CC"
    },
    "engineRiskInfo": {
        "transactionId": "100050",
        "logoutDt": "2024-04-05T22:14:34"
    }
}

Example of Body Response:

{
    "responseType": {
        "value": "OK"
    }
}

Example of Body Response Error:

{
    "responseType": {
        "value": "ERR500"
    },
    "responseDetail": {
        "errorCode": 500,
        "errorDesc": "OSB Validate action failed validationcerrarSesion_PNN_EXPOSB-382505OSB Validate action failed validationInvalid date value: 2024-08-05 T22:14:342024-08-05 T22:14:34cerrarSesion_PNN_EXPrequest-a052071.N5e3b2442.0.1643896a235.N78fcstg_validarEntradarequest-pipeline",
        "errorType": "Internal Server Error"
    }
}

Error Code Response:

Diagrama.