1.3 Retail Party Onboarding

Upon completion of the retail party onboarding process, the system publishes a notification for the Retail Party Onboarding event, notifying Party Management of a new retail party. Retail Party Onboarding event is published only for Retail parties.

Topic Name

obpyRetOnboard

Avro Format

{
"namespace": "avro.oracle.fsgbu.plato.eventhub.events",
"name": "ObpyRetOnboardGenerated",
"type": "record",
"fields" :     
    [
    {"name": "branchCode", "type": "string"},
    {"name": "userId", "type":["null","string"]},
    {"name": "date","type":["null","string"]},
    {"name": "time", "type": ["null","string"]},
    {"name": "applicationNumber", "type": "string"},
    {"name": "handoffStatus", "type": "string"},
    {"name": "sourceProductId", "type": "string"},
    {"name": "eventType", "type": "string"},
    {"name": "externalCustomerNumber", "type": "string"},
    {"name": "isKycCompliant", "type": "string"},
    {"name": "partyCategory", "type": "string"},
    {"name": "partyId", "type": "string"},
    {"name": "partyType", "type":["null","string"]},
    {"name": "rmId","type":["null","string"]},
    {"name": "firstName", "type": "string"},
    {"name": "middleName", "type": "string"},
    {"name": "lastName", "type": "string"},
    {"name": "residentStatus", "type": "string"},
    {"name": "uniqueId", "type": "string"},
    {"name": "customerSegment", "type": "string"},
    {"name": "partySubType", "type": "string"},
    {"name": "isCustomer", "type": "string"},
    {"name": "isStaff", "type":["null","string"]},
    {"name": "isInsider","type":["null","string"]},
    {"name": "isSpecial", "type": "string"},
    {"name": "isArmedForce", "type": "string"},
    {"name": "isPep", "type": "string"},
    {"name": "isMla", "type": "string"},
    {"name": "isMinor", "type": "string"},
    {"name": "isBlacklisted", "type": "string"},
    {"name": "isProspect", "type": "string"},
    {"name": "amendDateTime", "type": "string"},
    {"name": "applicationDate", "type": "string"}
    ]
}

Request Header

ContentType:application/json

Accept:application/json

userId:XXXXX

branchCode:000

authToken:token

entityId:DEFAULTENTITY

handoffStatus:SUCCESS

appId:PRTONB

Request Payload

{
    "branchCode" : "000",
    "userId" : "XXXXX",
    "date" : "18052023",
    "time" : "14.24.25",
    "applicationNumber" : "xxxxx",
    "handoffStatus" : "onboard",    
    "sourceProductId": "OBPY",
    "eventType" : "onboard",
    "externalCustomerNumber" : "xxxxx",
    "isKycCompliant" : "true",
    "partyCategory" : "retail",
    "partyId" : "xxxxx",
    "partyType" : "retail",
    "rmId" : "xxxxx",
    "firstName" : "xxxxx",
    "middleName" : "xxxxx",
    "lastName" : "xxxxx",
    "residentStatus" : "Permanent",
    "uniqueId" : "xxxxx",
    "customerSegment" : "Affluent",
    "partySubType" : "retail",
    "isCustomer" : "true",
    "isStaff" : "true",
    "isInsider" : "true",
    "isSpecial" : "true",
    "isArmedForce" : "true",
    "isPep" : "true",
    "isMla" : "true",
    "isMinor" : "true",
    "isBlacklisted" : "true",
    "isProspect" : "true"    
}

Sample Event

{"branchCode": "000", "userId": "XXXXX", "date": "18052023", "time": "14.24.25", "applicationNumber": "xxxxx", "handoffStatus": "onboard", "sourceProductId": "OBPY", "eventType": "onboard", "externalCustomerNumber": "xxxxx", "isKycCompliant": "true", "partyCategory": "retail", "partyId": "xxxxxx", "partyType": "retail", "rmId": "xxxxx", "firstName": "xxxxx", "middleName": "xxxxx", "lastName": "xxxxx", "residentStatus": "Permanent", "uniqueId": "xxxxx", "customerSegment": "Affluent", "partySubType": "retail", "isCustomer": "true", "isStaff": "true", "isInsider": "true", "isSpecial": "true", "isArmedForce": "true", "isPep": "true", "isMla": "true", "isMinor": "true", "isBlacklisted": "true", "isProspect": "true", "amendDateTime": "20231005T09:52:32.887729300", "applicationDate": "20200326"}

Event Attributes

Table 1-3 Event Attributes

Attribute	Description	Values
branchCode	Branch Code, where party is onboarded using Oracle Banking Party Management application.
userId	User ID of the user, who is onboarding party using Oracle Banking Party Management application.
date	Date and Time of Party Onboarding.
applicationNumber
handoffStatus	Status of party onboarding in Oracle Banking Party Management such as completed, failed, etc.
sourceProductId	Transaction initiation source product ID such as Oracle Banking Party Management.
eventType	Action for which even is published.
externalCustomerNumber	Customer Identification number generated by external system, in case party information is handed off to external systems/backend system. Else, party id generated by Oracle Banking Party Management.
isKycCompliant	Flag to identify, if party is KYC compliant.
partyCategory	Category of Party. Party category is a configurable entity code.
partyId	Unique Party ID generated by Oracle Banking Party Management.
partyType	Party Type as captured in Oracle Banking Party Management. Following are the party types supported. Retail Small and Medium Business Small and Medium Enterprise Corporate Financial Institution	Following values should be available in notification based on party type. I Retails Party S Small and Medium Business E Small and Medium Enterprise C Corporate Party B Financial Institution
rmId	ID of the relationship manager assigned to party.
firstName	First Name of the party.
middleName	Middle Name of the party.
lastName	Last Name of the party.
residentStatus	Residential status of the party.
uniqueId	Unique Identifier as captured during party onboarding.	Only the preferred ID should be provided in notification.
customerSegment	Segment of Party. Party Segment is a configurable entity code.
partySubType	SubType of Party. Party subtype is a configurable entity code.
isCustomer	Flag to identify, if party is a full customer to the financial institution	Y / N
isStaff	Flag to identify, if party is a staff of financial institution	Y / N
isInsider	Flag to identify, if party is an insider to an organization	Y / N
isSpecial	Flag to identify, if party is specially abled	Y / N
isArmedForce	Flag to identify, if party belongs to armed forces.	Y / N
isPep	Flag to identify, if party is politically exposed	Y / N
isMla	Flag to identify, if party is covered under military benefits.	Y / N
isMinor	Flag to identify, if party is a minor customer.	Y / N
isBlacklisted	Flag to identify, if party is blacklisted.	Y / N
isProspect	Flag to identify, if party is a prospect.	Y / N
amendDateTime	Date of Amendment.
applicationDate	Date of Application.