Getting Started

· Technical and functional knowledge to understand and execute the REST APIs and configuration knowledge.

· Knowledge of an interactive and automatic tool for verifying the APIs such as Postman.

Obtain Account Information

The account creation e-mail from Oracle contains the identity domain name for the Oracle Know Your Customer Cloud instance. If you do not have this information, then contact your service administrator.

Authentication

Ensure that you have the appropriate log-in credentials for accessing the Oracle FCCM Know Your Customer cloud service, and the appropriate role for creating, managing, and deleting service instances.

Getting Authentication

2. Go to Component Details and click AUTH tab. The Client ID and Client Password details are displayed.

4. Open Postman or relevant API tools. Select POST method and paste the URL: https://ip:port/oauth2/v1/token.

5. Click the Authorization tab. Go to the Type field and select Basic Auth from the drop-down list. The User name and Password fields are displayed.

11. Click Send. An Authorization token is generated in the Response body. For example, <eyJ4NXQjUzI1NiI6Ikk3cWxndm1Kal...>

Executing Real-Time KYC Risk Assessment Request

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:

You will get a response as an integer value (for example, "requestId": 141) which has to be passed in the Get KYC Prospect Feedback API {requestID}. For more information, see Get Real-Time KYC Prospect Feedback by Request ID section.

Executing Get Real-Time KYC Prospect Feedback by Request ID

To execute Get Real-Time KYC Prospect Feedback by Request ID, follow these steps:

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:

Supported Methods

Media Types

The following media type is supported by the Oracle Know Your Customer Cloud REST API:

Supported Headers

The REST API supports headers that may be passed in the header section of an HTTP request or response.

The following table provides information about supported headers.

Table : Supported Headers
Headers	Description	Example
Content-Type	The media type of the body of the request. Required for POST and PUT requests, and the supported types vary with each endpoint.	Content-Type: application/json
Accept	The media type of the body of the response.	Accept: application/json
X-ID-TENANT-NAME	The identity domain name of the service used for authentication.	X-ID-TENANT-NAME: ExampleIdentityDomain

Status Code

When you call the Oracle Know Your Customer Cloud REST resources, the Response header returns one of the standard HTTP status codes.

The following table lists the common HTTP response codes.

Table: Status Code

HTTP Status Code	Description
200 OK	The request was successfully completed. A 200 status is returned for a successful GET or POST method.
201 Created	The request has been fulfilled and resulted in a new resource being created. The response includes a Location header containing the canonical URI for the newly created resource. A 201 status is returned from a synchronous resource creation or an asynchronous resource creation that completed before the response was returned.
202 Accepted	The request has been accepted for processing, but the processing has not been completed. The request may or may not eventually be acted upon, as it may be disallowed at the time processing actually takes place. When specifying an asynchronous (__detached=true) resource creation (for example, when deploying an application), or update (for example, when redeploying an application), a 202 is returned if the operation is still in progress. If __detached=false, a 202 may be returned if the underlying operation does not complete in a reasonable amount of time.
400 Bad Request	The request could not be processed because it contains missing or invalid information (such as, a validation error on an input field, a missing required value, and so on).
401 Unauthorized	The request is not authorized. The authentication credentials included with this request are missing or invalid.
403 Forbidden	The user cannot be authenticated. The user does not have authorization to perform this request.
404 Not Found	The request includes a resource URI that does not exist.
405 Method Not Allowed	The HTTP verb specified in the request (DELETE, GET, POST, PUT) is not supported for this request URI.
406 Not Acceptable	The resource identified by this request is not capable of generating a representation corresponding to one of the media types in the Accept header of the request. For example, the client's Accept header request XML be returned, but the resource can only return JSON.
409 Conflict	The client???s ContentType header is not correct (for example, the client attempts to send the request in XML, but the resource can only accept JSON).
415 Not Acceptable	The client's ContentType header is not correct (for example, the client attempts to send the request in XML, but the resource can only accept JSON).
500 Internal Server Error	The server encountered an unexpected condition that prevented it from fulfilling the request.
503 Service Unavailable	The server is unable to handle the request due to temporary overloading or maintenance of the server. The REST web application is not currently running.

KEY	VALUE
grant_type	client_credentials
scope	urn:opc:idm:__myscopes__

KEY	VALUE
Postman-Token	client_credentials
scope	urn:opc:idm:__myscopes__
Content-Type	application/x-www-form-urlencoded
Content -Length	<calculated when request is sent>
Host	<calculated when request is sent>
User-Agent	PostmanRuntime/7.28.0
Accept	/
Accept-Encoding	gzip,deflate,br
Connection	keep-alive