--- swagger: "2.0" info: title: CSMT-CAE-V-CustomerSecurityProfileDetail description: The Microservice retrieves and manages customer security profile. This service is at the Edge layer of the architecture version: 1.1.0 x-ibm-name: csmt-cae-v-customersecurityprofiledetail host: 127.0.0.1 schemes: - https basePath: /api produces: - application/json paths: /v1/customers/security/profile: get: tags: - customer-security-profile-detail operationId: customer-security-profile summary: The API retrieves customer security profile details description: The API retrieves customer security profile details consumes: - application/json produces: - application/json parameters: - name: client_id in: header required: true type: string description: Client ID 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: false type: string description: Content-Types that are sent in the request - name: ChannelId in: header required: true type: string description: Channel where request originated - name: sid in: header required: true type: string description: SessionId sent by Consumer responses: 200: description: Successful operation. schema: $ref: '#/definitions/CustomerSecurityProfileResponse' 400: description:
TypeCodeDetails
errorinvalidRequestMissing or invalid Parameters
schema: $ref: '#/definitions/ErrorResponse' 401: description:
TypeCodeDetails
errorunAuthorizedAuthorization credentials are missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
TypeCodeDetailsMore Info
erroraccessNotConfiguredThe request operation is not configured to access this resourceChannel/Country/Business provided in the request is not supported currently
schema: $ref: '#/definitions/ErrorResponse' 404: description:
TypeCodeDetailsMore Info
errorresourceNotFoundThe requested resource was not foundEmpty resource/resource not found
schema: $ref: '#/definitions/ErrorResponse' 422: description:
TypeCodeDetails
errorbusinessValidationFailedBusiness validation error occured on one or more parameters
schema: $ref: '#/definitions/ErrorResponse' 500: description:
TypeCodeDetails
fatalserverUnavailableThe request failed due to an internal error/server unavailability
schema: $ref: '#/definitions/ErrorResponse' definitions: CustomerSecurityProfileResponse: type: object properties: customerName: description: full name of the customer type: string example: John Smith highRiskTransactionTokenStatus: description: Clients token type. type: string example: "66" highRiskTransactionTokenDesc: description: Description of the high risk token status type: string example: SOFTTOKEN_ACTIVATED customerType: description: type of customer type: integer format: int32 example: 1551 customerTypeDescription: description: Description of the customer type type: string example: Physical person legacyTokenStatus: description: status of the legacy Token type: integer format: int32 example: NONE legacyTokenStatusDescription: description: description of the legacy Token status type: string example: NA termsAndConditionsAcceptedFlag: description: has customer accepted the terms and conditions type: boolean example: true vipFlag: description: if the user is a Priority client type: boolean example: true cautionFlag: description: It is a business indicator to show or not to show a message related to cellphone certification. type: boolean example: true certificationDetails: $ref: '#/definitions/PhoneVerification' required: - customerName - highRiskTransactionTokenStatus - highRiskTransactionTokenDesc - customerType - customerTypeDescription - legacyTokenStatus - legacyTokenStatusDescription - termsAndConditionsAcceptedFlag - vipFlag - cautionFlag PhoneVerification: type: object properties: verificationType: description: certification level token type type: integer format: int32 example: 1 phoneNumber: description: cell phone number of the customer type: string example: "1234567890" mobileCarrierCode: description: company of the cellphone type: integer format: int32 example: 1 verificationChannel: description: it is the channel where client client verified his number type: string example: D required: - verificationType - phoneNumber - mobileCarrierCode - verificationChannel 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: More Info can be used to pass any additional details type: string uuid: description: 128 bit UUID that you generate for every request type: string timestamp: description: Timestamp of the error type: string required: - type - code 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 ...