Using Customer Screening Real-time Request

3.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.
`First name`	String	Captures the first name of the candidate. (Mandatory)
`Middle name`	String	Captures the middle name of the candidate.
`Last name`	String	Captures the Last name of the candidate. (Mandatory)
`Title`	String	Captures any titles of the candidate.
`Full name`	String	Captures the full name of the candidate.
`Alias`	String	Captures all aliases of the candidate. Can hold multiple aliases.
`Date of Birth`	String	Date of birth of an individual.
`Year of Birth`	String	Enter the year of birth of the candidate
`SSN/TIN`	String	Social Security Number or Tax Identification Number.
`Gender`	String	Gender of the candidate.
`Primary Citizenship`	String	Primary citizenship of the candidate. This field can hold multiple values.
`Secondary Citizenship`	String	Secondary citizenship of the candidate. This field can hold multiple values.
`Country Of Birth`	String	Country of birth of the candidate.
`Country Of Residence`	String	Country of residence of the candidate.
`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

Request Sample:

http://<hostname>:<port>/csxe-real-time/executeRealTime

Response Sample:


{


    "requestedBy":"user",


   "requestJson":{


      {


    "Candidate": [


        {


            "Source Request ID": "",


            "Applicant ID": "",


            "Candidate Jurisdiction": "",


            "Business Domain": "",


            "First Name": "",


            "Middle Name": "",


            "Last Name": "",


            "Title": "",


            "Full Name": "",


            "Alias": [],


            "Date Of Birth": "",


            "Year Of Birth": "",


            "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


        }


    ]


}