This microservice will manage the functionalities related to citi screening process management, (request screening for a person/company and retrieve the alert disposition for the screening process). For compliance payloads are encrypted, please refer to CSMT-PDM-D-PScrn_DEFINITIONS.json document for the structure of request and response objects used in this service
Paths
/v1/customers/parties/screening
To initialize the request for citi screening process for the new customer or an existing customer.
This api is used to initialize the request for citi screening process for the new customer or an existing customer.
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
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/customers/parties/screening/alert
To retrieve the list of citi screening blacklisted customers matching with the new customer
This api is used to retrieve the list of citi screening blacklisted customers matching with the new customer
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
SessionId sent by Consumer.
query folio obtained from screning request encoded with URL encode. Example 'eP%2B8f%2Bd%2FmRtg%2BBC9%2FPyVZBc%3D.2ILYhCMV%2B4M%3D'
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/customers/parties/screening/alerts/disposition
this api will retrieve the citi screening list information
this api will retrieve the citi screening list information
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.
query folio obtained from screning request encoded with URL encode. Example 'eP%2B8f%2Bd%2FmRtg%2BBC9%2FPyVZBc%3D.2ILYhCMV%2B4M%3D'
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 |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Definitions
{
"type": "object",
"properties": {
"encryptedPartyScreeningRequestData": {
"description": "encrypted field containing the PartyScreeningRequest",
"type": "string",
"format": "byte",
"example": "%$YU(&$&%/%&8678&/g5667m67uv5gfhfgjhhg"
}
}
}
{
"type": "object",
"properties": {
"encryptedPartyScreeningResponseData": {
"description": "encrypted field containing the PartyScreeningResponse",
"type": "string",
"format": "byte",
"example": "%$YU(&$&%/%&8678&/g5667m67uv5gfhfgjhhg"
}
}
}
{
"type": "object",
"properties": {
"encryptedPartyScreeningMatchesData": {
"description": "encrypted field containing the PartyScreeningMatchesResponse",
"type": "string",
"format": "byte",
"example": "%$YU(&$&%/%&8678&/g5667m67uv5gfhfgjhhg"
}
}
}
{
"type": "object",
"properties": {
"encryptedPartyAlertsDispositionData": {
"description": "encrypted field containing the PartyAlertsDispositionResponse",
"type": "string",
"format": "byte",
"example": "%$YU(&$&%/%&8678&/g5667m67uv5gfhfgjhhg"
}
}
}
{
"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"
]
}