production
development
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
Paths
/v1/customers/datacenter-location
post /v1/customers/datacenter-location
customer-datacenter-location
Gets Customer's CSI
Gets Customer's CSI
OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)
Token URL
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token
Scopes
/api/v1
Client ID
X-IBM-Client-Id
(apiKey located in header)
Accept
Required in header
string
Content-Types that are acceptable for the response
uuid
Required in header
string
128 bit UUID that you generate for every request
Accept-Language
Optional in header
string
List of acceptable human languages for response
Content-Type
Required in header
string
Content-Types that are sent in the request
ChannelId
Required in header
string
Channel where request originated
sid
Required in header
string
SessionId sent by Consumer
retrieveCustomerCSIRequest
Optional in body
object
200
Successful operation.
400
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
401
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
403
| 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 |
404
| Type | Code | Details | More Info |
| error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
500
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Example Request
Example Response
POST https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/datacenter-location
/v1/customers/profiles/information
post /v1/customers/profiles/information
customer-information
Gets Personal and Demographics data of customer
Gets Customer information
OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)
Token URL
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token
Scopes
/api/v1
Client ID
X-IBM-Client-Id
(apiKey located in header)
Accept
Required in header
string
Content-Types that are acceptable for the response
uuid
Required in header
string
128 bit UUID that you generate for every request
Accept-Language
Optional in header
string
List of acceptable human languages for response
Content-Type
Required in header
string
Content-Types that are sent in the request
ChannelId
Required in header
string
Channel where request originated
sid
Required in header
string
SessionId sent by Consumer
retrieveCustomerInformationRequest
Optional in body
object
200
Successful operation.
400
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
401
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
403
| 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 |
404
| Type | Code | Details | More Info |
| error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
500
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Example Request
Example Response
POST https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/profiles/information
/v1/customers/profiles/detail
post /v1/customers/profiles/detail
customer-detail
To retrieve brief Personal and Demographics data of the customer to classify the customer segment.
This API is used to retrieve brief Personal and Demographics data of the customer to classify the customer segment
OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)
Token URL
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token
Scopes
/api/v1
Client ID
X-IBM-Client-Id
(apiKey located in header)
client_id
Required in header
string
Client ID generated during application registration
Authorization
Required in header
string
The Authorization Token received during login
Accept
Required in header
string
Content-Types that are acceptable for the response
uuid
Required in header
string
128 bit UUID that you generate for every request
Accept-Language
Optional in header
string
List of acceptable human languages for response
Content-Type
Required in header
string
Content-Types that are sent in the request
ChannelId
Required in header
string
Channel where request originated
sid
Optional in header
string
SessionId sent by Consumer
retrieveCustomerDetailRequest
Optional in body
object
200
Successful operation.
400
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
401
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
403
| 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 |
404
| Type | Code | Details | More Info |
| error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
500
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Example Request
Example Response
POST https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/profiles/detail
Definitions
{
"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"
}
}
}
{
"type": "object",
"properties": {
"dataCenterLocation": {
"description": "Data Center location (CSI)",
"type": "string",
"example": 10
}
},
"required": [
"dataCenterLocation"
]
}
{
"type": "object",
"properties": {
"birthDate": {
"description": "Customer's birthdate in format dd-mm-yyyy for IVR channel and format yyyy-mm-dd for all channels",
"type": "string",
"format": "date",
"example": "2000-11-23"
},
"customerSegment": {
"description": "Segment where the Customer belongs",
"type": "string",
"example": 20
},
"fullName": {
"description": "Full name of the customer",
"type": "string",
"example": "Luis Diaz Salinas"
}
},
"required": [
"backgroundRiskCode",
"birthDate",
"customerSegment",
"customerStatus",
"customerType",
"fullName"
]
}
{
"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 dd-mm-yyyy for IVR channel and format yyyy-mm-dd for all channels",
"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
},
"citiEmployeeFlag": {
"description": "Flag to tell if the person is citi employee",
"type": "boolean",
"example": "True"
},
"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
},
"phones": {
"type": "array",
"items": {
"$ref": "#/definitions/Phones"
}
}
},
"required": [
"backgroundRiskCode",
"birthDate",
"customerSegment",
"customerStatus",
"customerType",
"fullName"
]
}
{
"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"
}
}
}
{
"type": "object",
"properties": {
"customerId": {
"description": "Unique identifier for the Customer",
"type": "string",
"example": "98346298349"
},
"cardNumber": {
"description": "Card number",
"type": "string",
"example": "4969452123456110",
"maxLength": 16
},
"account": {
"$ref": "#/definitions/AccountDetail"
}
}
}
{
"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": "string",
"example": "1234567890123456",
"maxLength": 16
},
"product": {
"$ref": "#/definitions/ProductDetail"
}
}
}
{
"type": "object",
"properties": {
"productNumber": {
"type": "string",
"example": "1234",
"description": "Product code"
},
"instrumentCode": {
"type": "string",
"example": "12",
"description": "product Instrument Code"
}
}
}
{
"type": "object",
"properties": {
"customerId": {
"description": "Unique identifier for the Customer",
"type": "string",
"example": "98346298349"
},
"cardNumber": {
"description": "Card number",
"type": "string",
"example": "4969452123456110",
"maxLength": 16
},
"account": {
"$ref": "#/definitions/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": "string",
"example": "1234567890123456",
"maxLength": 16
},
"product": {
"$ref": "#/definitions/Product"
}
}
}
{
"type": "object",
"properties": {
"productNumber": {
"type": "string",
"example": "1234",
"description": "Product code"
},
"instrumentCode": {
"type": "string",
"example": "12",
"description": "product Instrument Code"
}
}
}
{
"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"
]
}