production
development
https://emea.sit.api.citi.com/gcb
Custom Gateway API Endpoint
Paths
/v1/clients/certificate/validation/{countryCode}
post /v1/clients/certificate/validation/{countryCode}
Regulatory
verify a client-TPP by its MTLS cert and validate if TPP is valid and allowed to access functional apis
Endpoint will be secured by way of Mutual Authentication over TLS
Accept
Required in header
string
Content-Type that are acceptable for the response.
client_id
Required in header
string
Client ID generated during application registration.
cert
Required in header
string
certificate .
Content-Type
Required in header
string
application/json
gurn
Optional in header
string
global unique reference ID of TPP .
scope
Optional in header
string
scope of functional API, which TPP requested.
uuid
Optional in header
string
uuid .
referenceId
Optional in header
string
referenceId .
countryCode
Required in path
string
countrycode applicable
ExecuteClientCertificateValidationRequest
Required in body
object
ExecuteClientCertificateValidationRequest
200
Successful operation.
400
| Type | Code | Details |
| invalid | invalidRequest | Missing or invalid Parameters |
401
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
500
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error |
Example Request
Example Response
POST https://emea.sit.api.citi.com/gcb/api/v1/clients/certificate/validation/{countryCode}
get /v1/clients/certificate/validation/{countryCode}
Regulatory
Retrive client-TPP details to validate client by MTLS cert
Endpoint will be secured by way of Mutual Authentication over TLS
Accept
Required in header
string
Content-Type that are acceptable for the response.
client_id
Required in header
string
Client ID generated during application registration.
cert
Required in header
string
certificate .
Content-Type
Required in header
string
application/json
countryCode
Required in path
string
200
Successful operation.
400
| Type | Code | Details |
| invalid | invalidRequest | Missing or invalid Parameters |
401
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
500
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error |
Example Request
Example Response
GET https://emea.sit.api.citi.com/gcb/api/v1/clients/certificate/validation/{countryCode}
Definitions
JWT format of OBClientRegistration1
{
"type": "string",
"format": "OBClientRegistration1"
}
Client registration
{
"allOf": [
{
"$ref": "#/definitions/OBRegistrationProperties1"
}
]
}
{
"properties": {
"isValid": {
"description": "Is client cert valid or not",
"type": "boolean"
},
"tppIdentifier": {
"description": "gurn number",
"type": "string"
},
"software_role": {
"description": "This refer to the role of the tpp in directory",
"type": "array",
"items": {
"type": "string"
},
"example": [
"PISP"
]
},
"scope": {
"description": "This refer to the scope for the tpp",
"type": "array",
"items": {
"type": "string"
},
"example": [
"payments"
]
}
}
}
Retrieve Client Response
{
"allOf": [
{
"$ref": "#/definitions/valideIDAS"
}
]
}
{
"type": "object",
"properties": {
"eIDAS": {
"type": "object",
"properties": {
"validity": {
"description": "OAuth 2.0 client identifier string",
"type": "object",
"properties": {
"validQTSP": {
"type": "boolean"
},
"validSignature": {
"type": "boolean"
},
"notRevoked": {
"type": "boolean"
},
"notExpired": {
"type": "boolean"
}
}
},
"data": {
"description": "OAuth 2.0 client secret string",
"type": "object",
"properties": {
"QTSPCommonName": {
"type": "string"
},
"authNumber": {
"type": "string"
},
"pspSubjectName": {
"type": "string"
},
"QTSPSource": {
"type": "string"
},
"QTSPJurisdiction": {
"type": "string"
}
}
}
}
},
"homeRegister": {
"type": "object",
"properties": {
"ncaName": {
"type": "string"
},
"ncaCountryCode": {
"type": "string"
},
"registerType": {
"type": "string"
},
"categoryEntries": {
"type": "object",
"properties": {
"categoryName": {
"type": "string"
},
"pspLegalName": {
"type": "string"
},
"pspAuthStatus": {
"type": "string"
},
"pspPaymentServices": {
"type": "array",
"items": {
"type": "integer"
}
},
"passportOut": {
"type": "object",
"properties": {
"countryCode": {
"type": "string"
},
"paymentServices": {
"type": "array",
"items": {
"type": "integer"
}
}
}
}
}
}
}
},
"hostRegister": {
"type": "object",
"properties": {
"ncaCountryCode": {
"type": "string"
},
"registerType": {
"type": "string"
},
"categoryEntries": {
"type": "string"
},
"warning": {
"type": "string"
}
}
}
}
}
{
"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"
},
"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"
}
},
"required": [
"type",
"code"
]
}