Get Party application aggregate details
get
/party-services/web/v1/partyapplication/customer/{customerNumber}
Add additional information here for the this endpoint.
Request
Supported Media Types
- application/json
- application/xml
Path Parameters
-
customerNumber(required): string
Customer number for which Party application data needs to be fetched
Response
Supported Media Types
- application/json
- application/xml
200 Response
Returns PartyApplication data for the customer number
Root Schema : PartyApplicationAggregateCollection
Type:
objectCollection of PartyApplicationAggregate
Show Source
Nested Schema : data
Type:
Show Source
array-
Array of:
object PartyApplicationAggregateModel
PartyApplicationAggregateModel
Nested Schema : PartyApplicationAggregateModel
Type:
objectPartyApplicationAggregateModel
Show Source
-
applicationNumber:
string
Application Number
-
drawdownParty:
object DrawdownPartyModel
DrawdownParty model
-
id:
string
Party Application Id
-
party:
object PartyModel
Party model
-
processCode:
string
Process Code
-
processRefNumber:
string
Process Ref Number
-
stageCode:
string
Stage Code
Nested Schema : DrawdownPartyModel
Type:
objectDrawdownParty model
Show Source
-
applicationNumber:
string
applicationNumber
-
createdBy:
string
Maximum Length:
36createdBy -
dataSegmentCode:
string
Data segment code
-
id:
string
Maximum Length:
36Id of the DrawdownParty -
partyDetails:
array partyDetails
-
processRefNumber:
string
Process ref Number
-
remarks:
string
remarks
-
stageCode:
string
Maximum Length:
36stageCode -
status:
string
Maximum Length:
36status -
updatedBy:
string
Updated By
-
updatedTimeStamp:
string
Updated Time Stamp
-
validateSave:
string
validateSave
Nested Schema : PartyModel
Type:
objectParty model
Show Source
-
applicationNumber:
string
applicationNumber
-
createdBy:
string
Maximum Length:
36createdBy -
dataSegmentCode:
string
Data segment code
-
id:
string
Maximum Length:
36Id of the Party -
partyDetails:
array partyDetails
-
processRefNumber:
string
processRefNumber
-
remarks:
string
remarks
-
stageCode:
string
Maximum Length:
36stageCode -
status:
string
Maximum Length:
36status -
updatedBy:
string
Updated By
-
updatedTimeStamp:
string
Updated Time Stamp
-
validateSave:
string
validate Save flag
Nested Schema : partyDetails
Type:
Show Source
array-
Array of:
object DrawdownPartyDetailsModel
DrawdownPartyDetails model
Nested Schema : DrawdownPartyDetailsModel
Type:
objectDrawdownPartyDetails model
Show Source
-
address:
object DrawdownAddressModel
DrawdownAddress model
-
countryOfIncorporation:
string
countryOfIncorporation
-
dateOfIncorporation:
string
dateOfIncorporation
-
demographicType:
string
demographicType
-
existingParty:
string
existingParty
-
externalCustomer:
string
externalCustomer
-
holdingPattern:
string
holdingPattern
-
id:
string
Id of the DrawdownPartyDetails
-
kycStatus:
string
kycStatus
-
languageCode:
string
languageCode
-
legalStatus:
string
legalStatus
-
maintenancePartyId:
string
maintenancePartyId
-
onboardingRefNumber:
string
onboardingRefNumber
-
onboardingStatus:
string
onboardingStatus
-
organizationType:
string
organizationType
-
partyContact:
array partyContact
-
partyId:
string
partyId
-
partyName:
string
partyName
-
partyNumber:
string
partyNumber
-
partyRole:
array partyRole
-
partyType:
string
partyType
-
placeOfIncorporation:
string
placeOfIncorporation
-
reportLocale:
string
reportLocale
-
updatePartyMaintenance:
string
updatePartyMaintenance
Nested Schema : DrawdownAddressModel
Type:
objectDrawdownAddress model
Show Source
-
addressType:
string
addressType
-
area:
string
area
-
building:
string
building
-
city:
string
city
-
country:
string
country
-
id:
string
Id of the DrawdownAddress
-
landmark:
string
landmark
-
locality:
string
locality
-
maintenanceAddressId:
string
maintenanceAddressId
-
parentId:
string
parentId
-
state:
string
state
-
street:
string
street
-
zipcode:
string
zipcode
Nested Schema : partyContact
Type:
Show Source
array-
Array of:
object DrawdownPartyContactModel
DrawdownPartyContact model
Nested Schema : partyRole
Type:
Show Source
array-
Array of:
object DrawdownPartyRoleModel
DrawdownPartyRole model
Nested Schema : DrawdownPartyContactModel
Type:
objectDrawdownPartyContact model
Show Source
-
designation:
string
designation
-
firstName:
string
firstName
-
id:
string
Id of the DrawdownPartyContact
-
lastName:
string
lastName
-
MaintenanceContactId:
string
MaintenanceContactId
-
partyContactMedia:
array partyContactMedia
-
partyContactRole:
array partyContactRole
-
partyDetailsId:
string
partyDetailsId
-
salutation:
string
salutation
Nested Schema : partyContactMedia
Type:
Show Source
array-
Array of:
object DrawdownPartyContactMediaModel
DrawdownPartyContactMedia model
Nested Schema : partyContactRole
Type:
Show Source
array-
Array of:
object DrawdownPartyContactRoleModel
DrawdownPartyContactRole model
Nested Schema : DrawdownPartyContactMediaModel
Type:
objectDrawdownPartyContactMedia model
Show Source
-
address:
object DrawdownAddressModel
DrawdownAddress model
-
id:
string
Id of the DrawdownPartyContactMedia
-
maintenanceContactMediaId:
string
maintenanceContactMediaId
-
mediaAddress:
string
mediaAddress
-
mediaType:
string
mediaType
-
partyContactId:
string
partyContactId
-
preferredFlag:
string
preferredFlag
Nested Schema : DrawdownPartyContactRoleModel
Type:
objectDrawdownPartyContactRole model
Show Source
-
id:
string
Id of the DrawdownPartyContactRole
-
partyContactId:
string
partyContactId
-
partyDetailsId:
string
partyDetailsId
-
role:
string
role
Nested Schema : DrawdownPartyRoleModel
Type:
objectDrawdownPartyRole model
Show Source
-
id:
string
Id of the DrawdownPartyRole
-
partyDetailsId:
string
partyDetailsId
-
role:
string
role
Nested Schema : partyDetails
Type:
Show Source
array-
Array of:
object PartyDetailsModel
PartyDetails model
Nested Schema : PartyDetailsModel
Type:
objectPartyDetails model
Show Source
-
address:
object AddressModel
Address model
-
countryOfIncorporation:
string
Country Of Incorporation
-
dateOfIncorporation:
string
Date Of Incorporation
-
demographicType:
string
Demographic Type
-
existingParty:
string
Maximum Length:
1Existing Party -
externalCustomer:
string
externalCustomer
-
holdingPattern:
string
Holding Pattern
-
id:
string
Id of the PartyDetails
-
keyId:
string
Maintenance Id of the PartyDetails
-
kycStatus:
string
KYC Status
-
languageCode:
string
Language Code
-
maintenancePartyId:
string
maintenancePartyId
-
modNo:
number
Mod Number
-
onboardingRefNumber:
string
Onboarding Ref Number
-
onboardingStatus:
string
onboardingStatus
-
organizationType:
string
Organization Type
-
partyContact:
array partyContact
-
partyId:
string
partyId
-
partyName:
string
partyName
-
partyNumber:
string
partyNumber
-
partyRole:
array partyRole
-
partyType:
string
Party Type
-
placeOfIncorporation:
string
Place Of Incorporation
-
reportLocale:
string
Report Locale
-
updatePartyMaintenance:
string
Maximum Length:
1Update Party Maintenance
Nested Schema : AddressModel
Type:
objectAddress model
Show Source
-
addressType:
string
addressType
-
area:
string
area
-
building:
string
building
-
city:
string
city
-
country:
string
country
-
id:
string
Id of the PartyContactRole
-
landmark:
string
landmark
-
locality:
string
locality
-
maintenanceAddressId:
string
maintenanceAddressId
-
parentId:
string
parent Id
-
state:
string
state
-
street:
string
street
-
zipcode:
string
zipcode
Nested Schema : partyContact
Type:
Show Source
array-
Array of:
object PartyContactModel
PartyContact model
Nested Schema : PartyContactModel
Type:
objectPartyContact model
Show Source
-
designation:
string
designation
-
firstName:
string
First Name
-
id:
string
Id of the PartyContact
-
lastName:
string
Last Name
-
maintenanceContactId:
string
maintenanceContactId
-
partyContactMedia:
array partyContactMedia
-
partyContactRole:
array partyContactRole
-
partyDetailsId:
string
partyDetailsId
-
partyId:
string
Party Id
-
salutation:
string
Salutation
Nested Schema : partyContactMedia
Type:
Show Source
array-
Array of:
object PartyContactMediaModel
PartyContactMedia model
Nested Schema : partyContactRole
Type:
Show Source
array-
Array of:
object PartyContactRoleModel
PartyContactRole model
Nested Schema : PartyContactMediaModel
Type:
objectPartyContactMedia model
Show Source
-
address:
object AddressModel
Address model
-
id:
string
Id of the PartyContactMedia
-
maintenanceContactMediaId:
string
maintenanceContactMediaId
-
mediaAddress:
string
mediaAddress
-
mediaType:
string
mediaType
-
partyContactId:
string
partyContactId
-
preferredFlag:
string
preferredFlag
Nested Schema : PartyContactRoleModel
Type:
objectPartyContactRole model
Show Source
-
id:
string
Id of the PartyContactRole
-
partyContactId:
string
partyContactId
-
partyDetailsId:
string
partyDetailsId
-
role:
string
role
Nested Schema : PartyRoleModel
Type:
objectPartyRole model
Show Source
-
id:
string
Id of the PartyRole
-
partyDetailsId:
string
partyDetailsId
-
role:
string
role
400 Response
Malformed syntax.
401 Response
Request does not have sufficient credentials.
403 Response
Request is not authorized.
405 Response
Invalid input
500 Response
Internal error