Paths
/v1/x-global/security/jwt/validate
API to certify a Json Web Token generated previously by a Transmit Security service and given to a channel orchestrator for future uses; asserting a transmitCustomer previosly registred in the CCS DB if is required.
The client ID you received during application registration in the developer portal
Bearer token adquired from API Gateway OAUTH service.
Content-Types that are acceptable for the response
Random 128 bit UUID generated uniquely for every request from the Customer, which will represent transaction unique identifier and it is recommended to send.
Language to be send to the backend systems. The supported values are ‘es’ for spanish and ‘en’ for english.
{
"default": "es"
}Content-Types that are sent in the request
{
"default": "application\/json"
}3 character business code
{
"default": "GCB"
}2 character ISO country code
{
"default": "MX"
}channel ID used by the user, it is required for the first call in a new session.
Session is generated and returned on the first API call as response header, which needs to be resent on succesive calls of same session
Request body to authenticate Citibanamex customer through Token validation.
Validation Successful
| Type | Code | Details |
| invalid | invalidRequest | Missing or invalid Parameters |
| Type | Code | Details |
| invalid | 5002 | Token not valid. |
| error | invalidCredential | Invalid transmit customer |
| Type | Code | Details |
| error | accessNotConfigured | The request operation is not configured to access this resource. |
| Type | Code | Details |
| error | 5000 | Application not found. |
| Type | Code | Details |
| error | businessValidationFailed | Business validation error occured on one or more parameter |
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
/v1/x-global/security/transmit-customer
API for saving a customer that in previous steps was assigned a SoftToken with Transmit services.
The client ID you received during application registration in the developer portal
Bearer token adquired from API Gateway OAUTH service.
Content-Types that are acceptable for the response
Random 128 bit UUID generated uniquely for every request from the Customer, which will represent transaction unique identifier and it is recommended to send.
Language to be send to the backend systems. The supported values are ‘es’ for spanish and ‘en’ for english.
{
"default": "es"
}Content-Types that are sent in the request
{
"default": "application\/json"
}3 character business code
{
"default": "GCB"
}2 character ISO country code
{
"default": "MX"
}channel ID used by the user, it is required for the first call in a new session.
Session is generated and returned on the first API call as response header, which needs to be resent on succesive calls of same session
Success Registration
| Type | Code | Details |
| invalid | invalidRequest | Missing or invalid Parameters |
| Type | Code | Details |
| invalid | InvalidCredentials | Customer data not found |
| error | SessionTimeout | Session expired |
| Type | Code | Details |
| error | accessNotConfigured | The request operation is not configured to access this resource. |
| Type | Code | Details |
| error | Unknown | Resource not found |
| Type | Code | Details |
| error | businessValidationFailed | Business validation error occured on one or more parameter |
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
/v1/x-global/security/transmit-customer/validate
API for recovering and validating if a customer has a SoftToken with Transmit functionalities.
The client ID you received during application registration in the developer portal
Bearer token adquired from API Gateway OAUTH service.
Content-Types that are acceptable for the response
Random 128 bit UUID generated uniquely for every request from the Customer, which will represent transaction unique identifier and it is recommended to send.
Language to be send to the backend systems. The supported values are ‘es’ for spanish and ‘en’ for english.
{
"default": "es"
}Content-Types that are sent in the request
{
"default": "application\/json"
}3 character business code
{
"default": "GCB"
}2 character ISO country code
{
"default": "MX"
}channel ID used by the user, it is required for the first call in a new session.
Session is generated and returned on the first API call as response header, which needs to be resent on succesive calls of same session
Request body to validateif a Citibanamex customer has a Token with Transmit functionalities.
Authentication Successful
| Type | Code | Details |
| invalid | invalidRequest | Missing or invalid Parameters |
| Type | Code | Details |
| invalid | InvalidCredentials | Customer data not found |
| Type | Code | Details |
| error | accessNotConfigured | The request operation is not configured to access this resource. |
| Type | Code | Details |
| error | Unknown | Resource not found |
| Type | Code | Details |
| error | businessValidationFailed | Business validation error occured on one or more parameter |
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Definitions
{
"type": "object",
"properties": {
"customerId": {
"type": "string",
"example": "11995672351",
"description": "Id of the customer, used for verifying if it is a valid transmit customer."
},
"transmitTokenEnabledFlag": {
"type": "boolean",
"example": true,
"description": "If the customerId is a transmitCustomer the flag will come with true, opposite case will come with false."
}
}
}
Request parameters for verifying if the customer has a SoftToken with Transmit
{
"type": "object",
"properties": {
"customerId": {
"type": "string",
"example": "11995672351",
"description": "Id of the customer, used for verifying if it is a valid transmit customer."
}
},
"required": [
"customerId"
]
}
Request parameters for a transmit JWT validation
{
"type": "object",
"properties": {
"transmitToken": {
"type": "string",
"example": "afgknsdlfignsdikfgnsldifng",
"description": "The token to validate as it was provided by the server."
},
"customerId": {
"type": "string",
"example": "11995672351",
"description": "Id of the customer, used for verifying if it is a valid transmit customer."
},
"grantType": {
"type": "string",
"example": "2",
"description": "Id of the token, used for identifying the kind of functional Id also known as applicationId for calling the transmit JWT validator service tokenId Details 1 SMS-OTP functional Id 2 binding functional Id 3 New Online Transaction functional Id 4 Avatar Transaction functional Id 5 IVR Transaction functional ID 6 AcciTrade Transaction functional ID 7 Directo Transaction functional ID
"
}
},
"required": [
"transmitToken",
"customerId",
"applicationId"
]
}
{
"required": [
"code",
"details",
"type"
],
"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": {
"type": "string",
"description": "Error code which qualifies the error"
},
"details": {
"type": "string",
"description": "Human readable explanation specific to the occurrence of the problem"
},
"location": {
"type": "string",
"description": "The name of the field that resulted in the error"
},
"moreInfo": {
"type": "string",
"description": "URI to human readable documentation of the error"
}
}
}