Temenos Digital
R24 AMR | Min(s) read

Party

Party APIs help you to interact with party micro services. The Party micro service is used to store various details about the party, such as personal information, identity details, and address details. By using the Party APIs, you can create, update, or get the parties in the party micro service.

Name Description Introduced In
getReferenceData This API fetches party enrichment data from the Party micro services for the application. 2020.04
createProspectProfile This API creates a party. 2020.04
resumeOnboardingApplication This API resumes the Onboarding application. 2020.04
updateProspectProfile This API updates the prospect and party details in addition to Journey Manager. 2020.04
CreateCoApplicant This API creates co-applicant party details. 2020.04
createParty This API creates a new Party in the Party Microservice 2020.07
getParty This API fetches the Party information from the Party Microservice. 2020.07
updateParty This API updates the Party in the Party Microservice. 2020.07
 
Description: This API fetches party enrichment data from the Party micro services for the application.
Method: GET
URL: {baseUrl}/services/data/v1/PartyObjectService/operations/Reference/getReferenceData
Security Level: Anonymous App Users
Header Request:
  • X-Kony-Authorization
Body Request:

Parameters

referenceId

Specifies the type of enrichment that must be fetched from the Party microservice.

{
	“referenceId” : “Country”
}
Response:

Countrys [ ]

Contains data that related to a country.

Parameters

Countrys/iddPrefix

Specifies the IDD.PREFIX for the country.

Countrys/countryCode

Specifies the country code.

Countrys/numericCountryCode

Specifies the numeric country code.

Countrys/countryName

Specifies the country name.

Countrys/highRiskCountry

Specifies the high-risk value for the country.

{
  "countrys": [
    {
      "iddPrefix": 1,
      "countryCode": "US",
      "numericCountryCode": 1,
      "alpha3CountryCode": "USA",
      "countryName": "United States",
      "highRiskCountry": true
    },
    {
      "iddPrefix": 91,
      "countryCode": "IN",
      "numericCountryCode": 17,
      "alpha3CountryCode": "IND",
      "countryName": "India",
      "highRiskCountry": false
    }
  ]
}
Error Code(s): Error code : 8009
Error message : Backend request failed
Associated Enterprise APIs: {partyHost}/reference/$referenceId
 
Description: This API creates a party.
Method: POST
URL: {baseURL}/services/data/v1/OnBoarding/operations/Application/createProspectProfile
Security Level: Anonymous App Users
Header Request:

X-Kony-Authorization

Body Request:

Parameters

FirstName

Specifies the first name of the applicant.

LastName

Specifies the last name of the applicant.

DateOfBirth

Specifies the date of birth of the applicant.

Email

Specifies the email address of the applicant.

MobileCountryCode

Specifies the mobile country code of the applicant.

MobileNumber

Specifies the mobile number of the applicant.

ApplicantType

Specifies the type of applicant such as general applicant or co-applicant.

Application_id

Specifies the Journey Manager tracking ID.

{ 
  "FirstName": "Nathan", 
  "LastName": "Drake", 
  "DateOfBirth": "1990-10-10", 
  "Email": "nathan_drake@uncharted.com", 
  "MobileCountryCode": "+1", 
  "MobileNumber": "9517536545",  
  "Application_id": "ZMZY8MG", 
  "ApplicantType": "Applicant",
}
Response:

Parameters

/Party_id

Specifies the ID that is created for the prospect in Party micro service.

/id

Specifies the Journey Manager tracking code of the application.

{
    "opstatus":0,"Party_id":"2009854036",
    "id":"N34DMCD",
    "httpStatusCode":200
}
Error Code(s):
  • Error code : 75300
    Error message : Create DBX prospect failed.
  • Error code : 75303
    Error message : Create customer application failed.
  • Error code : 75104
    Error message : Update JM application failed .
  • Error code : 75302
    Error message : Customer application update failed.
  • Error code : 75602
    Error message : Create prospect profile failed.
Associated Enterprise APIs: None
 
Description: This API resumes the onboarding application.
Method: POST
URL: {baseUrl}/services/data/v1/OnBoarding/operations/Application/resumeOnBoardingApplication
Security Level: Anonymous App User
Header Request:
  • X-Kony-Authorization
  • X-Kony-ReportingParams
Body Request:

Parameters

id

Specifies the Journey Manager tracking code.

challengeAnswer

Specifies the challenge answer required to resume the application.

PhoneNumber

Specifies the phone number used while creating the application

{
 "id":"N34DMCD",
"challengeAnswer":"1990-10-10",
 "PhoneNumber":"+19517536545"
}
Response:

ApplicationResponse { }

Contains the entire response

Parameters

ApplicationResponse /Status

Specifies the status of the application.

ApplicationResponse /StartDate

Specifies the start date of the application.

ApplicationResponse /ApplicationType

Specifies the type of application.

ApplicationResponse /EligibilityCritirea

Specifies the eligibility criteria selected by the applicant.

ApplicationResponse /IsExistingCustomer

Specifies if the applicant is an existing customer.

ApplicationResponse /TnCFlag

Specifies if the applicant has accepted terms and conditions.

ApplicationResponse /CoApplicationCount

Specifies the number of co applicants in the application.

ApplicationResponse /ProductSelection

Specifies the list of product names, IDs and currencies selected by the applicant.

ApplicationResponse /IsConsentAccepted

Specifies if the user has consented for the data.

ApplicationResponse /PhoneNumber

Specifies the phone number of the applicant.

ApplicationResponse/SectionStatusCoApplicant

Specifies the section wise statuses of the co applicant.

ApplicationResponse/SectionStatus/ProductSelection

Specifies the status of the product selection of the applicant.

ApplicationResponse/SectionStatus/Applicant

Specifies the section wise statuses of the applicant.

ApplicationResponse/Party_ids/CoApplicant

Specifies the Party ID of the co applicant.

ApplicationResponse/Party_ids/Applicant

Specifies the party ID of the applicant.

{ 
ApplicationResponse":
    {
        "Status":"InProgress",
        "StartDate":"2020-04-07",
        "ApplicationType":"",
        "EligibilityCriteria":"",
        "IsExistingCustomer":"",
        "TnCFlag":"",
        "CoApplicantCount":"",
        "ProductSelection":[
        {
            "ProductCurrency1":"",
            "ProductCurrency2":"",
            "ProductCurrency3":"",
            "ProductID4":"",
            "ProductCurrency4":"",
            "ProductID5":"",
            "ProductCurrency5":"",
            "ProductID2":"",
            "ProductID3":"",
            "ProductID1":"",
            "ProgressStatus":"",
            "ProductName2":"",
            "ProductName3":"",
            "ProductName4":"",
            "ProductName5":"",
            "ProductName1":""
        }
],"IsConsentAccepted":""
    }
,"PhoneNumber":"+19517536545",
    "opstatus":0,"SectionStatus":
    {
        "CoApplicant":
        {
            "PersonalInfo":"",
            "IDVInfo":"",
            "IdentityInfo":"",
            "AddressInfo":""
        }
,"ProductSelection":
        {
            "ProgressStatus":""
        }
,"Applicant":
        {
            "PersonalInfo":"Done",
            "IDVInfo":"",
            "IdentityInfo":"",
            "AddressInfo":""
        }
    }
,"Party_ids":
    {
        "CoApplicant":"",
        "Applicant":"2009854036"
    }
,"httpStatusCode":200
}
Error Code(s):
  • Error code : 77214
    Error message : Failed to resume application
  • Error code : 77215
    Error message : Phone number, save challenge answer and application do not match
Associated Enterprise APIs: None
 
Description: This API updates the prospect and party details in addition to Journey Manager.
Method: POST
URL: {baseUrl}/services/data/v1/OnBoarding/operations/PersonalInfo/updateProspectProfile
Security Level: Anonymous app users
Header Request:

X-Kony-Authorization

Body Request:

Parameters

FirstName

Specifies the first name of the applicant.

LastName

Specifies the last name of the applicant.

DateOfBirth

Specifies the date of birth of the applicant.

Email

Specifies the email address of the applicant.

MobileCountryCode

Specifies the mobile country code of the applicant.

MobileNumber

Specifies the mobile number of the applicant.

ApplicantType

Specifies the type of applicant such as general applicant or co-applicant.

Application_id

Specifies the Journey Manager tracking ID.

{ 
  "FirstName": "Nathan", 
  "LastName": "Drake", 
  "DateOfBirth": "1990-10-10", 
  "Email": "nathan_drake@uncharted.com", 
  "MobileCountryCode": "+1", 
  "MobileNumber": "9517536545",  
  "Application_id": "N34DMCD", 
  "ApplicantType": "Applicant",
}
Response: 
{
"opstatus":0,
"httpStatusCode":200
}
Error Code(s):
  • Error code : 71000
    Error message : Error occurred while updating prospect profile.
  • Error code : 75309
    Error message : failed to update prospect details.
  • Error code : 75302
    Error message : Customer application update failed.
  • Error code : 75104
    Error message : Update JM application failed.
Associated Enterprise APIs: None
 
Description: This API creates co-applicant party details.
Method: POST
URL: {baseUrl}/services/data/v1/OnBoarding/operations/Application/createCoApplicant
Security Level: Anonymous App Users.
Header Request:
  • X-Kony-Authorization
Body Request:

Parameters

FirstName

Specifies the first name of the co-applicant.

LastName

Specifies the last name of the co-applicant.

DateOfBirth

Specifies the date of birth of the co-applicant.

Email

Specifies the email address of the co-applicant.

MobileCountryCode

Specifies the mobile country code of the co-applicant.

MobileNumber

Specifies the mobile number of the user of co-applicant.

ApplicantType

Specifies the type of applicant such as general applicant or co-applicant.

Application_id

Specifies the Journey Manager tracking ID.

{
"FirstName": "Francis", 
  "LastName": "Drake", 
  "DateOfBirth": "1995-10-10", 
  "Email": "francis@uncharted.com", 
  "MobileCountryCode": "+1", 
  "MobileNumber": "9517536575",  
  "Application_id": "N34DMCD", 
  "ApplicantType": "CoApplicant",
}
Response:

Parameters

/CoAppParty_id

Specifies the Party ID of the co-applicant.

{
  "opstatus": 0,
  "CoAppParty_id": "2009862812",
  "httpStatusCode": 200
}
Error Code(s):
  • Error code : 75300
    Error message : Create DBX prospect failed.
  • Error code : 75104
    Error message : Update JM application failed.
Associated Enterprise APIs: None
 
Description: This API creates a new Party in the Party Microservice
Method: POST
URL: {baseUrl}/services/data/v1/PartyServices/operations/Party/createParty
Security Level: Authenticated App User
Header Request:
  • X-Kony-Authorization
Body Request:

Parameters

partyType

Specifies the type of the party. The party type can be either Individual or Business.

firstName

Specifies the first name of the party.

lastName

Specifies the last name of the party.

gender

Specifies the gender of the party.

defaultLanguage

Specifies the default language of the party.

noOfDependents

Specifies the number of dependents of the party.

middleName

Specifies the middle name of the party.

suffix

Specifies the title of the party.

alias

Specifies an alternate name of the party.

phoneAddress

Specifies a JSON array that consists of a phone number. Every JSON object consists of a property of the phone number.

partyStatus

Specifies whether the party is active or a prospect.

partyNames

Specifies a JSON array that consists of various names.

electronicAddress

Specifies a JSON array that consists of an Email ID and its attributes in each JSON object.

contactAddress

Specifies a JSON array that consists of the contact address and its attributes in each JSON object.

{
    "partyType": "Individual",
    "firstName": "Sriram",
    "lastName": "sadineni",
    "gender":"male",
    "defaultLanguage":"English",
    "noOfDependents":"3",
    "middleName":"",
    "nickName":"ramu",
    "suffix":"Mr",
    "alias":"Sriram",
    "phoneAddress": "{\"communicationNature\":\"Phone\",\"communicationType\":\"Mobile\",\"addressType\":\"Home\",\"primary\":\"true\",\"iddPrefixPhone\":\"+1\",\"phoneNo\":\"8143589877\"}",
    "partyStatus": "Prospect",
    "electronicAddress": "{\"communicationNature\":\"Electronic\",\"communicationType\":\"Email\",\"addressType\":\"Office\",\"primary\":\"true\",\"electronicAddress\":\"srirama.sadineni@kony.com\"}",
    "contactAddress": "{\"communicationNature\":\"Physical\",\"communicationType\":\"MailingAddress\",\"addressType\":\"Home\",\"primary\":\"true\",\"countryCode\":\"US\",\"flatNumber\":\"21\",\"floor\":\"2\",\"buildingNumber\":\"3\",\"buildingName\":\"c/o Copenagen Fintech Labs\",\"floor\":\"2\",\"streetName\":\"Grand Avenue\",\"town\":\"San leandro community center\",\"regionCode\":\"NY\",\"postalOrZipCode\":\"510-286-4444\",\"postBoxNumber\":\"A3700\",\"countrySubdivision\":\"Oakland\",\"district\":\"ch\",\"department\":\"ws\",\"subDepartment\":\"subDepartment\",\"validatedBy\":\"validatedBy\",\"usePurpose\":\"Home Address\",\"landmark\":\"landmark\",\"website\":\"website\"}"
}
Response:

Parameters

/createStatus

Specifies whether the creation of the party was successful or not.

/partyId

Specifies a unique identifier for the created party.

 

{
    "createStatus": "success",
    "partyId": "2107666525",
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s):

None
 
Description: This API fetches the Party information from the Party Microservice.
Method: POST
URL: {baseUrl}/services/data/v1/PartyServices/operations/Party/getParty
Security Level: Authenticated App User
Header Request:
  • X-Kony-Authorization
Body Request:

Parameters

partyId

Specifies the unique identifier of the party.

lastName

Specifies the last name of the party.

identifierNumber

Specifies the party identifier.

identifierType

Specifies the party identifier.

alternateIdentifierNumber

Specifies the alternate identifier.

alternateIdentifierType

Specifies the alternate identifier.

lastName

Specifies the last name of the party.

dateOfBirth

Specifies the date of birth of the party.

contactNumber

Specifies the contact number of the party.

entityName

Specifies the entity name of the party.

emailId

Specifies the email address of the party

recordCount

Specifies the record count of the party.

{

    "partyId":"2109037016",
    "identifierNumber":"",
    "identifierType":"",
    "alternateIdentifierNumber":"",
    "alternateIdentifierType":"",
    "lastName":"",
    "dateOfBirth":"",
    "contactNumber":"",
    "entityName":"",
    "emailId":"",
    "recordCount":""
}
Response:

Parameters

parties

Specifies the array of parties.

parties/partyType

Specifies the type of the party. The party type can be either Individual or Business.

parties/partyId

Specifies the unique identifier of the party.

parties/partyStatus

Specifies whether the party is active or a prospect.

parties/creationDateTime

Specifies the date and time on which the party is created.

parties/firstName

Specifies the first name of the party.

parties/lastName

Specifies the last name of the party.

parties/gender

Specifies the gender of the party.

parties/defaultLanguage

Specifies the default language of the party.

parties/noOfDependents

Specifies the number of dependents of the party.

parties/nickname

Specifies the nick name of the party.

parties/suffix

Specifies the title of the party.

parties/alias

Specifies an alternate name of the party.

contactAddress

Specifies a JSON array that consists of the contact address and its attributes in each JSON object.

contactAddress/addressesReference

Specifies the reference ID of the address.

contactAddress/communicationNature

Specifies the communication type to reach the address.

contactAddress/communicationType

Specifies the type of communication.

contactAddress/addressType

Specifies the type of the address.

contactAddress/primary

Specifies whether the address is primary or not.

contactAddress/flatNumber

Specifies the flat number.

contactAddress/floor

Specifies the floor number.

contactAddress/buildingName

Specifies the name of the building.

contactAddress/buildingNumber

Specifies the building number.

contactAddress/streetName

Specifies the street name.

contactAddress/postBoxNumber

Specifies the post box number.

contactAddress/landmark

Specifies the landmark near the address.

contactAddress/town

Specifies the town name.

contactAddress/district

Specifies the district name.

contactAddress/subDepartment

Specifies the sub department of the address.

contactAddress/department

Specifies the department of the address.

contactAddress/regionCode

Specifies the region code.

contactAddress/countrySubdivision

Specifies the sub division of the country.

contactAddress/countryCode

Specifies the country code.

contactAddress/postalOrZipCode

Specifies the postal zip code.

contactAddress/validatedBy

Specifies the name of the person who validated the physical address.

contactAddress/website

Specifies if there is any website for reference.

contactAddress/usePurpose

Specifies the purpose of the address usage.

phoneAddress

Specifies a JSON array that consists of a phone number. Each JSON object consists of a property of the phone number.

phoneAddress/addressesReference

Specifies the reference ID of the address.

phoneAddress/communicationNature

Specifies the communication type to reach the address.

phoneAddress/communicationType

Specifies the type of communication.

phoneAddress/addressType

Specifies the type of the address.

phoneAddress/primary

Specifies whether the address is primary or not.

phoneAddress/iddPrefixPhone

Specifies the STD code of the provided phone number.

phoneAddress/phoneNo

Specifies the phone number.

electronicAddress

Specifies a JSON array that consists of an Email ID and its attributes in each JSON object.

electronicAddress/addressesReference

Specifies the reference ID of the address.

electronicAddress/communicationNature

Specifies the communication type to reach the address.

electronicAddress/communicationType

Specifies the type of communication.

electronicAddress/addressType

Specifies the type of the address.

electronicAddress/primary

Specifies whether the address is primary or not.

electronicAddress/electronicAddress

Specifies the email address of the user.

partyIdentifiers

Specifies the party identifier.

alternateIdentities

Specifies the alternate identifier.

{
    "parties": [
        {
            "partyStatus": "Prospect",
            "partyId": "2109037016",
            "coreCustomerId":"123456",
            "partyType": "Individual",
            "creationDateTime": "2021-03-31 10:16:56",
            "firstName": "Sriram",
            "lastName": "sadineni",
            "gender": "Male",
            "defaultLanguage": "English",
            "noOfDependents": "3",
            "nickName": "ramu",
            "suffix": "Mr",
            "alias": "Sriram",
            "nameStartDate": "2021-03-31",
            "contactAddress": [
                {
                    "addressesReference": "AD21090ICPQQ",
                    "communicationNature": "Physical",
                    "communicationType": "MailingAddress",
                    "addressType": "Home",
                    "primary": "true",
                    "flatNumber": "21",
                    "floor": "2",
                    "buildingName": "c/o Copenagen Fintech Labs",
                    "buildingNumber": "3",
                    "streetName": "Grand Avenue",
                    "postBoxNumber": "A3700",
                    "landmark": "landmark",
                    "town": "San leandro community center",
                    "district": "ch",
                    "subDepartment": "subDepartment",
                    "department": "ws",
                    "regionCode": "NY",
                    "countrySubdivision": "Oakland",
                    "countryCode": "US",
                    "postalOrZipCode": "510-286-4444",
                    "validatedBy": "validatedBy",
                    "website": "website",
                    "usePurpose": "Home Address"
                }
            ],
            "phoneAddress": [
                {
                    "addressesReference": "AD21090LOD50",
                    "communicationNature": "Phone",
                    "communicationType": "Mobile",
                    "addressType": "Home",
                    "primary": "true",
                    "iddPrefixPhone": "+1",
                    "phoneNo": "8143589877"
                }
            ],
            "electronicAddress": [
                {
                    "addressesReference": "AD210900OCBH",
                    "communicationNature": "Electronic",
                    "communicationType": "Email",
                    "addressType": "Office",
                    "primary": "true",
                    "electronicAddress": "srirama.sadineni@kony.com"
                }
            ],
            "partyIdentifiers": [],
            "alternateIdentities": []
        }
    ],
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s):

None
 
Description: This API updates the Party in the Party Microservice.
Method: POST
URL: {baseUrl}/services/data/v1/PartyServices/operations/Party/updateParty
Security Level: Authenticated App User
Header Request:
  • X-Kony-Authorization
Body Request:

Parameters

partyId (Mandatory)

Specifies the unique identifier of the Party.

firstName

Specifies the first name of the party.

lastName

Specifies the last name of the party.

gender

Specifies the gender of the party.

defaultLanguage

Specifies the default language of the party.

noOfDependents

Specifies the number of dependents of the party.

middleName

Specifies the middle name of the party.

suffix

Specifies the title of the party.

alias

Specifies an alternate name of the party.

phoneAddress

Specifies a JSON array that consists of a phone number. Each JSON object consists of a property of the phone number.

partyStatus

Specifies whether the party is active or a prospect.

partyNames

Specifies a JSON array that consists of various names.

electronicAddress

Specifies a JSON array that consists of an Email ID and its attributes in each JSON object.

contactAddress

Specifies a JSON array that consists of the contact address and its attributes in each JSON object.

{
    "partyId":"2107666525",
    "partyType": "Individual",
    "firstName": "Sriram",
    "lastName": "sadineni",
    "gender":"male",
    "defaultLanguage":"English",
    "noOfDependents":"3",
    "middleName":"",
    "nickName":"ramu",
    "suffix":"Mr",
    "alias":"Sriram",
    "phoneAddress": "{\"communicationNature\":\"Phone\",\"communicationType\":\"Mobile\",\"addressType\":\"Home\",\"primary\":\"true\",\"iddPrefixPhone\":\"+1\",\"phoneNo\":\"8143589877\"}",
    "partyStatus": "Prospect",
    "electronicAddress": "{\"communicationNature\":\"Electronic\",\"communicationType\":\"Email\",\"addressType\":\"Office\",\"primary\":\"true\",\"electronicAddress\":\"srirama.sadineni@kony.com\"}",
    "contactAddress": "{\"communicationNature\":\"Physical\",\"communicationType\":\"MailingAddress\",\"addressType\":\"Home\",\"primary\":\"true\",\"countryCode\":\"US\",\"flatNumber\":\"21\",\"floor\":\"2\",\"buildingNumber\":\"3\",\"buildingName\":\"c/o Copenagen Fintech Labs\",\"floor\":\"2\",\"streetName\":\"Grand Avenue\",\"town\":\"San leandro community center\",\"regionCode\":\"NY\",\"postalOrZipCode\":\"510-286-4444\",\"postBoxNumber\":\"A3700\",\"countrySubdivision\":\"Oakland\",\"district\":\"ch\",\"department\":\"ws\",\"subDepartment\":\"subDepartment\",\"validatedBy\":\"validatedBy\",\"usePurpose\":\"Home Address\",\"landmark\":\"landmark\",\"website\":\"website\"}"
}
Response:

Parameters

/updateStatus

Specifies whether the updation of the party was successful.

{
    "updateStatus": "success",
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s):

None

In this topic

Copyright © 2020- Temenos Headquarters SA

Contact Us

knowledge@temenos.com

Published on :
Thursday, May 30, 2024 11:43:10 AM IST