1.2.7.2 API Enhancements
Table 1-3 API Enhancements
| Summary | Description | url |
|---|---|---|
| Granular API's | Granular API with the method as PUT, PATCH, and GET
has been introduced for following data segments amendment.
|
PUT & PATCH (Tax Declaration) /service/v1/retail/taxInfo GET (Tax Declaration) /ob/obpy/party/v1/retail/taxInfo/.search PUT & PATCH (Employment Details) /service/v1/retail/employment GET (Employment Details) /ob/obpy/party/v1/retail/employment/.search PUT & PATCH (Service Member Information) /ob/obpy/party/v1/retail/partyServiceMember GET (Service Member Information) /ob/obpy/party/v1/retail/partyServiceMember/latest PUT & PATCH (Business Details) /service/v1/smb/businessDetails GET (Business Details) /ob/obpy/party/v1/smb/businessDetails/.search |
| POST Method for GET API's | Newly introduced POST API's handle data retrieval operations that were previously performed using GET requests. API's keep sensitive information from the URL and send data in the body of POST requests to improve security. |
POST /ob/obpy/party/v1/partyDemographics/.search POST /ob/obpy/party/v1/partyDemographicsDataSegmentSummary/.search POST /ob/obpy/party/v1/generatePartyId/.search POST /ob/obpy/party/v1/partyDemographics/rm/.search POST /ob/obpy/party/v1/retail/customerDetails/.search POST /ob/obpy/v1/party/.search POST /ob/obpy/party/v1/party/replication/.search POST /ob/obpy/party/v1/retail/customerRefresh/.search POST /ob/obpy/party/v1/partyDemographics/parent/main/.search POST /ob/obpy/party/v1/partyDemographics/externalCustomerNo/.search POST /ob/obpy/party/v1/partyDemographics/parent/externalCustomerNo/.search POST /ob/obpy/party/v1/txPartyDemographics/externalCustomerNo/.search POST /ob/obpy/party/v1/getCorpParty/.search POST /ob/obpy/party/v1/getSMEParty/.search POST /ob/obpy/party/v1/corporate/customerRefresh/.search POST /ob/obpy/party/v1/authorizedSignatory/.search POST /ob/obpy/party/v1/stakeholderNames/.search POST /ob/obpy/party/v1/customerSign/.search POST /ob/obpy/v1/partyInfo/.search POST /ob/obpy/party/v1/partyStatus/.search POST /ob/obpy/party/v1/address/latest/.search POST /ob/obpy/party/v1/kycStatus/.search POST /ob/obpy/party/v1/customerimage/.search POST /ob/obpy/party/v1/customeremployment/.search POST /ob/obpy/party/v1/customercontactinfo/.search POST /ob/obpy/party/v1/customermedia/.search POST /ob/obpy/party/v1/customerhousehold/.search POST /ob/obpy/party/v1/customerdemographics/.search POST /ob/obpy/party/v1/customersignimage/.search POST /ob/obpy/party/v1/lastContactDate/.search POST /ob/obpy/party/v1/retail/basicInfo/.search POST /ob/obpy/party/v1/retail/addressInfo/.search POST /ob/obpy/party/v1/retail/idInfo/.search POST /ob/obpy/party/v1/retail/taxInfo/.search POST /ob/obpy/party/v1/retail/employment/.search POST /ob/obpy/party/v1/smb/businessDetails/.search POST /ob/obpy/party/v1/retail/contactInfo/.search POST /ob/obpy/party/v1/partyToAccount/.search POST /ob/obpy/party/v1/memo/.search |
| API's for Memo/Notes | New API's are introduced to create and update memos/notes. |
POST /service/v1/memo/addMemo GET /service/v1/memo/getAllMemo PUT /service/v1/memo/{id} |
| Party to Party Relationship | Users can now create, update, and delete relationships between retail parties, designating one as the primary party and the other as the related party. |
POST /ob/obpy/party/v1/partyToParty/household/.search PUT /ob/obpy/party/v1/partyToParty/household/{id} POST /ob/obpy/party/v1/partyToParty/household POST /ob/obpy/party/v1/partyToParty/poa/.search PUT /ob/obpy/party/v1/partyToParty/poa/{id} POST /ob/obpy/party/v1/partyToParty/poa POST /ob/obpy/party/v1/partyToParty/serviceMember/.search PUT /ob/obpy/party/v1/partyToParty/serviceMember/{id} POST /ob/obpy/party/v1/partyToParty/serviceMember POST /ob/obpy/party/v1/partyToParty/guardian/.search PUT /ob/obpy/party/v1/partyToParty/guardian/{id} POST /ob/obpy/party/v1/partyToParty/guardian POST /ob/obpy/party/v1/partyToParty/solicitor/.search PUT /ob/obpy/party/v1/partyToParty/solicitor/{id} POST /ob/obpy/party/v1/partyToParty/solicitor POST /ob/obpy/party/v1/partyToParty/relatedToInsider/.search PUT /ob/obpy/party/v1/partyToParty/relatedToInsider/{id} POST /ob/obpy/party/v1/partyToParty/relatedToInsider |
| Insta Amendment API for Retail (PATCH) | The Insta Amendment API introduces support for
field-level amendments to retail party information using the PATCH
operation type. User can manage party data more precisely and
efficiently with this feature, allowing for more granular updates
and enhancing flexibility.
Note: Insta Amendment API (PATCH) will only support the Data segments individually supported for Retail by PATCH operation. |
PATCH /ob/obpy/party/v1/retail/granular |
| Party to Account Delete | Users can now delete Party to Account relationships through the enhanced Party to Account feature. Users can efficiently manage party-account associations and remove relationships as needed, providing greater flexibility and control over this process. |
DELETE /ob/obpy/party/v1/partyToAccount/{id} |
Parent topic: Party