---
swagger: "2.0"
info:
title: CHNN-AOP-V-AccountProfileEncrypted
description: This microservice will retreive data for customers account Information.This
API is Pre-login so SCOPE is VISITOR and SID is required.
version: 2.1.0
x-ibm-name: chnn-aop-v-accountprofileencrypted
name: ""
schemes:
- https
basePath: /api
produces:
- application/json
paths:
/v1/channels/account-opening/accounts/detail:
post:
tags:
- 'retrieve-account-detail '
operationId: retrieve-account-detail
summary: this api performs the update costomer account detail
description: this api performs the update costomer account detail
consumes:
- application/json
produces:
- application/json
parameters:
- name: client_id
in: header
required: true
type: string
description: Client ID generated during application registration
- name: client_secret
in: header
required: false
type: string
description: Client secret generated during application registration
- name: Authorization
in: header
required: true
type: string
description: The Authorization Token received during login
- name: Accept
in: header
required: true
type: string
description: Content-Types that are acceptable for the response
- name: uuid
in: header
required: true
type: string
description: 128 bit UUID that you generate for every request
- name: Accept-Language
in: header
required: false
type: string
description: List of acceptable human languages for response
- name: Content-Type
in: header
required: true
type: string
description: Content-Types that are sent in the request
- name: countryCode
in: header
required: true
type: string
description: Country code in 2 character ISO 3166 format
- name: businesscode
in: header
required: true
type: string
description: Business code identified durin application registration
- name: ChannelId
in: header
required: true
type: string
description: Channel where request originated
- name: sid
in: header
required: true
type: string
description: Session is generated and returned on the first API call of the
key exchange (GET e2e call) as response header, which needs to be resent
on succesive calls of same session.
- name: customerAccountRequest
in: body
schema:
$ref: '#/definitions/CustomerAccountRequest'
responses:
200:
description: Successful operation.
schema:
$ref: '#/definitions/CustomerAccountResponse'
400:
description:
Type | Code | Details |
error | invalidRequest | Missing
or invalid Parameters |
schema:
$ref: '#/definitions/ErrorResponse'
401:
description: Type | Code | Details |
error | unAuthorized | Authorization
credentials are missing or invalid |
schema:
$ref: '#/definitions/ErrorResponse'
403:
description: Type | Code | Details | More
Info |
error | accessNotConfigured | The request
operation is not configured to access this resource | Channel/Country/Business
provided in the request is not supported currently |
schema:
$ref: '#/definitions/ErrorResponse'
404:
description: Type | Code | Details | More
Info |
error | resourceNotFound | The requested
resource was not found | Empty resource/resource not found |
schema:
$ref: '#/definitions/ErrorResponse'
422:
description: Type | Code | Details |
error | businessValidationFailed | Business
validation error occured on one or more parameters |
schema:
$ref: '#/definitions/ErrorResponse'
500:
description: Type | Code | Details |
fatal | serverUnavailable | The
request failed due to an internal error/server unavailability |
schema:
$ref: '#/definitions/ErrorResponse'
definitions:
CustomerAccountRequest:
type: object
properties:
encryptedCustomerAccountDetail:
description: encryptedCustomerAccountDetail, AES encrypted using the key shared
with IVR and stored in Gemfire
type: string
example: ""
required:
- encryptedCustomerAccountDetail
CustomerAccountResponse:
type: object
properties:
encryptedCustomerAccountData:
description: encryptedCustomerAccountData, AES encrypted using the key shared
with IVR and stored in Gemfire
type: string
example: ""
required:
- encryptedCustomerAccountData
ErrorResponse:
properties:
type:
type: string
description: Invalid - Request did not confirm to the specification and was
unprocessed and rejected. Please fix the value and try again
enum:
- error
- warn
- invalid
- fatal
code:
description: Error code which qualifies the error
type: string
details:
description: Human readable explanation specific to the occurrence of the
problem
type: string
location:
description: The name of the field that resulted in the error
type: string
moreInfo:
description: URI to human readable documentation or detailed description of
the error
type: string
uuid:
description: 128 bit UUID that you generate for every request
type: string
timestamp:
description: Timestamp of the error
type: string
required:
- type
- code
x-ibm-configuration:
enforced: true
testable: true
phase: realized
securityDefinitions:
OAuth2 Application Flow:
type: oauth2
description: ""
flow: application
scopes:
/api/v1: ""
tokenUrl: https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token
Client ID:
type: apiKey
description: ""
in: header
name: X-IBM-Client-Id
security:
- OAuth2 Application Flow:
- /api/v1
Client ID: []
x-ibm-endpoints:
- endpointUrl: https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
type:
- production
- development
...