1.2.8.2 API Enhancements
Table 1-5 API Enhancements
API Name | API Description | New/Existing | Change |
---|---|---|---|
Retail Party Onboarding and Amendment |
Retail - Party Onboarding Retail - Party Amendment |
Existing |
Impacted APIs POST /service/v1/retail/onboardParty POST /service/v1/retail/partyAmend New fields are added in following data models.
|
Retail Party Amendment (Granular) | Retail - Party Amendment (Granular API) | Existing |
Impacted APIs PATCH /ob/obpy/party/v1/retail/granular New fields are added in following data models.
|
SMB Party Onboarding and Amendment |
SMB - Party Onboarding SMB - Party Amendment |
Existing |
Impacted APIs POST /service/v1/smb/onboardParty POST /service/v1/smb/partyAmend New fields are added in following data models.
|
Retail Party – Basic Info (Granular API) |
|
Existing |
New fields are added to following APIs. Impacted APIs PATCH /service/v1/retail/basicInfo PUT /service/v1/retail/basicInfo POST /ob/obpy/party/v1/retail/basicInfo/.search |
Retail Party – Address Info (Granular API) |
|
Existing |
New field is added to following APIs. Impacted APIs PATCH /service/v1/retail/addressInfo PUT /service/v1/retail/addressInfo POST /ob/obpy/party/v1/retail/addressInfo/.search |
Retail Party – Contact Info (Granular API) |
|
Existing |
New fields are added to following APIs Impacted APIs PATCH /service/v1/retail/contactInfo PUT /service/v1/retail/contactInfo POST /ob/obpy/party/v1/retail/contactInfo/.search |
Retail Party – Tax Info (Granular API) |
|
Existing |
New fields are added to following APIs. Impacted APIs PATCH /service/v1/retail/taxInfo PUT /service/v1/retail/taxInfo POST /ob/obpy/party/v1/retail/taxInfo/.search |
Retail Party – Employment Info (Granular API) |
|
Existing |
New fields are added to following APIs. Impacted APIs PATCH /service/v1/retail/employment PUT /service/v1/retail/employment POST /ob/obpy/party/v1/retail/employment/.search |
SMB Party – Business Details (Granular API) |
|
Existing |
New fields are added to following APIs. Impacted APIs PATCH/service/v1/smb/businessDetails PUT/service/v1/smb/businessDetails POST/ob/obpy/party/v1/smb/businessDetails/.search |
Party to Party Relationship |
|
Existing |
New fields are added to following APIs. Impacted APIs 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/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/custodian/.search PUT/ob/obpy/party/v1/partyToParty/custodian/{id} POST/ob/obpy/party/v1/partyToParty/custodian POST/ob/obpy/party/v1/partyToParty/relatedToInsider/.search PUT/ob/obpy/party/v1/partyToParty/relatedToInsider/{id} POST/ob/obpy/party/v1/partyToParty/relatedToInsider |
Party to Account |
|
Existing |
New fields are added to following APIs. Impacted APIs POST/ob/obpy/party/v1/partyToAccount/.search POST/ob/obpy/party/v1/partyToAccount PUT/ob/obpy/party/v1/partyToAccount |
Last Contact Date | Update Last Contact Details | Existing |
New fields are added to following APIs. POST /service/v1/lastContactDate PUT /service/v1/lastContactDate POST /ob/obpy/party/v1/lastContactDate/.search |
Party to Party Relationship |
|
New |
Following new APIs are introduced for beneficiary and trustee party to party relationship. APIs POST/ob/obpy/party/v1/partyToParty/trustee/.search PUT/ob/obpy/party/v1/partyToParty/trustee/{id} POST/ob/obpy/party/v1/partyToParty/trustee POST/ob/obpy/party/v1/partyToParty/beneficiary/.search PUT/ob/obpy/party/v1/partyToParty/beneficiary/{id} POST/ob/obpy/party/v1/partyToParty/beneficiary |
Party to Party Relationship | Delete an existing relationship | New |
Following new API is introduced to delete an existing party to party relationship. APIs POST/ob/obpy/party/v1/partyToParty/deleteRelationship |
Parent topic: Party