Get party application aggregate details
get
/party-services/web/v1/partyapplication/{applicationNumber}
Add additional information here for the this endpoint.
Request
Supported Media Types
- application/json
- application/xml
Path Parameters
-
applicationNumber: string
Application 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 application number
Root Schema : PartyApplicationAggregateModel
Type:
object
PartyApplicationAggregateModel
Show Source
-
applicationNumber(optional):
string
Application Number
-
drawdownParty(optional):
object DrawdownPartyModel
DrawdownParty model
-
id(optional):
string
Party Application Id
-
party(optional):
object PartyModel
Party model
-
processCode(optional):
string
Process Code
-
processRefNumber(optional):
string
Process Ref Number
-
stageCode(optional):
string
Stage Code
Nested Schema : DrawdownPartyModel
Type:
object
DrawdownParty model
Show Source
-
applicationNumber(optional):
string
applicationNumber
-
createdBy(optional):
string
Maximum Length:
36
createdBy -
dataSegmentCode(optional):
string
Data segment code
-
id(optional):
string
Maximum Length:
36
Id of the DrawdownParty -
partyDetails(optional):
array partyDetails
-
processRefNumber(optional):
string
Process ref Number
-
remarks(optional):
string
remarks
-
stageCode(optional):
string
Maximum Length:
36
stageCode -
status(optional):
string
Maximum Length:
36
status -
updatedBy(optional):
string
Updated By
-
updatedTimeStamp(optional):
string
Updated Time Stamp
-
validateSave(optional):
string
validateSave
Nested Schema : PartyModel
Type:
object
Party model
Show Source
-
applicationNumber(optional):
string
applicationNumber
-
createdBy(optional):
string
Maximum Length:
36
createdBy -
dataSegmentCode(optional):
string
Data segment code
-
id(optional):
string
Maximum Length:
36
Id of the Party -
partyDetails(optional):
array partyDetails
-
processRefNumber(optional):
string
processRefNumber
-
remarks(optional):
string
remarks
-
stageCode(optional):
string
Maximum Length:
36
stageCode -
status(optional):
string
Maximum Length:
36
status -
updatedBy(optional):
string
Updated By
-
updatedTimeStamp(optional):
string
Updated Time Stamp
-
validateSave(optional):
string
validate Save flag
Nested Schema : partyDetails
Type:
Show Source
array
-
Array of:
object DrawdownPartyDetailsModel
DrawdownPartyDetails model
Nested Schema : DrawdownPartyDetailsModel
Type:
object
DrawdownPartyDetails model
Show Source
-
address(optional):
object DrawdownAddressModel
DrawdownAddress model
-
countryOfIncorporation(optional):
string
countryOfIncorporation
-
dateOfIncorporation(optional):
string
dateOfIncorporation
-
demographicType(optional):
string
demographicType
-
existingParty(optional):
string
existingParty
-
externalCustomer(optional):
string
externalCustomer
-
holdingPattern(optional):
string
holdingPattern
-
id(optional):
string
Id of the DrawdownPartyDetails
-
kycStatus(optional):
string
kycStatus
-
languageCode(optional):
string
languageCode
-
legalStatus(optional):
string
legalStatus
-
maintenancePartyId(optional):
string
maintenancePartyId
-
onboardingRefNumber(optional):
string
onboardingRefNumber
-
onboardingStatus(optional):
string
onboardingStatus
-
organizationType(optional):
string
organizationType
-
partyContact(optional):
array partyContact
-
partyId(optional):
string
partyId
-
partyName(optional):
string
partyName
-
partyNumber(optional):
string
partyNumber
-
partyRole(optional):
array partyRole
-
partyType(optional):
string
partyType
-
placeOfIncorporation(optional):
string
placeOfIncorporation
-
reportLocale(optional):
string
reportLocale
-
updatePartyMaintenance(optional):
string
updatePartyMaintenance
Nested Schema : DrawdownAddressModel
Type:
object
DrawdownAddress model
Show Source
-
addressType(optional):
string
addressType
-
area(optional):
string
area
-
building(optional):
string
building
-
city(optional):
string
city
-
country(optional):
string
country
-
id(optional):
string
Id of the DrawdownAddress
-
landmark(optional):
string
landmark
-
locality(optional):
string
locality
-
maintenanceAddressId(optional):
string
maintenanceAddressId
-
parentId(optional):
string
parentId
-
state(optional):
string
state
-
street(optional):
string
street
-
zipcode(optional):
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:
object
DrawdownPartyContact model
Show Source
-
designation(optional):
string
designation
-
firstName(optional):
string
firstName
-
id(optional):
string
Id of the DrawdownPartyContact
-
lastName(optional):
string
lastName
-
MaintenanceContactId(optional):
string
MaintenanceContactId
-
partyContactMedia(optional):
array partyContactMedia
-
partyContactRole(optional):
array partyContactRole
-
partyDetailsId(optional):
string
partyDetailsId
-
salutation(optional):
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:
object
DrawdownPartyContactMedia model
Show Source
-
address(optional):
object DrawdownAddressModel
DrawdownAddress model
-
id(optional):
string
Id of the DrawdownPartyContactMedia
-
maintenanceContactMediaId(optional):
string
maintenanceContactMediaId
-
mediaAddress(optional):
string
mediaAddress
-
mediaType(optional):
string
mediaType
-
partyContactId(optional):
string
partyContactId
-
preferredFlag(optional):
string
preferredFlag
Nested Schema : DrawdownPartyContactRoleModel
Type:
object
DrawdownPartyContactRole model
Show Source
-
id(optional):
string
Id of the DrawdownPartyContactRole
-
partyContactId(optional):
string
partyContactId
-
partyDetailsId(optional):
string
partyDetailsId
-
role(optional):
string
role
Nested Schema : DrawdownPartyRoleModel
Type:
object
DrawdownPartyRole model
Show Source
-
id(optional):
string
Id of the DrawdownPartyRole
-
partyDetailsId(optional):
string
partyDetailsId
-
role(optional):
string
role
Nested Schema : partyDetails
Type:
Show Source
array
-
Array of:
object PartyDetailsModel
PartyDetails model
Nested Schema : PartyDetailsModel
Type:
object
PartyDetails model
Show Source
-
address(optional):
object AddressModel
Address model
-
countryOfIncorporation(optional):
string
Country Of Incorporation
-
dateOfIncorporation(optional):
string
Date Of Incorporation
-
demographicType(optional):
string
Demographic Type
-
existingParty(optional):
string
Maximum Length:
1
Existing Party -
externalCustomer(optional):
string
externalCustomer
-
holdingPattern(optional):
string
Holding Pattern
-
id(optional):
string
Id of the PartyDetails
-
keyId(optional):
string
Maintenance Id of the PartyDetails
-
kycStatus(optional):
string
KYC Status
-
languageCode(optional):
string
Language Code
-
maintenancePartyId(optional):
string
maintenancePartyId
-
modNo(optional):
number
Mod Number
-
onboardingRefNumber(optional):
string
Onboarding Ref Number
-
onboardingStatus(optional):
string
onboardingStatus
-
organizationType(optional):
string
Organization Type
-
partyContact(optional):
array partyContact
-
partyId(optional):
string
partyId
-
partyName(optional):
string
partyName
-
partyNumber(optional):
string
partyNumber
-
partyRole(optional):
array partyRole
-
partyType(optional):
string
Party Type
-
placeOfIncorporation(optional):
string
Place Of Incorporation
-
reportLocale(optional):
string
Report Locale
-
updatePartyMaintenance(optional):
string
Maximum Length:
1
Update Party Maintenance
Nested Schema : AddressModel
Type:
object
Address model
Show Source
-
addressType(optional):
string
addressType
-
area(optional):
string
area
-
building(optional):
string
building
-
city(optional):
string
city
-
country(optional):
string
country
-
id(optional):
string
Id of the PartyContactRole
-
landmark(optional):
string
landmark
-
locality(optional):
string
locality
-
maintenanceAddressId(optional):
string
maintenanceAddressId
-
parentId(optional):
string
parent Id
-
state(optional):
string
state
-
street(optional):
string
street
-
zipcode(optional):
string
zipcode
Nested Schema : partyContact
Type:
Show Source
array
-
Array of:
object PartyContactModel
PartyContact model
Nested Schema : PartyContactModel
Type:
object
PartyContact model
Show Source
-
designation(optional):
string
designation
-
firstName(optional):
string
First Name
-
id(optional):
string
Id of the PartyContact
-
lastName(optional):
string
Last Name
-
maintenanceContactId(optional):
string
maintenanceContactId
-
partyContactMedia(optional):
array partyContactMedia
-
partyContactRole(optional):
array partyContactRole
-
partyDetailsId(optional):
string
partyDetailsId
-
partyId(optional):
string
Party Id
-
salutation(optional):
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:
object
PartyContactMedia model
Show Source
-
address(optional):
object AddressModel
Address model
-
id(optional):
string
Id of the PartyContactMedia
-
maintenanceContactMediaId(optional):
string
maintenanceContactMediaId
-
mediaAddress(optional):
string
mediaAddress
-
mediaType(optional):
string
mediaType
-
partyContactId(optional):
string
partyContactId
-
preferredFlag(optional):
string
preferredFlag
Nested Schema : PartyContactRoleModel
Type:
object
PartyContactRole model
Show Source
-
id(optional):
string
Id of the PartyContactRole
-
partyContactId(optional):
string
partyContactId
-
partyDetailsId(optional):
string
partyDetailsId
-
role(optional):
string
role
Nested Schema : PartyRoleModel
Type:
object
PartyRole model
Show Source
-
id(optional):
string
Id of the PartyRole
-
partyDetailsId(optional):
string
partyDetailsId
-
role(optional):
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