---
swagger: "2.0"
info:
title: CSMT-CRM-D-DemographicProfile
description: Gets the customer's information and data center location
version: 1.0.4
x-ibm-name: csmt-crm-d-demographicprofile
host: 127.0.0.1
schemes:
- https
basePath: /api
produces:
- application/json
paths:
/v1/customers/datacenter-location:
post:
tags:
- customer-datacenter-location
operationId: customer-datacenter-location
summary: Gets Customer's CSI
description: Gets Customer's CSI
consumes:
- application/json
produces:
- application/json
parameters:
- 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: 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
- name: retrieveCustomerCSIRequest
in: body
schema:
$ref: '#/definitions/RetrieveCustomerCSIRequest'
responses:
200:
description: Successful operation.
schema:
$ref: '#/definitions/RetrieveCustomerCSIResponse'
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'
500:
description: Type | Code | Details |
fatal | serverUnavailable | The
request failed due to an internal error/server unavailability |
schema:
$ref: '#/definitions/ErrorResponse'
/v1/customers/profiles/information:
post:
tags:
- customer-information
operationId: customer-information
summary: Gets Personal and Demographics data of customer
description: Gets Customer information
consumes:
- application/json
produces:
- application/json
parameters:
- 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: 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
- name: retrieveCustomerInformationRequest
in: body
schema:
$ref: '#/definitions/retrieveCustomerInformationRequest'
responses:
200:
description: Successful operation.
schema:
$ref: '#/definitions/retrieveCustomerInformationResponse'
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'
500:
description: Type | Code | Details |
fatal | serverUnavailable | The
request failed due to an internal error/server unavailability |
schema:
$ref: '#/definitions/ErrorResponse'
definitions:
RetrieveCustomerCSIRequest:
type: object
properties:
branchId:
description: branchId
type: integer
example: 1234
maxLength: 4
accountNumber:
description: accountNumber
type: number
format: biginteger
example: 123456789012
maxLength: 12
customerId:
description: Customer Id
type: string
example: "232343425"
RetrieveCustomerCSIResponse:
type: object
properties:
dataCenterLocation:
description: Data Center location (CSI)
type: string
example: 10
required:
- dataCenterLocation
retrieveCustomerInformationRequest:
type: object
properties:
customerId:
description: Customer Id
type: string
example: "98346298349"
cardNumber:
description: Card number
type: string
example: "4969452123456110"
maxLength: 16
account:
$ref: '#/definitions/Account'
Account:
type: object
properties:
accountAccessPrefix:
description: First 4 digits from the account or card
type: string
example: "5211"
branchId:
description: branchId
type: integer
example: 1234
maxLength: 4
accountNumber:
description: accountNumber
type: number
format: biginteger
example: 123456789012
maxLength: 12
product:
$ref: '#/definitions/Product'
Product:
type: object
properties:
productNumber:
type: integer
format: int32
description: Product Number
instrumentCode:
type: integer
format: int32
description: Instrument Code
retrieveCustomerInformationResponse:
type: object
properties:
customer:
$ref: '#/definitions/Customer'
Customer:
type: object
properties:
backgroundRiskCode:
description: Banamex risk code
type: string
example: "00"
customerId:
description: Customer Id
type: string
example: "36454546534"
birthDate:
description: Customer's birthdate in format yyyy-mm-dd
type: string
format: date
example: "2000-11-23"
customerSegment:
description: Segment where the Customer belongs
type: string
example: 20
customerStatus:
description: Status of the customer
type: string
example: 1
customerType:
description: Type of the customer
type: string
example: 11
fullName:
description: Full name of the customer
type: string
example: Luis Diaz Salinas
customerSinceDate:
description: The date customer is associated with Financial Institution
type: string
format: date
example: "1990-10-15"
dataCenterLocation:
description: dataCenterLocation
type: integer
example: 10
phone:
type: array
items:
$ref: '#/definitions/Phone'
required:
- backgroundRiskCode
- birthDate
- customerSegment
- customerStatus
- customerType
- fullName
Phone:
type: object
properties:
areaCode:
description: Area code where the phone belongs
type: integer
example: 52
extensionNumber:
description: Extension for the phone
type: integer
example: 343
phoneNumber:
description: Phone number
type: string
example: 7221567676
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
...