Paths
/v1/x-global/security/rao/otp/generate
The API will generate transmit otp for RAO
This API will generate a transmit otp for RAO
Client ID generated during application registration
The Authorization Token received during login
Content-Types that are acceptable for the response
128 bit UUID that you generate for every request
List of acceptable human languages for response
Content-Types that are sent in the request
Content-Types that are sent in the request2 character ISO country code
{
"default": "MX"
}Business code identified during application registration
Channel where request originated
SessionId sent by Consumer
Successful operation.
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
| 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 |
| Type | Code | Details | More Info |
| error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
| Type | Code | Details |
| error | businessValidationFailed | Business validation error occured on one or more parameters |
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
/v1/x-global/security/rao/otp/validate
The API will validate transmit otp for RAO
This API will validate a transmit otp for RAO
Client ID generated during application registration
The Authorization Token received during login
Content-Types that are acceptable for the response
128 bit UUID that you generate for every request
List of acceptable human languages for response
Content-Types that are sent in the request
Content-Types that are sent in the request2 character ISO country code
{
"default": "MX"
}Business code identified during application registration
Channel where request originated
SessionId sent by Consumer
Successful operation.
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
| 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 |
| Type | Code | Details | More Info |
| error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
| Type | Code | Details |
| error | businessValidationFailed | Business validation error occured on one or more parameters |
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
/v1/x-global/security/rao/certified-phone
The API will retrieve certified phone number by transmit OTP
This API will retrieve certified phone number by transmit OTP
Client ID generated during application registration
The Authorization Token received during login
Content-Types that are acceptable for the response
128 bit UUID that you generate for every request
List of acceptable human languages for response
Content-Types that are sent in the request
Content-Types that are sent in the request2 character ISO country code
{
"default": "MX"
}Business code identified during application registration
Channel where request originated
SessionId sent by Consumer
Successful operation.
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
| 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 |
| Type | Code | Details | More Info |
| error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
| Type | Code | Details |
| error | businessValidationFailed | Business validation error occured on one or more parameters |
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Definitions
{
"type": "object",
"properties": {
"phoneCountryCode": {
"type": "string",
"description": "Country codes area of the international telephone numbering",
"maxLength": 5,
"pattern": "^\\+\\d{1,4}$",
"example": "+52"
},
"encryptedPhoneNumber": {
"type": "string",
"description": "The encrypted phone number of the user for which OTP needs to be delivered",
"format": "byte",
"example": "U3dhZ2dlciByb2Nrcw=="
}
},
"required": [
"phoneCountryCode",
"encryptedPhoneNumber"
]
}
{
"type": "object",
"properties": {
"phoneCountryCode": {
"type": "string",
"description": "Country codes area of the international telephone numbering",
"maxLength": 5,
"pattern": "^\\+\\d{1,4}$",
"example": "+52"
},
"encryptedPhoneNumber": {
"type": "string",
"description": "The encrypted phone number of the user for which OTP needs to be delivered",
"format": "byte",
"example": "U3dhZ2dlciByb2Nrcw=="
}
},
"required": [
"phoneCountryCode",
"encryptedPhoneNumber"
]
}
{
"type": "object",
"properties": {
"encryptedOneTimePasswordToken": {
"type": "string",
"description": "Clear OTP Token",
"format": "byte",
"example": "U3dhZ2dlciByb2Nrcw=="
},
"phone": {
"$ref": "#/definitions/Phone"
}
},
"required": [
"phone",
"encryptedOneTimePasswordToken"
]
}
{
"type": "object",
"properties": {
"phoneCountryCode": {
"type": "string",
"description": "Country codes area of the international telephone numbering",
"maxLength": 5,
"pattern": "^\\+\\d{1,4}$",
"example": "+52"
},
"phoneNumber": {
"type": "string",
"description": "The certified phone number for RAO",
"maxLength": 10,
"example": "553366998"
}
},
"required": [
"phoneCountryCode",
"phoneNumber"
]
}
{
"properties": {
"type": {
"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"
],
"type": "string"
},
"timestamp": {
"description": "Timestamp of the error response",
"type": "string"
},
"uuid": {
"description": "Uuid used in the request",
"type": "string"
},
"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 of the error",
"type": "string"
}
}
}