3.2 Invoking the KYC Onboarding Service

This section provides information on invoking the service and what happens after the service is invoked. The Request Details, Response Details, and Response Status Details for the Onboarding service are shown in Table 3, Table 4, Table 5, Table 6, and Table 7.

Table 3-1 Request Details

Parameter Name Parameter Value
Service URL

#HTTP_PROTOCOL#://#SERVER_NAME#:#

SERVER_PORT#/InitiateOnboardingService/OB

/Initiate

Method Type

POST

Authorization

Basic Auth

Content-Type

application/json

Table 4: Response Details

Table 3-2 Response Details

Parameter Name Parameter Value Comments

Response Content-

Type

application/json

Sample Response:

{

"RequestID": 1001, "applicationId": "CIF-200050799"

}

Table 5 shows the response status details as follows.

Table 5: Response Status Details

Table 3-3 Response Status Details

Response Status Codes Status Description Comments

Status 200

Request taken up for processing

Sample Response:

{

"RequestID": 1001, "applicationId": "CIF-200050799"

}

Status 401

Request Unauthorized

Sample Response:

{

"ERROR - ": "Authentication failed in

Initiate Onboarding"

}

Status 400

The incorrect input JSON structure

Sample Response:

{

"ERROR - ": "JSON input provided is blank/incorrect"

}

Status 400

Mandatory elements are not provided in the Input JSON

Sample Response:

{

"ERROR - ": "Either request user id or application Id are not provided. Please provide the same and retry"

}

Status 400

Invalid attributes in the Input JSON.

Sample Response:

[

#/properties/OnboardingCustomer/ properties/PrimaryCustomer : abcd does not match the allowed regex pattern (^[Y ]$).

]

Status 500

Mis-match in data lengths

Sample Response:

{

"ERROR: ": "SQL Error Occurred While

Saving Data In

FCC_OB_REQUEST:java.sql.SQLExcep tio n: ORA-12899: value too large for column

\"UT_ATOM\".\"FCC_OB_REQUEST\

".\"AP PLICATION_ID\" (actual: 1008, maximum: 255)\n"

}

If any errors are generated, the error message is sent back as a response with the error details mentioned. The errors must be corrected, and the input JSON must be resubmitted with the required corrections made to the Onboarding service.

Note:

Every submission is considered a new request by the system.

Following the successful invocation of the Onboarding service, the request is acknowledged with a unique request ID and the application ID. The Request ID can be used as a reference to:

  • Track the process on the Process Monitor page. For more information, see Monitoring the Process in the Process Modelling Framework (PMF).

  • Get the overall response from the Onboarding service once the Onboarding process is completed.

  • Perform the due diligence in KYC and ECM.

The Onboarding Callback service, as part of its response, provides the details of the specific Request ID in JSON format. The details of the Onboarding Callback service and the JSON elements are in Table 6. To get the overall response from the Onboarding service for a request, you must configure a new Task in PMF at the end of the KYC_ONBOARDING workflow to call your service, which accepts a JSON as input and in the format generated by the Onboarding calls back service.

To configure a task in PMF, follow these steps:
  1. Create a new service task at the end of the KYC_ONBOARDING workflow.
  2. Configure the Onboarding call back service as a Pre Rule.
  3. Configure your service as an Execution Rule and pass the output of the Pre Rule to this Execution Rule. This ensures that the overall Onboarding response is updated in the source/invoking system at the end of the process

Table 6: Onboarding Call Back Service Request Details

Table 3-4 Onboarding Call Back Service Request Details

Parameter Name Parameter Value Comments

Service URL

#HTTP_PROTOCOL#://

#SERVER_NAME#:#

SERVER_PORT#/TabletoJSONService/ TableToJ son/

createtabletojson?mappingId=KYCOB_R

ESP_1&re questId=#REQUEST_ID#

#HTTP_PROTOCOL#://

#SERVER_NAME#:#SE

RVER_PORT are implementation-specific and these are set during the installation process.

#REQUEST_ID# must be replaced with RequestID received as part of the Onboarding Service Response.

Method Type

POST

NA

Authorization
  • No Auth (Default)
  • Basic Auth
  • Bearer Token
  • No Auth is the default authorization.
  • If authorization is required, enable the flag in Manage KYC Installation Parameters for KYC Feedback Service.
  • Authorization can be either Basic Auth or Bearer Token.
  • A valid KYC Administrator User ID and Password must be used.

Table 3-5 Onboarding Call Back Service Response Details

Parameter Name Parameter Value Comments

Response

Content-Type

application/JSON

To view a sample response JSON, see KYC Onboarding Response JSON.

4. Monitor the Process in the Process Modelling Framework (PMF). Use the PMF page to view all processes triggered for a particular request ID. To access the Process Monitor page, follow these steps.

  • Log in as the KYC Administrator.
  • Click the Process Modelling Framework icon and then select Process Monitor.
  • On the Process Monitor page, click the request ID link for which you want to view the triggered processes.
  • A completed sub-process is marked with the icon icon.

Configuring/Modifying the PMF Flow for the Onboarding Service

  • If an error is displayed in the Process Monitor page against any task, check the server logs for further details on the error:
  • For a Tomcat server, the path is
    tomcat -/scratch/ofsaaapp/apache-tomcat-8.0.30/webapps/BD807KYC/ logs
  • For a Weblogic server, the path is
    
/scratch/ofsaebas/Oracle/Middleware/Oracle_Home/user_projects/ domains/KYC8071510/applications/KYC8071510.ear/KYC8071510.war/logs