CCP Security - E2E Key

CCP Security - E2E Key 1.0.0-rev3

0
No votes yet
Security

The API's defined here are used for the security - encryption features

forum Discuss this API in the forum
production
development
https://api.banamex.com/mx-gcgapi

Paths

/security/e2eKey

get /security/e2eKey

Certificate retrieval from the system

This API would retrieve the exponent / modulus for encrypting the password

To use this operation you must use one of the following sets of security requirements.
Client ID (Query)
client_id
(apiKey located in query)
OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)
Token URL
https://api.banamex.com/mx-gcgapi/api/v1/oauth/token
Scopes
/api/v1
Default scope
Client ID
X-IBM-Client-Id
(apiKey located in header)
OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)
Token URL
https://api.banamex.com/mx-gcgapi/api/v1/oauth/token
Scopes
/api/v1
Default scope
uuid
Required in header
string

A 128 bit universally unique identifier (UUID) that you generate for every request and is used for tracking. It is recommended to use the output from Java UUID class or an equivalent.

{
    "default": "a7d1e304-83a9-4413-af97-62615e57eae66807840"
}
Accept
Required in header
string

Content-Types that are acceptable for the response. Currently we support application/json

{
    "default": "application\/json"
}
Content-Type
Required in header
string

Content-Type in http header. Currently we support application/json

{
    "default": "application\/json"
}
Accept-Language
Required in header
string

HTTP Accept-Language header

{
    "default": "en-US"
}
countryCode
Required in header
string

2 character ISO country code

{
    "default": "AU"
}
businessCode
Required in header
string

3 character business code

{
    "default": "GCB"
}
channelId
Required in header
string

channel ID used by the user

{
    "default": "CML"
}
sid
Optional in header
string

sid

{
    "default": "abbb4837-8343-418c-93d8-77a8519dff9e"
}
client_id
Required in header
string

The client ID you received during application registration in the developer portal

{
    "default": "iX4xW5lG0gD6cX3uI5qN3pF6yK5nY2kB0eY5tB3xQ4rD4fD2xO"
}
client_secret
Required in header
string

Client Secret generated during application registration

{
    "default": "iX4xW5lG0gD6cX3uI5qN3pF6yK5nY2kB0eY5tB3xQ4rD4fD2xO"
}
200

Customer phone successfully retrieved

E2ESuccessResponse
400

(BAD REQUEST) - Request was not processed

403

(FORBIDDEN) - Unauthorized to perform the requested operation on resource.

500

(INTERNAL SERVER ERROR) - API Server Error.

Example Request
Example Response
GET https://api.banamex.com/mx-gcgapi/api/v1/security/e2eKey

Definitions 

{
    "properties": {
        "modulus": {
            "description": "This is the public key modulus",
            "example": "000000000001704858800000000000170485880000000000017048588",
            "type": "string"
        },
        "exponent": {
            "description": "This is the public key exponent",
            "example": "3",
            "type": "string"
        }
    },
    "required": [
        "modulus",
        "exponent"
    ],
    "type": "object"
}