Paths
/v1/x-global/bne/security/authenticate/challenge/retrieve
To get a challenge code for authenticating a customer for BNE
This API is used to get a challenge code for authenticating a customer for BNE
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
Country code in 2 character ISO 3166 format
Business code identified durin application registration
Channel where request originated
Session is generated and returned on the first API call of the key exchange (GET e2e call) as response header, which needs to be resent on succesive calls of same session.
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/bne/security/authenticate/challenge/validate
To authenticate customer by validating the challenge code for BNE
This API is used to authenticate customer by validating the challenge code for BNE
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
Country code in 2 character ISO 3166 format
Business code identified durin application registration
Channel where request originated
Session is generated and returned on the first API call of the key exchange (GET e2e call) as response header, which needs to be resent on succesive calls of same session.
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
{
"properties": {
"customerId": {
"description": "Unique identifier of the customer",
"type": "string",
"example": "123456789012"
},
"legalRepresentativeId": {
"description": "Unique identifier for corporate legal Representative",
"type": "string",
"example": "01"
}
},
"required": [
"customerId",
"legalRepresentativeId"
]
}
{
"properties": {
"challengeQuestion": {
"description": "Challenge code generated by the SPA service at server, which is used by the customer to generate the OTP",
"type": "string",
"example": "123456"
},
"expiryDuration": {
"description": "Challenge code expiry time",
"type": "string",
"example": "00:30"
}
}
}
{
"type": "object",
"required": [
"oneTimePasswordToken",
"mfaTransactionType",
"mfaTransactionId"
],
"properties": {
"oneTimePasswordToken": {
"description": "Validation code generated by hardware token",
"type": "string",
"example": "123456"
},
"mfaTransactionType": {
"description": "Field indicates the transaction type for which the authentication is requested, for Login or Risk Transaction",
"type": "string",
"enum": [
"LOGIN",
"RISK"
],
"default": "LOGIN"
},
"mfaTransactionId": {
"description": "The transaction to apply the challenge",
"type": "string",
"example": "1234567890"
}
}
}
{
"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"
},
"uuid": {
"description": "128 bit UUID that you generate for every request",
"type": "string"
},
"timestamp": {
"description": "Timestamp of the error",
"type": "string"
}
},
"required": [
"type",
"code"
]
}