bcs-security-management-api-services

API INFORMATION

Title: security-management-api-service

Version: 1.0.0

Protocols: HTTPS

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

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

URILive: https://security-management-api-services-prod.us-e1.cloudhub.io/api/securityManagement/v1

DOWLOAD RAML

DESCRIPTION

The API offers consumers the creation of OTC with a purpose and its respective security validation, it allows the following operations:

Summary

-Client Authentication

Path:

GET

/api/security-management/v1/user/password/status:

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.

QueryParams:

transactionId: Transaction code defined by the channel.

govIssueIdentType: Identification type given by the local government.

identSerialNum: Identification number given by the local government.

nameAddrType: Customer type 'Natural' or 'Juridica'.

SPName: Client user.

> Example when sending govIssueIdent value identSerialNum and govIssueIdentType.

https://apis.{{env}}.bancocajasocial.co/api/security-management/v1/user/password/status?transactionId=4835799410&nameAddrType=N&govIssueIdentType=CC&identSerialNum=1007641

> Example when sending custId value SPName.

https://apis.{{env}}.bancocajasocial.co/api/security-management/v1/user/password/status?transactionId=4835799410&nameAddrType=N&SPName=ALIAS8985

> Response 200.

{
    "responseType": {
        "value": "OK"
    },
    "custPswdInfo": {
        "pswdStatus": "1",
        "desc": "Activo"
    },
    "contactInfo": {
        "cellPhone": "3175137626",
        "emailAddr": "s9m3b9o7@bancocajasocial.com"
    }
}

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": "32",
        "errorDesc": "ERROR: Buscando el usuario-El usuario no existe",
        "errorType": "OUD"
    }
}

####

-Generate OTC with purpose

Path:

POST

 /securityManagement/V1/generateOTC:

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-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-CustLoginIdSi: 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

Body

govIssueIdent: Identification given by the local government

otc:

otcIssue: Matter of otc

contactInfo: Contact information

Response information:

responseType: Used to return the response

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the following structure.
{
    "responseType": {
        "value": "ER"
    },
    "responseDetail": {
        "errorCode": "10",
        "errorDesc": "Error en Generar Otc",
        "errorType": "BDA"
    }
}

> Diagram of sequence.

####

-Generate OTC with purpose (Version 3)

Path:

POST

 /securityManagement/V3/generateOTC:

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-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-CustLoginIdSi: 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

Body

govIssueIdent: Identification given by the local government

otc:

otcIssue: Matter of otc

contactInfo: Contact information

Response information:

responseType: Used to return the response

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the following structure.
{
    "responseType": {
        "value": "ER"
    },
    "responseDetail": {
        "errorCode": "10",
        "errorDesc": "Error en Generar Otc",
        "errorType": "BDA"
    }
}

> Diagram of sequence.

####

-Validate OTC with purpose

Path:

/securityManagement/V1/validateOTC:

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-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-CustLoginIdSi: 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

Response information:

responseType: Used to return the response

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the following structure.
{
    "responseType": {
        "value": "ER"
    },
    "responseDetail": {
        "errorCode": "10",
        "errorDesc": "Error en validar Otc",
        "errorType": "BDA"
    }
}

> Diagram of sequence.

####

-Create Transation Challenge

Path:

POST

/retoManagement/v1/Customer:

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-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-CustLoginIdSi: 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

Response information:

responseType: Used to return the response

authorization: Authorization 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 following structure.
{
 "ResponseType": {
 "value": "ER"
 },
 "ResponseDetail": {
 "ErrorCode": "20005",
 "ErrorDesc": "ERROR_ID: 39081 LOS DATOS DE LA TRANSACCION NO SON VALIDOS",
 "ErrorType": "RGN"
 }
}

> Diagram of sequence.

####

-Management User Digital Enrollment

Path:

POST

/userManagement/v1/Customer:

Operation that allows the creation User for Digital enrollment

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-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-CustLoginIdSi: 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

Response information:

responseType: Used to return the response

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the following structure.
{
 "ResponseType": {
 "value": "ER"
 },
 "ResponseDetail": {
 "ErrorCode": "HV",
 "ErrorDesc": "HASH VALIDATION HAS FAILED ",
 "ErrorType": "STA"
 }
}

> Diagram of sequence.

####

-Validate User Digital Enrollment

Path:

GET

/userManagement/v1/Customer:

Operation get informtation about User for Digital enrollment

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-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-CustLoginIdSi: 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

Response information:

responseType: Used to return the response

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the following structure.
{
  "ResponseType": {
    "value": "ER"
  },
  "ResponseDetail": {
    "ErrorCode": "00068",
    "ErrorDesc": "Usuario ya existe.",
    "ErrorType": "OUD"
  }
}

> Diagram of sequence.

####

-Management User Change Password

Path:

PUT

/user-management/v1/customer:

Operation that allows to change the user password

Headers

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

X-Invoker-AtmId: ATM code

X-Invoker-BranchId: Office code

X-Invoker-TerminalId: Term code

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-Country: Country

X-Invoker-SessionKey: Session key

X-Invoker-Source: Origin

X-Invoker-ProcessId: Process ID

X-Invoker-Network: Net

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

X-Invoker-User: User

X-Invoker-ReferencedNumber: Reference number

X-Invoker-ally: Ally

Body:

govIssueIdent: Identification given by the local government
   govIssueIdentType: Type of customer identification. (CC, CE, PA, TI, NI or PE)
   identSerialNum: Number customer Identification
custPswd: Current password
   cryptPswd: Encrypted password
subjectPswd: New Password
   cryptPswd: Encrypted password

Response information:

responseType: Used to return the response

> Response 201.

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

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the following structure.
{
    "responseType": {
        "value": "ER"
    },
    "responseDetail": {
        "errorCode": "1005",
        "errorDesc": "ERROR: autenticacion-La clave se encuentra bloqueada",
        "errorType": "OUD"
    }
}

> Diagram of sequence.

-Management User - Create User

Path:

POST

/security-management/v1/customer:

Operation that allows to create or recover the user's password

Headers

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

X-Invoker-AtmId: ATM code

X-Invoker-BranchId: Office code

X-Invoker-TerminalId: Term code

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-Country: Country

X-Invoker-SessionKey: Session key

X-Invoker-Source: Origin

X-Invoker-ProcessId: Process ID

X-Invoker-Network: Net

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

X-Invoker-User: User

X-Invoker-ReferencedNumber: Reference number

X-Invoker-ally: Ally

Body:

recuperationFlag: recuperationFlag information
   value: Password recovery indicator (S, N)
govIssueIdent: Identification given by the local government
   govIssueIdentType: Type of customer identification. (CC, CE, PA, TI, NI or PE)
   identSerialNum: Number customer Identification
infoPassword: password information
   password: Encrypted password

Response information:

responseType: Used to return the response

> Response 201.

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

> Errors response example.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the following structure.
{
    "responseType": {
        "value": "ER"
    },
    "responseDetail": {
        "errorCode": "00068",
        "errorDesc": "El usuario ya existe",
        "errorType": "OUD"
    }
}

> Errors Code.

> Diagram of sequence.

####

-User validation - enrollment

Path:

GET

/security-management/v1/customer/{identserialnum}/validate:

Operation get informtation about User for Digital enrollment

URIParameters:

identserialnum: User Identification Number

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-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

X-Invoker-ally: Ally

Headers Security

X-Security-CustLoginIdSi: 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

Query Parameters:

govIssueIdentType: Type of customer identification. (CC, CE, PA, TI, NI or PE)

acctType: Account type, this value it depending of kinds of product.

- **CCA**
- **DBC**

secretId: Pin TD or CVV TC

acctId: Last six digits

Response information:

responseType: Used to return the response

> Response 200.

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

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the following structure.
{
  "ResponseType": {
    "value": "ER"
  },
  "ResponseDetail": {
    "ErrorCode": "00068",
    "ErrorDesc": "Usuario ya existe.",
    "ErrorType": "OUD"
  }
}

> Diagram of sequence.

####

-Recover password validation

Path:

GET

/security-management/v1/customer/{identserialnum}/password:

Operation get informtation about User for Digital enrollment

URIParameters:

identserialnum: User Identification Number

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-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

X-Invoker-ally: Ally

Headers Security

X-Security-CustLoginIdSi: 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

Query Parameters:

govIssueIdentType: Type of customer identification. (CC, CE, PA, TI, NI or PE)

acctType: Account type, this value it depending of kinds of product.

- **CCA**
- **DBC**

secretId: Pin TD or CVV TC

acctId: Last six digits

Response information:

responseType: Used to return the response

> Response 200.

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

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the following structure.
{
  "ResponseType": {
    "value": "ER"
  },
  "ResponseDetail": {
    "ErrorCode": "00068",
    "ErrorDesc": "Usuario ya existe.",
    "ErrorType": "OUD"
  }
}

> Diagram of sequence.

####

-Request OTP With Purpose

Path [POST]

/security-management/v1/withdrawal/otp

Operation POST for request a unique OTP ID.

-Request Body

govIssueIdent:
    govissueidenttype: Contains information of Type of customer identification. (Required)
    identserialnum: Contains information related to user identification number. (Required)
xFerInfo:
    depAcctIdFrom:
        acctId: Contains information of account number. (Required)
    curAmt:
        amt: Contains information of value to send. (Required)
otc:
   idOtc: Unique OTC ID. (Required)

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 (Required)

X-Invoker-Country: Country

X-Invoker-ProcessBpmId: ID BPM process

X-Invoker-ProcessId: Process ID

X-Invoker-Network: Net

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

X-Invoker-ally: Ally

Headers Security

X-Security-CustLoginIdSi: Used to identify the user who logs in (Required)

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

> Example request.

{
  "govIssueIdent": {
    "govIssueIdentType": "CC",
    "identSerialNum": "235435435"
  },
  "xFerInfo": {
    "depAcctIdFrom": {
      "acctId": "2343454353"
    },
    "curAmt": {
      "amt": 20000
    }
  },
  "otc": {
    "idOtc": "001"
  }
}

Response information:

responseType:
    value: Response Value
otpInfo.
    otpValue: Contains information of Otp available to use at ATM.

> Example response 201.

 {
  "responseType":{
      "value":"OK"
  },
  "otpInfo":{
      "otpValue":"455667"
  }
}

> Example response Error.

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": "00001",
    "errorDesc": "NO EXISTE NUMERO DE PRESTAMO",
    "errorType": "RGN"
  }
}

> Errors codes

> Diagram of sequence.

####

-Request Password Status

Path [POST]

Operation POST for request update password status.

/security-management/v1/customer/password/status

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-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

X-Invoker-ally: Ally

Headers Security

X-Security-CustLoginIdSi: 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

-Request Body

govIssueIdent:
    govIssueIdentType: Contains information of Type of customer identification. (Required) [CC, CE, PA, TI, NI, PE]
    identSerialNum: Contains information related to user identification number. (Required)
personName:
    user: Contains information of User (Optional)
custPswd:
    status: Contains information of Status. (Required) [Active: 1, Locked: 3]

> Example request.

{
    "govIssueIdent": {
        "govIssueIdentType": "CC",
        "identSerialNum": "1007641"
    },
    "personName": {
        "user": ""
    },
    "custPswd": {
        "status": "Active"
    }
}

Response information:

responseType:
    value: Response Value
status:
    statusDesc: Contains information of status Description.
    endDt: Contains information of endDt.

> Example response 201.

{
    "responseType": {
        "value": "OK"
    },
    "status": {
        "statusDesc": "Cambio estado clave de usuario Exitosa.",
        "endDt": "2023-06-23-12:57:48.941"
    }
}

> Example response Error.

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": "32",
        "errorDesc": "El usuario no existe",
        "errorType": "RGN"
    }
}

> Errors codes

- Consult Channel

Description:

This service allows consult channel status

Path:

GET /security-management/v1/channelholds/{identSerialNum}:

Request Data:

Headers:

Request Params:

Response Body:

Success Response Example:

{
    "responseType": {
        "value": "OK"
    },
    "trnSrcInfo": {
        "resultsPagesGeneric": {
            "totalRecords": "0000",
            "recordsXPage": "02"
        },
        "blockingInfo": [
            {
                "channel": "007",
                "subChannel": "00",
                "type": "Unlock",
                "status": "Product",
                "acctId": "1354164141",
                "user": "INTERNET",
                "branchId": "321102",
                "establishDt": "2024-05-20 11.24.21 AM",
                "unblockingInfo": {
                    "user": "INTERNET",
                    "branchId": "321102",
                    "establishDt": "2024-05-22 01.05.59 AM"
                }
            },
            {
                "channel": "015",
                "subChannel": "00",
                "type": "Unlock",
                "status": "Product",
                "acctId": "1354164141",
                "user": "INTERNET",
                "branchId": "321102",
                "establishDt": "2024-05-07 08.44.40 AM",
                "unblockingInfo": {
                    "user": "",
                    "branchId": "",
                    "establishDt": ""
                }
            }
        ]
    }
}

Response Error Example:

{
    "responseType": {
        "value": "ER500"
    },
    "responseDetail": {
        "errorCode": "",
        "errorDesc": "",
        "errorType": ""
    }
}

Diagram of sequence

- Lock-Unlock Channel

Description:

This service allows Lock/Unlock channel

Path:

POST /security-management/v1/channelholds:

Request Data:

Headers:

Request Body:

Success Response Example:

{
    "trnSrcInfo": {
        "blockingInfo": {
            "identSerialNum": "38250250",
            "govIssueIdentType": "CC",
            "channel": "007",
            "subChannel": "00",
            "acctId": "1354164141",
            "channelDesc": "",
            "action": "Unlock",
            "type": "Product",
            "user": "INTERNET",
            "branchId": "321102"
        }
    }
}

Response Body:

Success Response Example:

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

Response Error Example:

{
    "responseType": {
        "value": "ER500"
    },
    "responseDetail": {
        "errorCode": "",
        "errorDesc": "",
        "errorType": ""
    }
}

Diagram of sequence

-Management Reto - Authentication Level

Path:

POST

/reto-management/v1/authentication-level

The operation that allows consulting authentication level

Headers

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

X-Invoker-AtmId: ATM code

X-Invoker-BranchId: Office code

X-Invoker-TerminalId: Term code

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-Country: Country

X-Invoker-SessionKey: Session key

X-Invoker-Source: Origin

X-Invoker-ProcessId: Process ID

X-Invoker-Network: Net

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

X-Invoker-User: User

X-Invoker-ReferencedNumber: Reference number

X-Invoker-ally: Ally

Body:

{
  "transaction": {
    "processDate": "020-05-26 14:23:12.713290",
    "workingDayFrame": "N",
    "govIssueIdent": {
      "govIssueIdentType": "CC",
      "identSerialNum": "1030"
    },
    "requestNumber": "257896",
    "adviser": {
      "govIssueIdentType": "CC",
      "identSerialNum": "1025"
    },
    "trnRqUID": "101261",
    "authSystem": "SIEBEL"
  }
}

Response information:

responseType: Used to return the response

> Response 200.

{
  "responseType": {
      "value": "OK"
  },
  "transaction": {
    "govIssueIdent": {
      "govIssueIdentType": "CC",
      "identSerialNum": "1030"
    },
    "requestNumber": "257896",
    "desc": "CANCELACI¿¿N TARJETA CR¿¿DITO",
    "trnRqUID": "101261",
    "authLevel": "3"
  }
}

> Errors response example.

Aside from the error codes of the APIKit this resource only response on error code 206 for IVR channel.
{
    "responseType": {
        "value": "ER"
    },
    "responseDetail": {
        "errorCode": "100",
        "errorDesc": "TX NO PARAMETRIZADA",
        "errorType": ""
    }
}

-Reto Management - Authentication channel

Path:

POST

/reto-management/v1/authentication-channel

The operation that allows consulting authentication level

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

Authorization: Used to send a valid OAuth 2 access token

Body:

{
  "transaction": {
    "workingDayFrame": "N",
    "cityId": "",
    "type": "R",
    "trnRqUID": "900006",
    "productId": "",
    "txId": "API429",
    "govIssueIdent": {
      "govIssueIdentType": "CC",
      "identSerialNum": "51901591"
    },
    "trnSrcInfo": {
      "requestNumber": "1234",
      "requestType": ""
    },
    "personInfo": {
      "firstName": "ROSA",
      "middleName": "GRICELDA",
      "lastName": "",
      "secondLastName": "",
      "personType": "N"
    },
    "question": {
      "quantity": 0
    },
    "trace": {
      "iteration": {
        "value": 4
      },
      "retry": {
        "value": 1
      }
    },
    "questionList": [
      {
        "type": "S",
        "code": "202010081614324767771",
        "value": "Usted como titular de su tarjeta debito tiene asignada una tarjeta amparada vigente a alguna persona",
        "desc": "",
        "length": 2,
        "format": "N",
        "answerList": [
          {
            "statusCode": "A",
            "value": "SI"
          }
        ]
      }
    ]
  }
}

Response information:

responseType: Used to return the response

> Response 200.

{
  "responseType": {
    "value": "OK"
  },
  "transaction": {
    "govIssueIdent": {
      "govIssueIdentType": "CC",
      "identSerialNum": "51901591"
    },
    "trnSrcInfo": {
      "requestNumber": "1234"
    },
    "question": {
      "quantity": 0
    },
    "trace": {
      "iteration": {
        "value": 0
      },
      "retry": {
        "value": 0
      }
    },
    "authorization": {
      "value": "SI",
      "code": "23F3D2C7BE98187C6D8F417AE243D0DCCE2DFBF0900006API429        20240530095353959000"
    },
    "reason": "",
    "questionList": [
      {
        "type": "S",
        "code": "202007161835353254834",
        "value": "?Tiene usted cuenta corriente vigente con el banco caja social?",
        "desc": "",
        "length": 2,
        "format": "N",
        "answerList": [
          {
            "statusCode": "A",
            "value": "SI"
          }
        ]
      }
    ]
  }
}

> Errors response example.

Aside from the error codes of the APIKit this resource only response on error code 206 for IVR channel.
{
    "responseType": {
        "value": "ER"
    },
    "responseDetail": {
        "errorCode": "100",
        "errorDesc": "TX NO PARAMETRIZADA",
        "errorType": ""
    }
}

- Retiro OTP

Description:

This service allows withdrawal otp

Path:

POST: /api/security-management/v3/withdrawal/otp:

Request Data:

Headers:

Request Body:

Request Example:

{
  "trn": {
    "transactionHour": "15:37:59",
    "trnRqUID": "017269",
    "code": "0000000059",
    "branchName": "MI OFICINA BETTY",
    "cityId": "25386",
    "city": "LA MESA",
    "stateProv": "25",
    "depAcctIdFrom": {
      "acctId": "83000109863"
    },
    "otp": {
      "type": "Normal",
      "curAmt": {
        "amt": 1000000
      },
      "otpValue": "f3TCdCsRp8MO/VjFQ==",
      "govIssueIdent": {
        "identSerialNum": "1028780657"
      }
    }
  }
}

Response Body:

Success Response Example:

{
  "responseType": {
    "value": "OK"
  },
  "trn": {
    "approvalId":"224671",
    "depAcctId": {
      "acctId": "26500084997",
      "acctType": "AHORROS"
    }
  }
}

Response Error Example:

{
    "responseType": {
        "value": "ER"
    },
    "responseDetail": {
        "errorCode": "05620",
        "errorDesc": "NO EXISTE NMERO DE CUENTA",
        "errorType": "RGN"
    }
}

Diagram of sequence.

Create Transation Challenge V2 Questions :

NOTE: Only for PROD (Env):
Consider the policy which validates the header [x-forwarded-for] with the policy :
(Consider requesting to add the IP or IP range)

Description:

Operation that allows the creation of challenge rules to obtain the authorization number oriented to questions list .

Path:

POST /reto-management/v2/customer

Request Data:

Headers:

Mapping Request

Request Example 1 :

{
    "clientType": {
      "value": "N"
    },
    "govIssueIdent": {
      "govIssueIdentType": "CC",
      "identSerialNum": "111111"
    },
    "requestType": {
      "value": "P"
    },
    "tx": {
      "id": "100090",


      "txData": [
        {
          "name": "NOMBRE_COMERCIO",
          "value": "COLEGIO JONATHAN SWIFT"
        },
        {
          "name": "TERMINAL_COMERCIO",
          "value": "5555555555555"
        },
        {
          "name": "CODIGO_COMERCIO",
          "value": "1111111111111"
        },
        {
          "name": "REFERENCIA_PAGO_PSE",
          "value": "1356978413820"
        },
        {
          "name": "CODIGO_CONVENIO",
          "value": "PSE"
        }
      ],
       "amt": "10000",
       "sourceAccountNumber": "222222"
    }
  }

Request Example 2 :

 {
  "clientType": {
    "value": "N"
  },
  "govIssueIdent": {
    "govIssueIdentType": "CC",
    "identSerialNum": "111111"
  },
  "requestType": {
    "value": "R"
  },
  "tx": {
    "id": "100090",

   "txData": [
        {
          "name": "NOMBRE_COMERCIO",
          "value": "COLEGIO JONATHAN SWIFT"
        },
        {
          "name": "TERMINAL_COMERCIO",
          "value": "5555555555555"
        },
        {
          "name": "CODIGO_COMERCIO",
          "value": "1111111111111"
        },
        {
          "name": "REFERENCIA_PAGO_PSE",
          "value": "1356978413820"
        },
        {
          "name": "CODIGO_CONVENIO",
          "value": "PSE"
        }
      ],
       "amt": "10000",
       "sourceAccountNumber": "222222"

  },
  "trace": {
    "iteration": {
      "value": "2"
    },
    "retry": {
      "value": "1"
    }
  },
  "question": {
    "quantity": "1"
  },
  "questionList": [
    {
      "question": {
        "type": "M",
        "id": "202410181111029014581",
        "value": "Por favor ingrese el código de 6 dígitos enviado a su correo electrónico y/o teléfono celular registrados.",
        "length": "6",
        "answer": {
          "value": "5F306FE167BF6FB2F805B0BFF3E8C020"
        }
      }
    }
  ]
}

Request Example 3 :

 {
  "clientType": {
    "value": "N"
  },
  "govIssueIdent": {
    "govIssueIdentType": "CC",
    "identSerialNum": "111111"
  },
  "requestType": {
    "value": "R"
  },
  "trace": {
    "iteration": {
      "value": "3"
    },
    "retry": {
      "value": "1"
    }
  },
  "tx": {
    "id": "100090",
    "amt": "10000",
    "sourceAccountNumber": "222222",
    "txData": [
        {
          "name": "NOMBRE_COMERCIO",
          "value": "COLEGIO JONATHAN SWIFT"
        },
        {
          "name": "TERMINAL_COMERCIO",
          "value": "5555555555555"
        },
        {
          "name": "CODIGO_COMERCIO",
          "value": "1111111111111"
        },
        {
          "name": "REFERENCIA_PAGO_PSE",
          "value": "1356978413820"
        },
        {
          "name": "CODIGO_CONVENIO",
          "value": "PSE"
        }
      ]
  },
  "question": {
    "quantity": "1"
  },
  "questionList": [
    {
      "question": {
        "type": "SM",
        "id": "202410181112571944582",
        "value": "¿Usted tiene tarjeta débito y es titular de la tarjeta? Seleccione una opción y digite la clave en caso de que su respuesta sea afirmativa.",
        "length": "4",
        "answer": {
          "id": "A",
          "value": "A8E6803C466D8F68B9856C0EE817D595"

        }
      }
    }
  ]
}

Mapping Response OK

Response Example 1 :

{
    "authorization": {
        "value": "TV",
        "code": null
    },
    "trace": {
        "iteration": {
            "value": "2"
        },
        "retry": {
            "value": "1"
        }
    },
    "questionList": [
        {
            "question": {
                "type": "M",
                "id": "202410181111029014581",
                "value": "Por favor ingrese el código de 6 dígitos enviado a su correo electrónico y/o teléfono celular registrados.",
                "desc": null,
                "length": "6",
                "format": "N",
                "answerList": [
                    {
                        "answer": {
                            "id": null,
                            "value": null
                        }
                    }
                ]
            }
        }
    ]
}

Response Example 2 :

{
    "authorization": {
        "value": "TV",
        "code": null
    },
    "trace": {
        "iteration": {
            "value": "3"
        },
        "retry": {
            "value": "1"
        }
    },
    "questionList": [
        {
            "question": {
                "type": "SM",
                "id": "202410181112571944582",
                "value": "¿Usted tiene tarjeta débito y es titular de la tarjeta? Seleccione una opción y digite la clave en caso de que su respuesta sea afirmativa. ",
                "desc": null,
                "length": "4",
                "format": "N",
                "answerList": [
                    {
                        "answer": {
                            "id": "A",
                            "value": " Sí tengo tarjeta débito "
                        }
                    },
                    {
                        "answer": {
                            "id": "B",
                            "value": " No tengo tarjeta débito"
                        }
                    }
                ]
            }
        }
    ]
}

Response Example 3 :

{
    "authorization": {
        "value": "SI",
        "code": "13581DA3A42EF77CA4ED35BA7BD022E8D6B480F5100090APII427032263281789 20241018111456456"
    }
}

##

Mapping Response Error