About the REST APIs

You can use Oracle REST APIs to view data stored in Oracle  Cloud Service. A REST API (also known as RESTful API) is an application programming interface (API or web API) that conforms to the constraints of REST architectural style and allows for interaction with RESTful web services.

Oracle Customer Screening Cloud Service provides a Representational State Transfer (REST) API to perform user tasks in an automated manner. The REST API is an application-programming interface that provides a simplified way to exchange data through HTTP requests from a client to the server. In REST APIs, a resource is an object with a type, associated data, and relationships to other resources. You can use a set of HTTP methods to access each resource.

Resources are organized in a hierarchical structure that enables:

·        Better organization, by grouping related data so that you can efficiently customize the resources.

·        Improved performance by using a single HTTP request to handle multiple resources.

Customer Screening REST APIs

Post Real-Time Customer Screening

This REST API is used to execute Realtime Screening.

·        Method: POST

·        Path: /csxe-real-time/executeRealTime

Get Real-Time Customer Screening Events

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

·        Method: GET

·        Path: /csxe-real-time/RTEvents/getForRequestId/{requestId}