Real Time Customer Screening JSON Service (Entity)

Topics:

·        Using Customer Screening Real-time Request

·        Using Customer Screening GET RT Events Request

Using Customer Screening Real-time Request

·        End Point Details

·        Executing Customer Screening Real-time Request

·        Request JSON Parameters

·        Response JSON Parameters

·        Request and Response JSON Sample

End Point Details

This REST API is used to execute Real-time Screening.

·        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, follow these steps:

1.     Open Postman or relevant tool.

2.     Copy only the Authorization token that you got from the Authentication request.

3.     Go to Header.

4.     Enter KEY as a Authentication and Description as a bearer (Authorization token) <eyJ4NXQjUzI1NiI6Ikk3cWxndm1Kal...>.

5.     Send a request using the POST method. The request must be in the following format:

§       HTTP Link: http://hostname:port/api.

§       Path: /csxe-real-time/executeRealTime

You will get a response as an integer value (for example, "requestId": 141) which has to be passed in the Get RTevent API {requestID}.

For more information, see Using Customer Screening GET RT Events Request.

 

Request JSON Parameters

This section provides the list of parameters for request JSON.

NOTE: Parameters marked with * Asterisks are mandatory.

 

·        Source Request ID

·        Applicant ID

·        Candidate Jurisdiction*

·        Business Domain*

·        Data Origin

·        Organization Name

·        SSN/TIN

·        Country Of Incorporation

·        Country Of Taxation

·        Existing Internal ID

·        Address of candidate

·        Identification Document

·        Candidate Type

Response JSON Parameters

This section provides the list of parameters for response JSON.

The following parameter explains the Response field for csxe-real-time/executeRealTime.

·        Request ID

The following list explains the Response fields for individual - csxe-real-time/RTEvents/getForRequestId/{requestid}

·        Event List

§       Event Score

§       Bus Domain*

§       Jurisdiction

§       Watchlist SKey

§       Watch ListJson

§       Event Matches  

·        Case ID

Request and Response JSON Sample

Request JSON Sample

Sample

Response JSON Sample

Sample

 

Using Customer Screening GET RT Events Request

Topics:

·        End Point Details

·        Executing Customer Screening GET RT Events Request

·        Request JSON Parameters

·        Response JSON Parameters

·        Request and Response JSON Sample

End Point Details

This REST API is used to get real-time events.

·        HTTP Link -http://<hostname>:<port>/csxe-real-time/RTEvents/getForRequestId/{requestid}

·        Method – GET

·        Content-Type - Application/JSON  

Executing Customer Screening GET RT Events Request

To execute RT event request, follow these steps:

1.     Open Postman or relevant tool. 

2.     Copy only the Authorization token that you got from the Authentication request.

3.     Go to the Header tab.

4.     Enter KEY as an Authentication and Description as a bearer (Authorization token) <eyJ4NXQjUzI1NiI6Ikk3cWxndm1Kal...>. .

5.     Send a request using the GET method. The request must be in the following format:

§       HTTP Link:http://hostname:port/api.

§       Path : csxe-real-time/RTEvents/getForRequestId/{requestID}

Use the request ID generated in Executing Customer Screening Real-time Request.

You will get a response as an event generated for the particular request ID.

Request JSON Parameters

The following parameter explains the Response field for csxe-real-time/executeRealTime.

·        Request ID

Response JSON Parameters

The following list explains the Response fields for individual - csxe-real-time/RTEvents/getForRequestId/{requestid}

·        Event List

§       Event Score

§       Bus Domain*

§       Jurisdiction

§       Watchlist SKey

§       Watch ListJson

§       Event Matches  

·        Case ID

Request and Response JSON Sample

Request JSON Sample

Sample

Response JSON Sample

Sample