production
development
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
Paths
/v1/customers/employers
post /v1/customers/employers
create-customer-employer
LOB: Data Analytics, Feature: Customer´s Employer Information, Functionality: Insert customer´s employer information.
The API manages the insertion of information of the client's employer indicated in the input parameters.
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
countryCode
Required in header
string
Country code in 2 character ISO 3166 format
businessCode
Required in header
string
Business code identified during application registration
ChannelId
Required in header
string
Channel where request originated
sid
Required in header
string
SessionId sent by Consumer
customerEmployerRequest
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 |
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
POST https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/employers
put /v1/customers/employers
update-customer-employer
LOB: Data Analytics, Feature: Customer´s Employer Information, Functionality: Update customer´s employer information.
The API manages the update of the information of the client's employer indicated in the input parameters.
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
countryCode
Required in header
string
Country code in 2 character ISO 3166 format
businessCode
Required in header
string
Business code identified during application registration
ChannelId
Required in header
string
Channel where request originated
sid
Required in header
string
SessionId sent by Consumer
customerEmployerRequest
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 |
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
PUT https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/employers
/v1/customers/employers/retrieve
post /v1/customers/employers/retrieve
retrieve-customer-employer
LOB: Data Analytics, Feature: Customer´s Employer Information, Functionality: Retrieve customer´s employer information.
The API manages the information query of the client's employer indicated in the input parameters.
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
countryCode
Required in header
string
Country code in 2 character ISO 3166 format
businessCode
Required in header
string
Business code identified during application registration
ChannelId
Required in header
string
Channel where request originated
sid
Required in header
string
SessionId sent by Consumer
customerInformationEmployerRequest
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 |
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
POST https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/employers/retrieve
Definitions
{
"type": "object",
"properties": {
"customer": {
"$ref": "#/definitions/Customer"
},
"sourceSystem": {
"description": "Identifier of the consuming source system (this data is sent by the front).",
"type": "string",
"example": "105099",
"maxLength": 6
},
"stationName": {
"description": "Identifier of the system that is attends the session of the client (this data is sent by the front).",
"type": "string",
"example": "Y1050X99",
"maxLength": 8
},
"employeeId": {
"description": "Identifier of the employee (this data is sent by the front).",
"type": "string",
"example": "0020007248",
"maxLength": 10
}
},
"required": [
"customer",
"sourceSystem",
"stationName",
"employeeId"
]
}
{
"type": "object",
"properties": {
"customerId": {
"description": "Unique identifier of the customer.",
"type": "string",
"example": "000004945914",
"maxLength": 12
},
"sourceSystem": {
"description": "Identifier of the consuming source system (this data is sent by the front).",
"type": "string",
"example": "105099",
"maxLength": 6
},
"stationName": {
"description": "Identifier of the system that is attends the session of the client (this data is sent by the front).",
"type": "string",
"example": "Y1050X99",
"maxLength": 8
},
"employeeId": {
"description": "Identifier of the employee (this data is sent by the front).",
"type": "string",
"example": "0020007248",
"maxLength": 10
}
},
"required": [
"customerId",
"sourceSystem",
"stationName",
"employeeId"
]
}
{
"type": "object",
"properties": {
"customer": {
"$ref": "#/definitions/Customer"
}
}
}
{
"type": "object",
"properties": {
"customerId": {
"description": "Unique identifier of the customer.",
"type": "string",
"example": "000004945914",
"maxLength": 12
},
"fullName": {
"description": "Client's full legal name.",
"type": "string",
"example": "Luis Sergio Del Carmen Juarez",
"maxLength": 170
},
"incomeSourceCode": {
"description": "Customer income source code, according to D835 catalog.",
"type": "string",
"example": "14",
"maxLength": 4
},
"demographics": {
"$ref": "#/definitions/Demographics"
},
"employment": {
"$ref": "#/definitions/Employment"
}
},
"required": [
"customerId"
]
}
{
"type": "object",
"properties": {
"countryOfBirthCode": {
"description": "Country of birth code, according to D000755 catalog.",
"type": "string",
"example": "2",
"maxLength": 8
},
"stateOfBirthCode": {
"description": "State of birth code, according to D000060 catalog. Use value 33 for foreign.",
"type": "string",
"example": "33",
"maxLength": 2
}
}
}
{
"type": "object",
"properties": {
"employerName": {
"description": "Employer name of customer.",
"type": "string",
"example": "Cifra S.A. de C.V.",
"maxLength": 40
}
}
}
{
"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"
}
},
"required": [
"type",
"code"
]
}