4.1 Using Customer Screening Real-time Request
The REST API is used to execute the Customer Screening Real-time Request.
End Point Details
- HTTP Link - http://<hostname>:<port>/csxe-real-time/executeRealTime
- Method – POST
- Content Type - Application/JSON
Executing Customer Screening Real-time Request
To execute Customer Screening Real-time Request, see Executing Customer Screening Realtime Request.
Request JSON Parameters
Parameter | Value Type | Description |
---|---|---|
Source Request ID |
String | Unique identification for the candidate. |
Applicant ID |
String | Unique identification of the candidate that needs to process. |
Candidate Jurisdiction |
String | The jurisdiction where the candidate wants to do business or operation. (Mandatory) |
Business Domain |
String | The corresponding business domain of the candidate client. (Mandatory) |
Data Origin |
String | Captures source system details responsible for onboarding requests. |
Organization Name |
String | Captures the first name of the organization |
SSN/TIN |
String | Social Security Number or Tax Identification Number. |
Country Of Incorporation |
String | Country of incorporation of the candidate organization. |
Country Of Taxation |
String | Country of Taxation of the candidate organization. |
Existing Internal ID |
String | Flag to indicate whether the candidate on boarded is an existing customer. |
Address of candidate |
String |
String Street line : The street address of the candidate. City: The city of candidate address. State : The state of candidate address. Country :The country of candidate address. Postal Code: The postal code of candidate address. |
Identification
Document |
String |
Document Type: Flag captures the document type of the document provided by the candidate. |
Integer |
Document Number: Flag captures the document number of the document provided by the candidate. |
|
String |
Issuing Country : Flag captures the document's issuing county of the document provided by the candidate. |
|
Candidate Type |
String | Type of the candidate. IND if Individual |
Response JSON Parameters
Parameter | Value Type | Description |
---|---|---|
Request ID |
Integer | Request ID generated for an individual. |
Request and Response JSON Samples
http://<hostname>:<port>/csxe-real-time/executeRealTime
{
"requestedBy":"user",
"requestJson":{
"Candidate":[
{
"Source Request ID" : "SRC1"
"Applicant ID":"",
"Candidate Jurisdiction":"AMEA",
"Business Domain":"GEN",
"Data Origin":"",
"First Name":"Ena Elizabeth",
"Middle Name":"",
"Last Name":"HERNANDEZ AMAYA",
"Title":"",
"Full Name":"HERNANDEZ AMAYA Ena Elizabeth",
"Alias":[
],
"Date Of Birth":"1978-09-03",
"SSN/TIN":"",
"Gender":"",
"Primary Citizenship":[
],
"Secondary Citizenship":[
],
"Country Of Birth":"",
"Country Of Residence":[
],
"Existing Internal ID":"",
"Address":[
{
"Street Line 1":"",
"City":"",
"State":"",
"Country":"",
"Postal Code":""
}
],
"Identification Document":[
{
"Document Type":"",
"Document Number":"",
"Issuing Country":""
}
],
"Candidate Type":"IND"
"searchWithCase": true
}
]
}
}