bcs-customers-management-api-services

API INFORMATION

Title: customers-management-api-service

Version: 1.0.0

Protocols: HTTPS

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

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

URILive: https://customers-management-api-services-prod.us-e1.cloudhub.io/api/customersManagement/v1

DOWLOAD RAML

DESCRIPTION

The API will offer consumers the creation of clients and at the same time the accounts, as well as the consultation of the basic information of the client, which allows the following operations:

Summary

-Create Customer and Account

Path:

/customer-account-management/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

Body :

govIssueIdent: Contains identification data

govIssueIdentType: ID Type.
identSerialNum: Identification number.

clientType: ClientType

value: Value.

personName: Contains information about the person

lastName: Last Name.
secondLastName: Second Last Name.
firstName: First Name.
middleName: Middle Name.

personInfo: Contains information about the person

expCityId: Code City issuance.
expDt: Date issuance.
birthDt: Date birth.
gender: Gender.
maritalStatus: Code marital status.
maritalDesc: Description marital status.
contactInfo:
 - emailAddr: Email address.
clientType:
 - name: Customer type.
income:
 - incomeAmt: Customer Salary.
otherIncome:
 - amt: Customer Other incomes.
 - name: Item per other revenue.
expense:
 - amt: Expense.
finalcialAssets:
 - amt: Total assets.
financialLiabilities:
 - amt: Total liabilities.
originResources: Origin Resources.
adminResources: Resource management.

contactInfo: Contains information about the contact

phoneNum:
 - phoneType: Type telephone number or residence.
 - phone: Personal Telephone Number.
additionalPhoneNum:
 - phoneType: Type Phone number additional.
 - phone: Phone number additional.
postAddr:
 - addr1: Payroll agreement address.
 - city: Description City Of Residence.
 - cityId: City Residence Code.
phoneNumResidence:
 - phoneType: Type Phone number residence.
 - phone: Phone number residence.
additionalPhoneNumResidence:
 - phoneType: Type Phone Number Additional Residence.
 - phone: Phone Number Additional Residence

naturalPerson: Contains information about the natural person

countryInfo: Description Country birth.
cityId: Code City birth.
city: Description City Of Residence.

entpr: Contains information.

govIssueIdent:
 - govIssueIdentType: ID Type.
 - identSerialNum: Identification number..

entprAgreement: Contains information.

entprDesc: Name Agreement.
postAddr:
 - addr1: Payroll agreement address.
phoneNum:
 - phoneType: Type telephone number or residence.
 - phone: Personal Telephone Number.
additionalPhoneNum:
 - phoneType: Type telephone number or residence.
 - phone: Personal Telephone Number.
branchId: Payroll Agreement Office Code.
cityId: Payroll agreement city code.
entprId: Payroll agreement code.

businessOcupation: Contains information about the business ocupation.

ocupationCode: Occupation code.
desc: Occupation Description

businessActivity: Contains information about the business activity.

businessType: Position.
certCode: Classification code.
desc: Description classification.

businessProfession: Contains information about the business profession.

certCode: Classification code.
desc: Description classification.

businessProfessionGeneral: Contains information about the business profession general.

certCode: Classification code.

businessProfessionSpecific: Contains information about the business profession specific.

certCode: Classification code.

pocketInfo: Contains information about the pocket info.

pocketType: Applies to pocket savings account.
pocketAmount: Savings amount.
pocketPeriod:
 - periodCode: Periodicity of savings.
dayofDebitMonthly: Day 1.
dayofDebitWeekly: Day 2.
curAmt:
 - amt: Savings amount.

product: Contains information about the product.

gmf: Applies 4x1000 dialing.
productId:
 - ledgerCode: Ledger.
 - subLedgerCode: Subledger.
 - groupCode: group.
productType: Type of account.
handlingFee: Profile handling fee.
sourceRetention: Source Retention.
extractPeriodicity: Extract period.
administrationOffice:
 - branchId: Office code.
submitOffice:
 - branchId: Administrative office code.
branchAddrType: Type of office address .
managementCondition: Management condition.
adviserId: User registration.

adviser: Contains information about the adviser.

adviserId: User registration.

Example of Body

{
  "govIssueIdent": {
"govIssueIdentType": "CC",
"identSerialNum": "1234567890"
  },
  "clientType": {
"value": "N"
  },
  "personName": {
    "lastName": "DE_FRANCISCO",
    "secondLastName": "LOPEZ",
    "firstName": "CARLOS",
    "middleName": "MARIO"
  },
  "personInfo": {
    "govIssueIdent": {
      "expCityId": "05001",
      "expDt": "2022-12-11"
    },
    "birthDt": "2022-12-11",
    "gender": "F",
    "maritalStatus": "S",
    "maritalDesc": "Soltero",
    "contactInfo": {
      "emailAddr": "correo@gmail.com"
    },
    "clientType": {
      "name": "11"
    },
    "income": {
      "incomeAmt": "25000000"
    },
    "otherIncome": {
      "amt": "25000000",
      "name": "Si"
    },
    "expense": {
      "amt": "25000000"
    },
    "finalcialAssets": {
      "amt": "25000000"
    },
    "financialLiabilities": {
      "amt": "25000000"
    },
    "originResources": "01",
    "adminResources": "N"
  },
  "contactInfo": {
    "phoneNum": {
      "phoneType": "T",
      "phone": "2767888"
    },
    "additionalPhoneNum": {
      "phoneType": "C",
      "phone": "3105556755"
    },
    "postAddr": {
      "addr1": "XXXXXXXXXXXX",
      "city": "Medellin",
      "cityId": "05001"
    },
    "phoneNumResidence": {
      "phoneType": "C",
      "phone": "3105556755"
    },
    "additionalPhoneNumResidence": {
      "phoneType": "C",
      "phone": "3105556755"
    }
  },
  "naturalPerson": {
    "countryInfo": "CO",
    "cityId": "05001",
    "city": "Medellin"
  },
  "entpr": {
    "govIssueIdent": {
      "govIssueIdentType": "CC",
      "identSerialNum": "1234567890"
    }
  },
  "entprAgreement": {
    "entprDesc": "Pagatodo",
    "postAddr": {
      "addr1": "XXXXXXXXXXXX"
    },
    "phoneNum": {
      "phoneType": "T",
      "phone": "2767888"
    },
    "additionalPhoneNum": {
      "phoneType": "C",
      "phone": "3105556755"
    },
    "branchId": "079",
    "cityId": "0112",
    "entprId": "056"
  },
  "businessActivity": {
    "businessType": "1130",
    "certCode": "54",
    "desc": "54"
  },
  "businessOcupation": {
    "ocupationCode": "01",
    "desc": "EMPLEADO"
  },
  "businessProfession": {
    "certCode": "19",
    "desc": "OFICINISTAS"
  },
  "businessProfessionGeneral": {
    "certCode": "019"
  },
  "businessProfessionSpecific": {
    "certCode": "0010"
  },
  "pocketInfo": {
    "pocketType": "S",
    "pocketPeriod": {
      "periodCode": "Q"
    },
    "dayofDebitMonthly": "02",
    "dayofDebitWeekly": "03",
    "curAmt": {
      "amt": "25000000"
    }
  },
  "product": {
    "gmf": "N",
    "productId": {
      "ledgerCode": "24",
      "subLedgerCode": "29",
      "groupCode": "85"
    },
    "productType": "500",
    "handlingFee": "500",
    "sourceRetention": "N",
    "extractPeriodicity": "M",
    "administrationOffice": {
      "branchId": "1102"
    },
    "submitOffice": {
      "branchId": "112"
    },
    "branchAddrType": "P",
    "managementCondition": "100",
    "adviserId": "100"
  },
  "adviser": {
    "adviserId": "A1B2ADIG"
  }
}

Response information:

depAcctStmtRec: Contains information.

depAcctId:
 - refNumber: Request number.
 - acctId: Account number.
 - gmf: GMF Status.
 - gmfAccountNumber: Account.
 - gmfDesc: Account.
bankInfoGmf:
 - bankInfoGmf:
  - name: Bank (Financial entity where the account is marked as GMF).

pocketInfo: Contains information.

pocketType: Bank (Financial entity where the account is marked as GMF).

Example of Body to Response Successfull

{
  "depAcctStmtRec": {
    "depAcctId": {
      "refNumber": "1-203123456",
      "acctId": "24567890123",
      "gmf": "OK",
      "gmfAccountNumber": "Marcada en otra ent",
      "gmfDesc": "000123456"
    },
    "bankInfoGmf": {
      "bankInfoGmf": {
        "name": "Banco de Bogota"
      }
    }
  },
  "pocketInfo": {
    "pocketType": "SI"
  }
}

-Check Basic Customer Information

Path:

/customerAccountManagement/v1/BasicData:

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

Query parameters

mnemonic: User Identification Type + Identification Number (Required)

Response information:

responseType: Used to return the response

personName: Used to display the client's name

personInfo: It is used to display the customer's date of birth.

OrgId: ADD_ME

postAddr: ADD_ME

govIssueIdent: Used to user identification number and User ID Type

contactInfo: ADD_ME

> 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": "00001",
        "errorDesc": "NO ENCONTRO NINGUN REGISTRO",
        "errorType": "DAT"
    }
}

> Diagram of sequence.

####

-Check Basic Customer Information

Path:

/customerAccountManagement/v2/basicData:

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

Query parameters

mnemonic: User Identification Type + Identification Number (Required)

Response information:

responseType: Used to return the response

fullName: Business name or full name

firstName: Names

lastName: Surnames

birthDt: Date of birth

orgIdType: Type of organization document

orgIdNum: Organization document number

addr1: Address or Business Address

city: City

stateProv: State province

country: Country

govIssueIdentType: Type Identification

identSerialNum: Identification number

emailAddr: Email

phone: Phone number

phone: Cell phone number

> 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": "00001",
        "errorDesc": "NO ENCONTRO NINGUN REGISTRO",
        "errorType": "DAT"
    }
}

> Diagram of sequence.

####

Path:

/customerAccountManagement/v4/basicData:

Headers

X-Invoker-Channel: Channel

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

X-Invoker-BranchId: Office code

X-Invoker-UserIPAddress: Client IP Address

X-Invoker-ServerIPAddress: Server IP Address

X-Invoker-SessionKey: Session key

X-Invoker-Country: Country

X-Invoker-Network: Net

X-Invoker-User: User

X-Invoker-UserMACAddress: Client MAC Address

X-Invoker-ServerMACAddress: Server MAC Address

X-Invoker-TxId: Id TX

X-Invoker-ProcessDate: Process date

X-Invoker-ATMId: ATM Code

X-Invoker-TerminalId: Term code

X-Invoker-Component: Component

X-Invoker-Source: Origin

X-Invoker-ProcessId: Process ID

X-Invoker-ProcessBpmId: ID BPM process

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

Query parameters:

govIssueIdentType: User Identification Type (Required if cellphone was not provided)

identSerialNum: User Identification Number (Required if cellphone was not provided)

cellphone: User cellphone (Required if govIssueIdentType and identSerialNum were not provided)

Request example:

Example with CellPhone:
/customerAccountManagement/v4/basicData?cellphone=1234567890
Example with govIssueIdentType and identSerialNum:
/customerAccountManagement/v4/basicData?govIssueIdentType=CC&identSerialNum=1234567890

Response:

{
  "responseType": {
      "value": "OK"
  },
  "personInfo": {
    "govIssueIdent": {
      "govIssueIdentType": "CC",
      "identSerialNum": "1234567890"
    },
    "fullName": "JEIMY VANESSA INTENCIPA BONILLA",
    "cellPhone": "1234567890",
    "personName": {
      "firstName": "JEIMY",
      "middleName": "VANESSA",
      "lastName": "INTENCIPA",
      "secondLastName": "BONILLA"
    },
    "createDt":"2003-02-22",
    "upDt": "2010-09-26",
    "personType":"54",
    "sarlaDt":"2010-02-10",
    "deceasedDt":"",
    "birthDt":"1967-08-27",
    "contactInfo":{
      "emailAddr":"prueba11@fs.net",
      "cellPhone":"3200000002"
    },
    "flagAlert":"N",
    "flagExist":"s/",
    "status": "",
    "postAddr":[
      {
        "postalCode": "2439966",
        "addrType": "03",
        "addr1": "CL 9 A SUR 1 74 ESTE",
        "stateProv":"63000",
        "cityId":"63401"
      }
    ]
  }
}

Error code:

-Get customer name by account

Path:

/customer-management/customer/identserialnum/{identserialnum}/acctid/{acctid}:

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

UriParams:

identserialnum: Identification number

acctid: Identifier of an account or product

QueryParameter:

govIssueIdentType: Type of customer identification.

Response information:

custInfo: Contains information about the client

**personName**:**  Specify customer name
    **fullName**:** Full name of a person

> Example response.

{
  "custInfo":{
    "personName": {
      "fullName": "SOLANGEL BALBINA VIANCHA VIANCHA"
    }
  }
}

> 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": "00001",
        "errorDesc": "NO ENCONTRO NINGUN REGISTRO",
        "errorType": "DAT"
    }
}

> Diagram of sequence.

####

-Get Customer Locations.

Description: This resource returns the Customer Locations.

Path:

GET /customer-management/v1/location/{identserialnum}

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

URI parameters

identserialnum: Customer Identification Number.

Query parameters

govIssueIdentType: Type of customer identification (

CC: Citizenship Card,

CE: Immigration ID,

PA: Passport,

IT: Identity card,

NI: NIT,

PE: Special Stay Permit (for Venezuelans)).

action: Action (I:Integrals(default for queries),T:Transformed)

condition: Condition (1:Current(default for queries),2:Expired,3:All)

Response information:

responseType: Response type object
 value: Response type value (OK, ER)
govIssueIdent: Customer identification object
  fullName: Customer full name
  personType: Person Type (N-persona natural, J-persona jurídica)
  postAddr: Array of Locations
    addrType: Location type object
      code: Location code (03-Residencia,04-Oficina)
      desc: Location description (03 - “RESIDENCIA”, 04 – “OFICINA”)
    neighborhood: Neighborhood
    addr1: Location address
    city: Location city object
      code: Location city code
      desc: Location city description
    stateProv: Location Department object
      code: Department code
      desc: Department description
    processId: Location record identifier
    conditionInfo: Location status object
      code: Location status code (V: Vigente o N: No vigente)
      desc: Location status description
    idItem: Location Id
    phoneNum: Array of Phone Numbers
      phoneType: Phone type object
        code: Phone type (ADI-Teléfono Adicional, CEL-Teléfono Celular)
        desc: Phone description
      cellPhone: Phone number
      processId: Phone record identifier
      idItem: Phone Id
      conditionInfo: Phone status object
        code: Phone status code
        desc: Phone status description
      phoneExt: Phone extension
      mobileOperator: Operator
      city:
        code: Location phone city object
        desc: Location phone city description
      desc: Comment
      role: Current phone role
      roleNew: New phone role
    role: Current location role
    roleNew: New location role
    cardAcctId: Credit card location object
      addr1: Credit card location Id
    createdDt: Location created date
    upDt: Location updated date
    user: Location created user
    modifierUser: Location updated user
    submitOffice: Location created office object
      branchId: Location created office
    administrationOffice: Location updated office object
      branchId: Location updated office
  emailFromInfo: Email Address Array
    idItem: Email Id
    processId: Email record identifier
    emailAddr: Email address
    condition: Email status (V: Vigente o N: No vigente)
  phoneNum: Array of Phone Numbers
    phoneType: Phone type object
      code: Phone type (ADI-Teléfono Adicional, CEL-Teléfono Celular)
      desc: Phone description
    cellPhone: Phone number
    processId: Phone record identifier
    idItem: Phone Id
    conditionInfo: Phone status object
      code: Phone status code
      desc: Phone status description
    phoneExt: Phone extension
    mobileOperator: Operator
    city: Phone city object
      code: Phone city object
      desc: Phone city description
    desc: Comment
    role: Current phone role
    roleNew: New phone role

> Response Example.

{
  "responseType": {
    "value": "OK"
  },
  "govIssueIdent":{
    "fullName":"JOAQUIN MARIO DUARTE IREGUI",
    "personType":"N",
    "postAddr": [
      {
        "addrType": {
          "code":"01",
          "desc":""
        },
        "neighborhood":"SANTA BARBARA ORIENT",
        "addr1":"CL 126 7 C 23",
        "city": {
          "code":"11001",
          "desc":""
        },
        "stateProv":{
          "code":"11000",
          "desc":""
        },
        "processId":"AAAMEuAAMAABJXdAAn",
        "conditionInfo":{
          "code":"V",
          "desc":""
        },
        "idItem":"69808125",
        "phoneNum":[
          {
            "phoneType":{
              "code":"",
              "desc":""
            },
            "cellPhone":"4309903",
            "processId":"AAALWvAAMAABKSsAAH",
            "idItem":"",
            "conditionInfo":{
              "code":"",
              "desc":""
            },
            "phoneExt":"",
            "mobileOperator":"",
            "city": {
              "code":"",
              "desc":""
            },
            "desc":"",
            "role":"",
            "roleNew":""
          },
              {
            "phoneType":{
              "code":"",
              "desc":""
            },
            "cellPhone":"4309903",
            "processId":"AAALWvAAMAABKSsAAI",
            "idItem":"",
            "conditionInfo":{
              "code":"",
              "desc":""
            },
            "phoneExt":"",
            "mobileOperator":"",
            "city": {
              "code":"",
              "desc":""
            },
            "desc":"",
            "role":"",
            "roleNew":""
          }
        ],
        "role":"",
        "roleNew":"",
        "cardAcctId":{
          "addr1":""
        },
        "createdDt":"20170323",
        "upDt":"20230302",
        "user":"L4R7F6O5",
        "modifierUser":"BGRQA084",
        "submitOffice":{
          "branchId":"320020"
        },
        "administrationOffice":{
          "branchId":"320166"
        }
      },
        {
        "addrType": {
          "code":"04",
          "desc":""
        },
        "neighborhood":"LA PEPITA",
        "addr1":"KR 22 06 32",
        "city": {
          "code":"11001",
          "desc":""
        },
        "stateProv":{
          "code":"11000",
          "desc":""
        },
        "processId":"AAAMEuAAMAAD6WDAAs",
        "conditionInfo":{
          "code":"V",
          "desc":""
        },
        "idItem":"69915910",
        "phoneNum":[
          {
            "phoneType":{
              "code":"",
              "desc":""
            },
            "cellPhone":"0",
            "processId":"AAALWvAAMAAHi3iAAZ",
            "idItem":"",
            "conditionInfo":{
              "code":"",
              "desc":""
            },
            "phoneExt":"",
            "mobileOperator":"",
            "city": {
              "code":"",
              "desc":""
            },
            "desc":"",
            "role":"",
            "roleNew":""
          },
              {
            "phoneType":{
              "code":"",
              "desc":""
            },
            "cellPhone":"",
            "processId":"",
            "idItem":"",
            "conditionInfo":{
              "code":"",
              "desc":""
            },
            "phoneExt":"",
            "mobileOperator":"",
            "city": {
              "code":"",
              "desc":""
            },
            "desc":"",
            "role":"",
            "roleNew":""
          }
        ],
        "role":"",
        "roleNew":"",
        "cardAcctId":{
          "addr1":""
        },
        "createdDt":"20201021",
        "upDt":"20230302",
        "user":"BASQA083",
        "modifierUser":"BGRQA084",
        "submitOffice":{
          "branchId":"320166"
        },
        "administrationOffice":{
          "branchId":"320166"
        }
      }
    ],
    "emailFromInfo":[
      {
        "idItem":"51415268",
        "processId":"AAALWtAAGAAAIMsAAZ",
        "emailAddr":"j7l8a5o1@bancocajasocial.com",
        "condition":"V"
      },
        {
        "idItem":"",
        "processId":"",
        "emailAddr":"",
        "condition":""
      }
    ],
    "phoneNum":[
      {
        "phoneType":{
          "code":"ADI",
          "desc":""
        },
        "cellPhone":"0",
        "processId":"AAALWvAAMAAHi3iAAZ",
        "idItem":"",
        "conditionInfo":{
          "code":"",
          "desc":""
        },
        "phoneExt":"",
        "mobileOperator":"",
        "city": {
          "code":"",
          "desc":""
        },
        "desc":"",
        "role":"",
        "roleNew":""
      },
      {
        "phoneType":{
          "code":"CEL",
          "desc":""
        },
        "cellPhone":"3124567891",
        "processId":"AAALWvAAMAAHi3iAAa",
        "idItem":"69539616",
        "conditionInfo":{
          "code":"V",
          "desc":""
        },
        "phoneExt":"",
        "mobileOperator":"",
        "city": {
          "code":"",
          "desc":""
        },
        "desc":"",
        "role":"",
        "roleNew":""
      }
    ]
  }
}

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or business errors and all errors used the following structure.
{
  "responseType": {
    "value": "ER"
  },
  "responseDetail": {
    "errorCode": "51011",
    "errorDesc": "CC79603562 12417384CLIENTE NO EXISTE BCSCPKGCONTABLESPJ",
    "errorType": "BDE"
  }
}

> Diagram of sequence.

####

####

Error codes.

-Updata Personal Secure Data Management.

Description: This resource allows to update the personal secure data management.

Path:

PUT /customer-management/v1/secure-data

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

Body

govIssueIdent: Customer Identification Object
  identSerialNum: Customer Identification Number.
  govIssueIdentType: Type of customer identification ( CC: Citizenship Card, CE: Immigration ID, PA: Passport, IT: Identity card, NI: NIT, PE: Special Stay Permit (for Venezuelans)).
administrationOffice: Administration Office Object
  branchId: Office code from which the record was created.
submitOffice: Submit Office Object
  branchId: Office code from which the transaction originates.
compliance: Array of questions
  question: Name of the service question element (enum preguntaATDP001, preguntaATDP002, preguntaATDP003)
  answer: Answer to the question (true: Sí, false: No)

Response information:

> Response 200.

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

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or business errors and all errors used the following structure.
{
  "responseType": {
    "value": "ER"
  },
  "responseDetail": {
    "errorCode": "50099",
    "errorDesc": "12413622ERROR NO TRATADOPKGPROTECCIONDATOSPRPUTCREMODD",
    "errorType": "BDE"
  }
}

> Diagram of sequence.

####

####

Error codes.

####

-Get Customer Data Information.

Description: This resource returns the Customer Contact and Financial Data.

Path:

GET customer-management/v1/channel/contact/{identserialnum}

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

URI parameters

identserialnum: Customer Identification Number.

Query parameters

govIssueIdentType: Type of customer identification (

CC: Citizenship Card,

CE: Immigration ID,

PA: Passport,

IT: Identity card,

NI: NIT,

PE: Special Stay Permit (for Venezuelans)).

Response information:

responseType: Response type object
  value: Response type value (OK, ER)
postAddr: Residence Address Object
  cityId: City Id
  neighborhood: Neighborhood
  addr1: Location description
  phoneNum: Phone Object
    phone: Phone number
orgInfo: Office Address Object
  cityId: City Id
  neighborhood: Neighborhood
  addr1: Location description
  phoneNum: Phone Object
    phone: Phone number
    phoneExt: Phone extension
businessOccupation: Business Main Occupation Object
  code: Business Main Occupation Code
businessProfessionGeneral: Business General Occupation Object
  code: Business General Occupation Code
businessProfessionSpecific: Business Specific Occupation Object
  code: Business Specific Occupation Code
incomeInfo: Income Object
  incomeAmt: Montly Income Amount
expenses: Expenses Object
  amt: Montly Expenses Amount
financialAssets: Assets Object
  amt: Assets Amount
financialLiabilities: Liabilities Object
  amt: Liabilities Amount
familyHeritage: Family Heritage Object
  amt: Family Heritage Amount
personInfo: Penson Info Object
  birthDt: Birth date
  gender: Gender
  sarlaftDate: Salraft Data
  flagNoBindable: Flag Customer Not Bindable

> Response Example.

{
    "responseType": {
        "value": "OK"
    },
    "postAddr": {
        "cityId": "68307",
        "neighborhood": "CHAPINERO CENTRAL",
        "addr1": "CL 43 23 57",
        "phoneNum": {
            "phone": "2000002"
        }
    },
    "orgInfo": {
        "cityId": "41551",
        "neighborhood": "NA",
        "addr1": "PITALITO OF",
        "phoneNum": {
            "phone": "3000002",
            "phoneExt": "123"
        }
    },
    "businessOccupation": {
        "code": "04"
    },
    "businessProfessionGeneral": {
        "code": "010"
    },
    "businessProfessionSpecific": {
        "code": "6513"
    },
    "incomeInfo": {
        "incomeAmt": "4510000.00"
    },
    "expenses": {
        "amt": "651000.00"
    },
    "financialAssets": {
        "amt": "6100000.00"
    },
    "financialLiabilities": {
        "amt": "6200000.00"
    },
    "familyHeritage": {
        "amt": "6300000.00"
    },
    "personInfo": {
        "birthDt": "1971-11-22",
        "gender": "M",
        "sarlaftDate": "2023-05-12",
        "flagBindable": false
    }
}

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or business errors and all errors used the following structure.
{
  "responseType": {
    "value": "ER"
  },
  "responseDetail": {
    "errorCode": "51011",
    "errorDesc": "CLIENTE NO EXISTE BCSC",
    "errorType": "STA"
  }
}

> Diagram of sequence.

####

####

Error codes.

- POST Sync Data - Recurring Intake.

Description:

This service allows you to add a BCS Legal Entity to BackBase.

Path:

POST: /v1/sync-data

Headers:

Body:

> Mapping request:

> Request Example:

{
  "personName": {
    "firstName": "SARA"
  },
  "invoker": {
    "refType": "retail",
    "channel": "CUSTOMER"
  },
  "govIssueIdent": {
    "mNemonic": "CC123456789"
  },
  "custInfo": [
    {
      "personName": {
        "fullName": "Sara Jones",
        "titlePrefix": "Miss",
        "gender": "F",
        "birthDt": "2022-12-11",
        "country": "Colombia",
        "language": "ES-CO"
      },
      "contactInfo": {
        "emailAddr": "sara@email.com",
        "phoneNumber": "3105556755"
      },
      "postAddress": [
        {
          "addr1": "XXXXXXXXXXXX",
          "stateProv": "Cundinamarca",
          "country": "Colombia",
          "addrType": "Home",
          "priority": true
        }
      ],
      "strategies": {
        "strategyType": "IMPORT_FROM_IDENTIY"
      },
      "additionalEmaillAddr": [
        {
          "emailAddr": "sara33@email.com"
        }
      ],
      "additionalPhoneNum": [
        {
          "phoneNumber": "3105556755"
        }
      ],
      "invoker": {
        "role": "Retail User - COL"
      }
    }
  ],
  "listAccounts": [
    {
      "acctType": "CIA",
      "externalId": "21002776223-DDA-CTA",
      "depAcctId": {
        "acctId": "21002776223"
      },
      "cardAcctId": {
        "acctId": "",
        "lastDigits": ""
      },
      "nickname": "Cuenta Corriente",
      "name": "Cuenta Corriente",
      "product": {
        "productType": "21-02-00"
      },
      "curCode": "COP",
      "bankId": "111000025",
      "xferRec": {
        "externalXferRec": true,
        "immediateXfer": true,
        "flagDebit": true,
        "flagCredit": true
      },
      "acctBal": {
        "curCode": "COP",
        "amt": 734683.16
      },
      "LOCLimit": {
        "curCode": "COP",
        "amt": 734683.16
      },
      "otherIncome": {
        "curCode": "COP",
        "amt": 734683.16
      },
      "curRate": "1",
      "termUnits": "Monthly",
      "minPmtCurAmt": {
        "amt": 1,
        "dueDt": "2022-10-14"
      }
    }
  ]
}

> Response Example:

{
  "transaction": {
    "message": "added successfully"
  },
  "responseType": {
    "value": "OK"
  }
}

> Response Error Example:

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": "ER500"
    },
    "responseDetail": {
        "errorCode": "common.api.shoesize",
        "errorDesc": "Value Exceeded. Must be between {min} and {max}",
        "errorType": ""
    }
}

Errors Code:

Diagram of sequence.

- POST Sync Data From File - Recurring Intake.

Description:

This service allows you to add a BCS legal entity base64 file to BackBase.

Path:

POST: /v1/sync-data-file

Headers:

Body:

> Mapping request:

> Request Example:

{
  "file": {
    "binData": "{
    "personName": {
        "firstName": "DIONICIO"
    },
    "invoker": {
        "refType": "retail",
        "channel": "CUSTOMER"
    },
    "govIssueIdent": {
        "mnemonic": "CC8783172"
    },
    "custInfo": [
        {
            "personName": {
                "fullName": "DIONICIO SADY SUANCHA TUTA",
                "titlePrefix": "",
                "gender": "M",
                "birthDt": "",
                "country": "Colombia",
                "language": "nl-NL"
            },
            "contactInfo": {
                "emailAddr": "CC8783172@bancocajasocial.com",
                "phoneNumber": "3400000004"
            },
            "postAddress": [
                {
                    "addr1": "KR 4 B 52 B 21 SUR CHAMBU",
                    "stateProv": "BUGA",
                    "country": "Colombia",
                    "addrType": "Home",
                    "priority": true
                }
            ],
            "strategies": {
                "strategyType": "CREATE_IN_IDENTITY"
            },
            "additionalEmaillAddr": [
            ],
            "additionalPhoneNum": [
                {
                    "phoneNumber": "3400000004"
                }
            ],
            "invoker": {
                "role": "Retail User - COL"
            }
        }
    ],
    "listAccounts": [
        {
            "acctType": "SDA",
            "externalId": "24517578393-SDA-AHO",
            "depAcctId": {
                "acctId": "24517578393"
            },
            "cardAcctId": {
                "acctId": "",
                "lastDigits": ""
            },
            "nickname": "Cuenta de Ahorros",
            "name": "Cuenta de Ahorros",
            "product": {
                "productType": "24-11-00"
            },
            "curCode": "COP",
            "bankId": "32",
            "xferRec": {
                "externalXferRec": true,
                "immediateXfer": false,
                "flagDebit": true,
                "flagCredit": true
            },
            "acctBal": {
                "curCode": "COP",
                "amt": 0.0
            },
            "LOCLimit": {
                "curCode": "COP",
                "amt": 0.0
            },
            "otherIncome": {
                "curCode": "COP",
                "amt": 0.0
            },
            "curRate": "0",
            "termUnits": "Monthly",
            "minPmtCurAmt": {
                "amt": 0,
                "dueDt": ""
            }
        },
        {
            "acctType": "CCA",
            "externalId": "f46b28aa29fc16e81895b73f43d8b35b-CCA-TCR",
            "depAcctId": {
                "acctId": "489444******9850"
            },
            "cardAcctId": {
                "acctId": "489444******9850",
                "lastDigits": "9850"
            },
            "nickname": "Platinum",
            "name": "Platinum",
            "product": {
                "productType": "489444-01-00"
            },
            "curCode": "COP",
            "bankId": "",
            "xferRec": {
                "externalXferRec": false,
                "immediateXfer": false,
                "flagDebit": false,
                "flagCredit": false
            },
            "acctBal": {
                "curCode": "COP",
                "amt": 0.0
            },
            "LOCLimit": {
                "curCode": "COP",
                "amt": 0.0
            },
            "otherIncome": {
                "curCode": "COP",
                "amt": 0.0
            },
            "curRate": "0",
            "termUnits": "Monthly",
            "minPmtCurAmt": {
                "amt": 0,
                "dueDt": "2023-09-18"
            }
        },
        {
            "acctType": "CCA",
            "externalId": "f46b28aa29fc16e81a94bd3d4fd9b058-CCA-TCR",
            "depAcctId": {
                "acctId": "489444******5963"
            },
            "cardAcctId": {
                "acctId": "489444******5963",
                "lastDigits": "5963"
            },
            "nickname": "Platinum",
            "name": "Platinum",
            "product": {
                "productType": "489444-01-00"
            },
            "curCode": "COP",
            "bankId": "",
            "xferRec": {
                "externalXferRec": false,
                "immediateXfer": false,
                "flagDebit": false,
                "flagCredit": false
            },
            "acctBal": {
                "curCode": "COP",
                "amt": 0.0
            },
            "LOCLimit": {
                "curCode": "COP",
                "amt": 0.0
            },
            "otherIncome": {
                "curCode": "COP",
                "amt": 0.0
            },
            "curRate": "0",
            "termUnits": "Monthly",
            "minPmtCurAmt": {
                "amt": 0,
                "dueDt": "2023-09-18"
            }
        },
        {
            "acctType": "ILA",
            "externalId": "33505089197-ILA-CAR",
            "depAcctId": {
                "acctId": "33505089197"
            },
            "cardAcctId": {
                "acctId": "",
                "lastDigits": ""
            },
            "nickname": "Microcrédito",
            "name": "Microcrédito",
            "product": {
                "productType": "33-09-49"
            },
            "curCode": "COP",
            "bankId": "",
            "xferRec": {
                "externalXferRec": false,
                "immediateXfer": false,
                "flagDebit": false,
                "flagCredit": false
            },
            "acctBal": {
                "curCode": "COP",
                "amt": 0.0
            },
            "LOCLimit": {
                "curCode": "COP",
                "amt": 0.0
            },
            "otherIncome": {
                "curCode": "COP",
                "amt": 0.0
            },
            "curRate": "0",
            "termUnits": "",
            "minPmtCurAmt": {
                "amt": 0,
                "dueDt": ""
            }
        }
    ]
}"
  }
}

> Response Example:

{
  "file": {
    "desc": "added successfully"
  },
  "responseType": {
    "value": "OK"
  }
}

> Response Error Example:

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": "ER500"
    },
    "responseDetail": {
        "errorCode": "common.api.shoesize",
        "errorDesc": "Value Exceeded. Must be between {min} and {max}",
        "errorType": ""
    }
}

Errors Code:

Diagram of sequence.

- Consult Owner

Description:

This service allows consult owner

Path:

POST: customer-management/v1/status-basic-data:

Request Data:

Headers:

Request Body:

Request Example:

{
  "trn": {
    "transactionHour": "15:37:59",
    "code": "123456789123456",
    "depAcctIdFrom": {
      "acctId": "12321414"
    },
    "trnRqUID": "123456",
    "branchName": "MI OFICINA BETTY",
    "cityId": "25386",
    "city": "LA MESA",
    "stateProv": "25",
    "depAcctIdTo": {
      "acctId": "12321414"
    }
  }
}

Response Body:

Success Response Example:

{
  "responseType": {
      "value": "OK"
  },
  "trn": {
    "personName": {
      "fullName": "full name"
    },
    "depAcctId": {
      "acctId": "12321414"
    }
  }
}

Response Error Example:

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

Diagram of sequence.

- Remittances - Consult customer.

Description:

This service allows consult remittances basic data.

Path:

GET

/customers-management/v1/remittances/basic-data/{identserialnum}:

URIParams:

QUERYParams:

Headers

Mapping Data:

- Response:

Examples:

Example of Body Response:

{
  "responseType":{
    "value": "OK"
  },
  "listAddress": [
    {
      "phoneNum": {
        "phone": "3105556755",
        "cellPhone": "3105556755"
      },
      "postAddr": {
        "idItem": 2,
        "cspRefId": 2,
        "addrType": "RESI",
        "addr1": "calle 30 #10-15",
        "city": "Bogota",
        "country": "Colombia",
        "postalCode": "730001",
        "cityId": "0112",
        "stateProv": "calle 30 #10-15"
      }
    }
  ],
  "beneficiary": [
    {
      "personInfo": {
        "idItem": 2,
        "cspRefId": 2,
        "identSerialNum": "1234567890",
        "emailAddr": "correo@gmail.com",
        "lastName": "DE_FRANCISCO",
        "secondLastName": "LOPEZ",
        "firstName": "CARLOS",
        "middleName": "MARIO"
      }
    }
  ],
  "senderPmtInfo": [
    {
      "cspRefId": 2,
      "type": "VLRING",
      "rank": "VLRING"
    }
  ],
  "personInfo": {
    "personName": {
      "lastName": "CAPERA",
      "secondLastName": "PAZ",
      "firstName": "DIEGO",
      "middleName": "MARIO"
    },
    "upDt": "2022-12-11",
    "clientTerminalSeqId": 0,
    "birthDt": "2022-12-11",
    "country": "CO",
    "emailAddr": "correo@gmail.com",
    "businessActivity": {
      "certCode": "086712",
      "jobTitle": "PARREG",
      "rank": "NIV1",
      "flagPubExpPerson": true,
      "branchName": ""
    },
    "cspRefId": 2,
    "gender": "F",
    "status": "Activo",
    "govIssueIdent": {
      "govIssueIdentType": "CC",
      "identSerialNum": "1234567890",
      "expCityId": "05001",
      "issDt": "2022-12-11",
      "city": "Bogota D.C",
      "country": "CO"
    }
  },
  "pmtReferences": {
    "actualizeStatus": {
      "updateRefId": "SUPGIR",
      "branchId": "SUPGIR_01"
    }
  },
  "compliance": {
    "termsConditions": true,
    "personDataProcessing": true
  }
}

Response Error Example:

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

Diagrama.

- Consult PILA

Description:

This service allows consult PILA

Path:

POST: customer-management/v1/query-pila:

Request Data:

Headers:

Request Body:

Request Example:

{
  "trn": {
    "transactionHour": "15:37:59",
    "trnRqUID": "123456",
    "code": "123456789123456",
    "depAcctIdTo": {
      "acctId": "12321414"
    },
    "branchName": "MI OFICINA BETTY",
    "cityId": "25386",
    "city": "LA MESA",
    "stateProv": "25",
    "depAcctIdFrom": {
      "acctId": "12321414"
    },
    "invoiceInfo": {
      "invoiceNum": "12321414",
      "identSerialNum": "12321414"
    }
  }
}

Response Body:

Success Response Example:

{
  "responseType": {
      "value": "OK"
  },
  "trn": {
      "approvalId": "",
      "invoiceInfo": {
        "identSerialNum": "12321414"
      },
      "validityPeriodInfo": {
        "validityPeriod": "12321414"
      },
      "dueDt": "",
      "curAmt": {
        "amt": 24
      }
  }
}

Response Error Example:

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

Diagram of sequence.