production
development
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
Paths
/v1/customers/security/profile
get /v1/customers/security/profile
customer-security-profile-detail
The API retrieves customer security profile details
The API retrieves customer security profile details
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
Optional 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
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 |
422
| Type | Code | Details |
| error | businessValidationFailed | Business validation error occured on one or more parameters |
500
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Example Request
Example Response
GET https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/security/profile
Definitions
{
"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"
]
}
{
"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"
]
}
{
"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"
]
}