Paths
/v1/channels/account-opening/dps/agents/entitlements/validate
LOB: Account Opening; Feature: Agent Digital Package Services; Functionality: Validate checker executive credential.
Validates executive faculty to allow the digital services activation; Frontend DPS; Backend Digital Package Services; entry-point; post-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
Business code identified during application registration
Country code in 2 character ISO 3166 format
Channel where request originated
SessionId sent by Consumer
Content-Types that are sent in the request
Client ID generated during application registration
The Authorization Token received during login
The checker agent request
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/channels/account-opening/dps/checker-agents/entitlements
LOB: Account Opening; Feature: Agent Digital Package Services; Functionality: Save
This api saves the name and soeid for the checker agent; Frontend Digital Package Services; Backend Digital Package Services; entry-point; post-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
Business code identified during application registration
Country code in 2 character ISO 3166 format
Channel where request originated
SessionId sent by Consumer
Content-Types that are sent in the request
Client ID generated during application registration
The Authorization Token received during login
The checker agent request
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/channels/account-opening/dps/checker-agents/sessions/{serverSessionId}/status
LOB: Account Opening; Feature: Agent Digital Package Services; Functionality: Retrieve checker message.
This api retrieves the status code of the checker authentication that is saved on gemfire transaction; Frontend Digital Package Services; Backend Digital Package Services;
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 during application registration
Channel where request originated
SessionId sent by Consumer
Server Session Id refers to an identifier or code which uniquely identifies a specific session across Citi globally.
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
Operator information to make a login SSO request
{
"type": "object",
"properties": {
"serverSessionId": {
"description": "Server Session Id refers to an identifier or code which uniquely identifies a specific session across Citi globally.",
"type": "string",
"example": "DS20210811000000001065640",
"maxLength": 50
},
"payrollId": {
"type": "string",
"description": "Employee payroll",
"example": "00997562"
},
"agentId": {
"type": "string",
"description": "Employee SOEID",
"example": "AP95411",
"minLength": 3,
"maxLength": 8
},
"encryptedPasswordText": {
"type": "string",
"description": "The security word text",
"example": "wer786dssdfsdaerwerwsdf87"
},
"userIpAddress": {
"type": "string",
"example": "127.0.0.1",
"description": "IP Address of the user device"
}
},
"required": [
"payrollId",
"encryptedPasswordText"
]
}
Operator information to save in gemfire and DataBase
{
"type": "object",
"properties": {
"serverSessionId": {
"description": "Server Session Id refers to an identifier or code which uniquely identifies a specific session across Citi globally.",
"type": "string",
"example": "DS20210811000000001065640",
"maxLength": 50
},
"agentId": {
"type": "string",
"description": "Employee SOEID",
"example": "AP95411",
"minLength": 3,
"maxLength": 8
},
"agentFullName": {
"type": "string",
"description": "Employee name",
"example": "Alberto Peralta Mora",
"minLength": 3,
"maxLength": 200
}
}
}
Operator information to retrieve status code of agent checker authentication of gemfire
{
"type": "object",
"properties": {
"processStatusCode": {
"description": "process status code is the code that identify if the login checker was successful",
"type": "string",
"example": "200",
"enum": [
"200",
"201",
"203",
"204"
]
}
}
}
{
"properties": {
"type": {
"type": "string",
"enum": [
"ERROR",
"WARN",
"INVALID",
"FATAL"
],
"description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously
error - The request was accepted but could not be processed successfully
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as 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"
}
},
"required": [
"type",
"code"
]
}