API Enhancements

The below table provides details of API Enhancements and introduction of new APIs in Oracle Banking Party.

Table 1-7 API Enhancements

API Name API Description New/Existing Change
SMB Party Amendment (Granular) SMB - Party Amendment (Granular API) New Following New APIs are introduced for SMB Party type.
  • Contact Details:

    PATCH/ob/obpy/party/v1/smb/contactInfo

    PUT/ob/obpy/party/v1/smb/contactInfo

    POST/ob/obpy/party/v1/smb/contactInfo/.search

  • Address Details:

    PATCH/ob/obpy/party/v1/smb/addressInfo

    PUT/ob/obpy/party/v1/smb/addressInfo

    POST/ob/obpy/party/v1/smb/addressInfo/.search

  • Tax Information:

    POST/ob/obpy/party/v1/smb/taxInfo/.search

    PATCH/ob/obpy/party/v1/smb/taxInfo

    PUT/ob/obpy/party/v1/smb/taxInfo
SMB Party Amendment (PATCH) SMB Party Amendment with PATCH Operation New New API is introduced for SMB party amendment with PATCH operation.

APIs

/ob/obpy/party/v1/smb/amendParty
SMB Party Onboarding and Amendment

SMB - Party Onboarding

SMB - Party Amendment

 Existing

Impacted APIs

POST /service/v1/smb/onboardParty

POST /service/v1/smb/partyAmend

POST/ob/obpy/v1/party/.search

Following Data Segments are newly introduced in SMB Party type are added to APIs.
  • Contact Details
  • Tax Details
  • Consent & Preferences
  • Last Contact Date (Only Party Search API)
Insta APIs APIs to Onboard and Amend Party Information Existing (POST)
  • APIs are enhanced to create and update Related Party Relationship for Retail and SMB Party type.
  • New fields are introduced in the following data segments:
    • SMB
      • Auth Sig Relationship
      • Business Information
      • Current Address
      • Previous Address
    • Retail
      • Basic Info
      • Current Address
      • Previous Address
  • Record Identifier is introduced in the following data segments:
    • Retail Party
      • Current Address
      • ID Details
      • Contact Details
      • Employment Details
      • Service Member Info
    • SMB Party
      • Current Address
      • Contact Details
  • Preferred Contact Validation is changed from Contact Type to Contact Sub-Type for retail and smb party type.

Impacted APIs

POST - /service/v1/retail/onboardParty

POST - /service/v1/retail/partyAmend

POST - /service/v1/smb/onboardParty

POST - /service/v1/smb/partyAmend
Full PATCH API PATCH APIs to Amend Party Information Existing (PATCH)
  • APIs are enhanced to create and update Related Party Relationship for Retail and SMB Party type.
  • Preferred Contact Validation is changed from Contact Type to Contact Sub-Type.

Impacted APIs

  • /ob/obpy/party/v1/smb/amendParty

    • API is enhanced to create and update following party to party relationship.

      • Beneficiary Relationship
      • Trustee Relationship
      • Owner Relationship
      • Authorized Signatory Relationship
      • Supplier Relationship
      • Guarantor Relationship
      New fields are introduced in the following data segments:
      • Auth Sig Relationship
      • Business Information
      • Current Address
      • Previous Address
      Record Identifier is introduced in the following data segments:
      • Current Address
      • Contact Details
  • /ob/obpy/party/v1/retail/granular
    • API is enhanced to create and update the following Party to Party Relationship:
      • Household Relationship
      • Power or Attorney Relationship
      • Service Member Relationship
      • Related to Insider Relationship
      • Guardian Relationship
      • Custodian Relationship
      • Solicitor Relationship
      New fields are introduced in the following data segments:
      • Basic Info
      • Current Address
      • Previous Address
      Record Identifier is introduced in the following data segments:
      • Current Address
      • ID Details
      • Contact Details
      • Employment Details
      • Service Member Info
Granular APIs (Party to Party Relationship) APIs to create and update information at data segment level for Party-to-Party Relationship New (PATCH) The following PATCH APIs are introduced for Party-to-Party Relationship:
  • Retail

    Household: /ob/obpy/party/v1/partyToParty/household

    Power or Attorney: /ob/obpy/party/v1/partyToParty/poa

    Service Member: /ob/obpy/party/v1/partyToParty/servicemember

    Related to Insider: /ob/obpy/party/v1/partyToParty/relatedToInsider

    Guardian: /ob/obpy/party/v1/partyToParty/guardian

    Custodian: /ob/obpy/party/v1/partyToParty/custodian

    Solicitor: /ob/obpy/party/v1/partyToParty/solicitor

  • SMB

    Beneficiary: /ob/obpy/party/v1/partyToParty/beneficiary

    Trustee: /ob/obpy/party/v1/partyToParty/trustee

    Owner: /ob/obpy/party/v1/partyToParty/owner

    Authorized Signatory: /ob/obpy/party/v1/partyToParty/authorizedSignatory

    Supplier: /ob/obpy/party/v1/partyToParty/suppliers

    Guarantor: /ob/obpy/party/v1/partyToParty/guarantors

Granular APIs (Related Party Relationship) APIs to create and update Related Party-to-Party Relationship at data segment level New (POST, PUT, PATCH) The following APIs are introduced for Related Party Relationship:

/ob/obpy/party/v1/partyToParty/relatedParty/.search

/ob/obpy/party/v1/partyToParty/relatedParty/{id}

/ob/obpy/party/v1/partyToParty/relatedParty

/ob/obpy/party/v1/partyToParty/relatedParty
Granular API APIs to update party information at data segment level Existing (PUT, PATCH, POST)

  • New fields are introduced in basic Info data segment for Retail Party.

    Impacted APIs

    /service/v1/retail/basicInfo

    /ob/obpy/party/v1/retail/basicInfo/.search

  • New fields introduced in Business Information data segment for SMB Party.

    Impacted APIs

    /service/v1/smb/businessDetails

    /ob/obpy/party/v1/smb/businessDetails/.search

  • Preferred Contact Validation is changed from Contact Type to Contact Sub-Type for Retail and SMB Party.

    Impacted APIs

    /service/v1/retail/contactInfo

    /ob/obpy/party/v1/retail/contactInfo/.search

    /ob/obpy/party/v1/smb/contactInfo

    /ob/obpy/party/v1/smb/contactInfo/.search
Granular API (Party Info) API to update party information at data segment levels Existing (PUT, PATCH, POST) Record Identifier is introduced in the following data segments:
  • Retail Party
    • Current Address
    • ID Details
    • Contact Details
    • Employment Details
    • Service Member Info
  • SMB Party
    • Current Address
    • Contact Details

Impacted APIs

/service/v1/retail/addressInfo

/ob/obpy/party/v1/retail/addressInfo/.search

/service/v1/retail/idInfo

/ob/obpy/party/v1/retail/idInfo/.search

/service/v1/retail/contactInfo

/ob/obpy/party/v1/retail/contactInfo/.search

/service/v1/retail/employment

/ob/obpy/party/v1/retail/employment/.search

/ob/obpy/party/v1/retail/partyServiceMember

/ob/obpy/party/v1/retail/partyServiceMember/.search

/ob/obpy/party/v1/smb/addressInfo

/ob/obpy/party/v1/smb/addressInfo/.search

ob/obpy/party/v1/smb/contactInfo

/ob/obpy/party/v1/smb/contactInfo/.search
Delete API (Party to Party) API to Delete Party to Party Relatioship Decommissioned Party to Party Relationship delete API is decommissioned to avoid duplication with PATCH API.

Impacted APIs

/ob/obpy/party/v1/partyToParty/deleteRelationship
STP APIs APIs to Onboard and Amend Party Information Existing
  • API is enhanced to create and update Related Party Relationship
  • New Fields are introduced in following Data Segments
    • SMB
      • Auth Sig Relationship
      • Business Information
      • Current Address
      • Previous Address
    • Retail
      • Basic Info
      • Current Address
      • Previous Address
  • Record Identifier is introduced in the following data segments:
    • Retail Party
      • Current Address
      • ID Details
      • Contact Details
      • Employment Details
      • Service Member Info
    • SMB Party
      • Current Address
      • Contact Details
  • Preferred Contact validation is changed from Contact Type to Contact Sub-Type for Retail and SMB party type.

Impacted APIs

/service/v1/initiatePartyOnboarding

/service/v1/retail/amendParty/{partyId}
Tax Country Code APIs to get list of configured tax country codes New APIs are introduced to get list of Tax Country Codes and respective state codes configured.

Impacted APIs

/ob/obpy/maintenance/taxcountrycode

/ob/obpy/maintenance/taxstatecode/
Onboard and Amend API APIs to Onboard and Amend Party Information Existing New fields are introduced in the Employment Data Segment.

Impacted APIs

POST - /service/v1/retail/onboardParty

POST - /service/v1/retail/partyAmend

PATCH - /ob/obpy/party/v1/retail/granular

PUT/PATCH - /service/v1/retail/employment

POST - /ob/obpy/party/v1/retail/employment/.search

New Data Segments introduced for Additional Info and Consent & Preference

Impacted APIs

PATCH - /ob/obpy/party/v1/retail/granular
Party to Account API API to amend party to account relationship New (PATCH)

Impacted APIs

PATCH - /ob/obpy/party/v1/partyToAccount

Note: Party ID and Account Number for an existing Party to Account Relationship cannot be updated using PATCH Operation.

Consent & Preferences API to view and amend consent & preferences New (PUT, PATCH, POST)

Impacted APIs

PUT/PATCH - /ob/obpy/party/v1/retail/consentPreference

POST - /ob/obpy/party/v1/retail/consentPreference/.search

GET - /service/v1/retail/ consentPreference /{externalCustomerNo}
Additional Info API to view and amend additional info New (PUT, PATCH, POST for GET, GET)

Impacted APIs

PUT/PATCH - /ob/obpy/party/v1/retail/partyAddInfo

POST - /ob/obpy/party/v1/retail/partyAddInfo/.search

GET - /service/v1/retail/partyAddInfo/{externalCustomerNo}
Consumer APIs APIs to get and update consumer detail New(GET, PUT) These APIs are introduced to update consumer details and retrieve them.

Impacted APIs

(GET) ob/plato-edp-services/v1/consumers - API to get list of consumers

(GET) ob/plato-edp-services/v1/consumers/{id} - API to get unique consumer

(PUT) ob/plato-edp-services/v1/consumers/{id} - API to Update Consumer Status

Note:

For Non-PATCH operations for the data segments with respect to Record Identifier, following actions should be considered.
Amendment of Existing Record
  • Original Record Identifier should be provided along with the amended data.
  • If a new record identifier or null is provided for an existing record (matched based on ID column) request will be rejected as record identifier cannot be amended.

Create a New Record

To create a new record, provide:
  • A unique Record Identifier for the new record.
  • Other existing records (unaltered or amended, as described in Point 1 above).

If Existing records are not provided only the new record will be available in the Data segment.

Delete a Record

The request should include only the records to be retained or created. Any records not included will be deleted.

Note:

For PATCH operations for the Data Segments with respect to Record Identifier, following should be considered.
Amend an Existing Record
  • Attributes provided in the "param" section to identify unique record should not be amended in the "values" section.
  • Original Record Identifier should not be changed else the request will be rejected.
  • Associated Party ID in Party-to-Party relationship cannot be updated. A new relationship with the new associated party id should be created after deleting existing relationship.
Create a New Record
  • Record Identifier can be provided in request and the same will be stored. In case of duplicate, request will be rejected.
  • If Record Identifier is not provided, it will be generated by OBPY.
  • A deleted Record Identifier can be reused from service request. UI will not re-use deleted record identifiers.

Delete an Existing Record

Record will be deleted along with Record Identifier completely.

Table 1-8 Matrix for Param and Values

Matrix for Param and Values in Service Requests Operation (“op”) param values
add Not Required Required
replace Required Required
remove Required Not Required