| Bookmark Name | Actions |
|---|
Enterprise APIs
This section covers the details of the APIs supported by Party microservice.
- Version 1.0.0
- Version 1.0.1
- Version 2.0.0
- Version 3.0.0
Version 1.0.0
This is the basic version of Party microservice APIs. The V1.0.0 version of Party microservice APIs contains seven functional groups with their respective operations as follows.
| Functional Group | Description | Operations | |||
|---|---|---|---|---|---|
| Party | Party is a group that the bank or the financial institution collects information for the business purpose. |
|
|||
| ContactPoint/ContactAddress | ContactPoint and ContactAddress store information about different end-points at which a party could be contacted. |
|
|||
| PartyIdentifier | The PartyIdentifier group identifies the legal identification documents that are associated with a party. |
|
|||
| PartyAssessment | The PartyAssesment group stores the results of various assessments. These assessments are done by third-party systems such as AML and PEP Screening. |
|
|||
| EmploymentDetails | The EmploymentDetails group contains the employment and occupational details of a party. |
|
|||
| TaxDetails | The TaxDetails group captures the taxation details of a party. |
|
|||
| ReferenceTables | The ReferenceTables group contains the static data for all the reference entities. | getReferenceDataForParty |
To view the Swagger Spec of the Party microservice APIs, click here.
The createParty API creates a new party record. This API is used to create party data such as party name, alternate identity, addresses, party identifier, and all the entities that are linked to the party
POST/party/parties
Sample Request
{
"dateOfBirth": "1990-09-09",
"dateOfDeath": "2045-09-09",
"notificationOfDeath": "2045-10-01",
"cityOfBirth": "Newyork",
"countryOfBirth": "US",
"gender": "Male",
"maritalStatus": "Married",
"nationality": [
"US"
],
"defaultLanguage": "English",
"noOfDependents": 4,
"reasonForNoCitizenship": "Migration from another country",
"partyType": "Individual",
"partyStatus": "Prospect",
"partyLanguage": [
"English"
],
"citizenship": [
"US"
],
"partyNames": [
{
"title": "Mr",
"firstName": "Rolf",
"middleName": "J",
"lastName": "Gerling",
"nickName": "Rolf",
"suffix": "B.E.",
"alias": "Rolf",
"entityName": "Temenos Group",
"startDate": "2012-05-24",
"endDate": "2024-10-20",
"extensionData": {}
}
],
"partyAssessment": [
{
"type": "Benchmark",
"status": "Pass",
"level": "Secured",
"score": "8",
"body": "CIBIL",
"conclusionDate": "2019-12-25",
"details": "",
"nature": "D",
"reason": "",
"nextAssessmentDate": "2019-12-25",
"expirydate": "2019-12-25",
"extensionData": {}
}
],
"partyIdentifier": [
{
"type": "Passport",
"status": "New",
"issuingAuthority": "Ministry of Foreign Affairs",
"identifierNumber": "JI35VEGVS",
"issuedDate": "2017-10-24",
"expiryDate": "2020-10-24",
"issuingCountry": "US",
"holderName": "Mr. Rolf Gerling",
"isLegalIdentifier": true,
"partyType": "Individual",
"isExternal": true,
"extensionData": {}
}
],
"personPosition": [
{
"personPositionType": "Politically Exposed-PEP",
"countryOfPosition": "US",
"effectiveFromDate": "2019-05-05",
"effectiveToDate": "2024-05-05",
"expiryDate": "2024-05-05",
"comments": "",
"lastUpdated": "2019-05-05",
"informationSource": "News",
"extensionData": {}
}
],
"partyLifeCycle": [
{
"type": "Recognised",
"startDate": "2020-01-01",
"endDate": "2021-01-01",
"changeReason": "",
"extensionData": {}
}
],
"occupation": [
{
"occupationType": "Part time job",
"occupationDescription": "At McDonalds as Cashier",
"extensionData": {}
}
],
"employment": [
{
"type": "Salaried-Employee",
"country": "US",
"jobTitle": "Product Manager",
"employerName": "Temenos",
"startDate": "2019-02-09",
"endDate": "2029-02-09",
"employerSegment": "Services",
"employerOfficePhoneIdd": "1",
"employerOfficePhone": "8574963214",
"employerOfficeEmail": "rolf@temenos.com",
"salary": 1000,
"salaryInCurrency": "Dollar",
"salaryFrequency": "Monthly",
"extensionData": {}
}
],
"otherRiskIndicator": [
{
"type": "Adverse Media",
"doesRiskApply": true,
"explanationIfApplies": "",
"explanationIfDoesnotApply": "",
"extensionData": {}
}
],
"residence": [
{
"type": "Residence",
"country": "US",
"status": "Renter",
"region": "California",
"statusComments": "",
"extensionData": {}
}
],
"vulnerability": [
{
"vulnerabilityType": "Physical",
"vulnerabilityComments": "By Birth",
"extensionData": {}
}
],
"taxDetails": [
{
"taxType": "Income Tax",
"country": "US",
"taxId": "2324-09-242",
"eligibilityType": "Consumption Tax",
"eligibilityReason": "Citizen of country",
"taxStartDate": "2020-05-10",
"endDate": "2021-05-10",
"taxReasonType": "Citizen",
"taxReasonComment": "",
"taxIdLackReason": "",
"isMainTaxResidency": "Yes",
"extensionData": {}
}
],
"contactPoint": [
{
"contactPointType": "Electronic Address",
"startDate": "2020-01-01",
"endDate": "2025-01-01",
"electronicAddress": {
"electronicAddressType": "Email",
"electronicAddress": "rolf@gmail.com",
"electronicCommunicationType": "Primary"
},
"phoneAddress": {
"phoneAddressType": "Home Number",
"internationalPhoneNumber": "+914155552671",
"iddPrefixPhone": "1",
"nationalPhoneNumber": "4155552671"
},
"extensionData": {}
}
],
"contactAddress": [
{
"physicalAddressType": "Home",
"startDate": "2020-01-01",
"reliabilityType": "Confirmed",
"contactName": "Rolf",
"endDate": "2022-01-01",
"countryCode": "US",
"flatNumber": "151",
"floor": "2",
"buildingNumber": "3",
"buildingName": "Copenagen Flats",
"streetName": "Grand Avenue",
"town": "San leandro",
"countrySubdivision": "California",
"postalOrZipCode": "510-286-4444",
"validatedBy": "Smarty Streets",
"postBoxNumber": "A3700",
"usePurpose": "Home Address",
"regionCode": "015",
"district": "Oakland",
"department": "",
"subDepartment": "",
"landmark": "San leandro community center",
"extensionData": {}
}
],
"extensionData": {}
} Sample Response
{
"id": "200722894",
"status": "Success",
"message": "string"
}The udpateParty API updates or changes the existing records of a party.
PUT/party/parties/{partyId}
Sample Request
{
"dateOfBirth": "1990-09-09",
"dateOfDeath": "2045-09-09",
"notificationOfDeath": "2045-10-01",
"cityOfBirth": "Newyork",
"countryOfBirth": "US",
"gender": "Male",
"maritalStatus": "Married",
"nationality": [
"US"
],
"defaultLanguage": "English",
"noOfDependents": 4,
"reasonForNoCitizenship": "Migration from another country",
"partyType": "Individual",
"partyStatus": "Prospect",
"partyLanguage": [
"English"
],
"citizenship": [
"US"
],
"partyNames": [
{
"title": "Mr",
"firstName": "Rolf",
"middleName": "J",
"lastName": "Gerling",
"nickName": "Rolf",
"suffix": "B.E.",
"alias": "Rolf",
"entityName": "Temenos Group",
"startDate": "2012-05-24",
"endDate": "2024-10-20",
"extensionData": {}
}
],
"partyAssessment": [
{
"type": "Benchmark",
"status": "Pass",
"level": "Secured",
"score": "8",
"body": "CIBIL",
"conclusionDate": "2019-12-25",
"details": "",
"nature": "D",
"reason": "",
"nextAssessmentDate": "2019-12-25",
"expirydate": "2019-12-25",
"extensionData": {}
}
],
"partyIdentifier": [
{
"type": "Passport",
"status": "New",
"issuingAuthority": "Ministry of Foreign Affairs",
"identifierNumber": "JI35VEGVS",
"issuedDate": "2017-10-24",
"expiryDate": "2020-10-24",
"issuingCountry": "US",
"holderName": "Mr. Rolf Gerling",
"isLegalIdentifier": true,
"partyType": "Individual",
"isExternal": true,
"extensionData": {}
}
],
"personPosition": [
{
"personPositionType": "Politically Exposed-PEP",
"countryOfPosition": "US",
"effectiveFromDate": "2019-05-05",
"effectiveToDate": "2024-05-05",
"expiryDate": "2024-05-05",
"comments": "",
"lastUpdated": "2019-05-05",
"informationSource": "News",
"extensionData": {}
}
],
"partyLifeCycle": [
{
"type": "Recognised",
"startDate": "2020-01-01",
"endDate": "2021-01-01",
"changeReason": "",
"extensionData": {}
}
],
"occupation": [
{
"occupationType": "Part time job",
"occupationDescription": "At McDonalds as Cashier",
"extensionData": {}
}
],
"employment": [
{
"employmentReference": "EM20200J33YH",
"type": "Salaried-Employee",
"country": "US",
"jobTitle": "Product Manager",
"employerName": "Temenos",
"startDate": "2019-02-09",
"endDate": "2029-02-09",
"employerSegment": "Services",
"employerOfficePhoneIdd": "1",
"employerOfficePhone": "8574963214",
"employerOfficeEmail": "rolf@temenos.com",
"salary": 1000,
"salaryInCurrency": "Dollar",
"salaryFrequency": "Monthly",
"extensionData": {}
}
],
"otherRiskIndicator": [
{
"type": "Adverse Media",
"doesRiskApply": true,
"explanationIfApplies": "",
"explanationIfDoesnotApply": "",
"extensionData": {}
}
],
"residence": [
{
"type": "Residence",
"country": "US",
"status": "Renter",
"region": "California",
"statusComments": "",
"extensionData": {}
}
],
"vulnerability": [
{
"vulnerabilityType": "Physical",
"vulnerabilityComments": "By Birth",
"extensionData": {}
}
],
"taxDetails": [
{
"taxReference": "TAX23101598",
"taxType": "Income Tax",
"country": "US",
"taxId": "2324-09-242",
"eligibilityType": "Consumption Tax",
"eligibilityReason": "Citizen of country",
"taxStartDate": "2020-05-10",
"endDate": "2021-05-10",
"taxReasonType": "Citizen",
"taxReasonComment": "",
"taxIdLackReason": "",
"isMainTaxResidency": "Yes",
"extensionData": {}
}
],
"contactPoint": [
{
"contactPointType": "Electronic Address",
"startDate": "2020-01-01",
"endDate": "2025-01-01",
"electronicAddress": {
"electronicAddressType": "Email",
"electronicAddress": "rolf@gmail.com",
"electronicCommunicationType": "Primary"
},
"phoneAddress": {
"phoneAddressType": "Home Number",
"internationalPhoneNumber": "+914155552671",
"iddPrefixPhone": "1",
"nationalPhoneNumber": "4155552671"
},
"extensionData": {}
}
],
"contactAddress": [
{
"physicalAddressType": "Home",
"startDate": "2020-01-01",
"reliabilityType": "Confirmed",
"contactName": "Rolf",
"endDate": "2022-01-01",
"countryCode": "US",
"flatNumber": "151",
"floor": "2",
"buildingNumber": "3",
"buildingName": "Copenagen Flats",
"streetName": "Grand Avenue",
"town": "San leandro",
"countrySubdivision": "California",
"postalOrZipCode": "510-286-4444",
"validatedBy": "Smarty Streets",
"postBoxNumber": "A3700",
"usePurpose": "Home Address",
"regionCode": "015",
"district": "Oakland",
"department": "",
"subDepartment": "",
"landmark": "San leandro community center",
"extensionData": {}
}
],
"extensionData": {}
}Sample Response
{
"id": "200722894",
"status": "Success",
"message": "string"
}The getParty API retrieves the details of a party.
GET/party/parties/{partyId}
Sample Response
{
"partyId": "200722894",
"dateOfBirth": "1990-09-09",
"dateOfDeath": "2045-09-09",
"notificationOfDeath": "2045-10-01",
"cityOfBirth": "Newyork",
"countryOfBirth": "US",
"gender": "Male",
"maritalStatus": "Married",
"nationalitys": [
"US"
],
"defaultLanguage": "English",
"noOfDependents": 4,
"reasonForNoCitizenship": "Migration from another country",
"partyType": "Individual",
"partyStatus": "Prospect",
"extensionData": {},
"partyLanguages": [
"English"
],
"citizenships": [
"US"
],
"partyNamess": [
{
"partyId": "200722894",
"title": "Mr",
"firstName": "Rolf",
"middleName": "J",
"lastName": "Gerling",
"nickName": "Rolf",
"suffix": "B.E.",
"alias": "Rolf",
"entityName": "Temenos Group",
"startDate": "2012-05-24",
"endDate": "2024-10-20",
"extensionData": {}
}
],
"partyAssessments": [
{
"partyId": "200722894",
"type": "Benchmark",
"status": "Pass",
"level": "Secured",
"score": "8",
"body": "CIBIL",
"conclusionDate": "2019-12-25",
"details": "",
"nature": "D",
"reason": "",
"nextAssessmentDate": "2019-12-25",
"expirydate": "2019-12-25",
"extensionData": {}
}
],
"partyIdentifiers": [
{
"partyId": "200722894",
"type": "Passport",
"status": "New",
"issuingAuthority": "Ministry of Foreign Affairs",
"identifierNumber": "JI35VEGVS",
"issuedDate": "2017-10-24",
"expiryDate": "2020-10-24",
"issuingCountry": "US",
"holderName": "Mr. Rolf Gerling",
"isLegalIdentifier": true,
"partyType": "Individual",
"isExternal": true,
"extensionData": {}
}
],
"personPositions": [
{
"partyId": "200722894",
"personPositionType": "Politically Exposed-PEP",
"countryOfPosition": "US",
"effectiveFromDate": "2019-05-05",
"effectiveToDate": "2024-05-05",
"expiryDate": "2024-05-05",
"comments": "",
"lastUpdated": "2019-05-05",
"informationSource": "News",
"extensionData": {}
}
],
"partyLifeCycles": [
{
"partyId": "200722894",
"type": "Recognised",
"startDate": "2020-01-01",
"endDate": "2021-01-01",
"changeReason": "",
"extensionData": {}
}
],
"occupations": [
{
"partyId": "200722894",
"occupationType": "Part time job",
"occupationDescription": "At McDonalds as Cashier",
"extensionData": {}
}
],
"employments": [
{
"partyId": "200722894",
"employmentReference": "EM20200J33YH",
"type": "Salaried-Employee",
"country": "US",
"jobTitle": "Product Manager",
"employerName": "Temenos",
"startDate": "2019-02-09",
"endDate": "2029-02-09",
"employerSegment": "Services",
"employerOfficePhoneIdd": "1",
"employerOfficePhone": "8574963214",
"employerOfficeEmail": "rolf@temenos.com",
"salary": 1000,
"salaryInCurrency": "Dollar",
"salaryFrequency": "Monthly",
"extensionData": {}
}
],
"otherRiskIndicators": [
{
"partyId": "200722894",
"type": "Adverse Media",
"doesRiskApply": true,
"explanationIfApplies": "",
"explanationIfDoesnotApply": "",
"extensionData": {}
}
],
"residences": [
{
"partyId": "200722894",
"type": "Residence",
"country": "US",
"status": "Renter",
"region": "California",
"statusComments": "",
"extensionData": {}
}
],
"vulnerabilitys": [
{
"partyId": "200722894",
"vulnerabilityType": "Physical",
"vulnerabilityComments": "By Birth",
"extensionData": {}
}
],
"taxDetailss": [
{
"partyId": "200722894",
"taxReference": "TAX23101598",
"taxType": "Income Tax",
"country": "US",
"taxId": "2324-09-242",
"eligibilityType": "Consumption Tax",
"eligibilityReason": "Citizen of country",
"taxStartDate": "2020-05-10",
"endDate": "2021-05-10",
"taxReasonType": "Citizen",
"taxReasonComment": "",
"taxIdLackReason": "",
"isMainTaxResidency": "Yes",
"extensionData": {}
}
],
"contactPoints": [
{
"partyId": "200722894",
"contactPointType": "Electronic Address",
"startDate": "2020-01-01",
"endDate": "2025-01-01",
"electronicAddress": {
"electronicAddressType": "Email",
"electronicAddress": "rolf@gmail.com",
"electronicCommunicationType": "Primary"
},
"phoneAddress": {
"phoneAddressType": "Home Number",
"internationalPhoneNumber": "+914155552671",
"iddPrefixPhone": "1",
"nationalPhoneNumber": "4155552671"
},
"extensionData": {}
}
],
"contactAddresss": [
{
"partyId": "200722894",
"physicalAddressType": "Home",
"startDate": "2020-01-01",
"reliabilityType": "Confirmed",
"contactName": "Rolf",
"endDate": "2022-01-01",
"countryCode": "US",
"flatNumber": "151",
"floor": "2",
"buildingNumber": "3",
"buildingName": "Copenagen Flats",
"streetName": "Grand Avenue",
"town": "San leandro",
"countrySubdivision": "California",
"postalOrZipCode": "510-286-4444",
"validatedBy": "Smarty Streets",
"postBoxNumber": "A3700",
"usePurpose": "Home Address",
"regionCode": "015",
"district": "Oakland",
"department": "",
"subDepartment": "",
"landmark": "San leandro community center",
"extensionData": {}
}
]
}The createcontactDetails API creates a new contact point and contact address records for a party. The contact point and the contact address can be created only for the existing parties.
POST/party/parties/{partyId}/contactDetails
Sample Request
{
"contactPoint": [
{
"contactPointType": "Electronic Address",
"startDate": "2020-01-01",
"endDate": "2025-01-01",
"electronicAddress": {
"electronicAddressType": "Email",
"electronicAddress": "rolf@gmail.com",
"electronicCommunicationType": "Primary"
},
"phoneAddress": {
"phoneAddressType": "Home Number",
"internationalPhoneNumber": "+914155552671",
"iddPrefixPhone": "1",
"nationalPhoneNumber": "4155552671"
}
}
],
"contactAddress": [
{
"physicalAddressType": "Home",
"startDate": "2020-01-01",
"reliabilityType": "Confirmed",
"contactName": "Rolf",
"endDate": "2022-01-01",
"countryCode": "US",
"flatNumber": "151",
"floor": "2",
"buildingNumber": "3",
"buildingName": "Copenagen Flats",
"streetName": "Grand Avenue",
"town": "San leandro",
"countrySubdivision": "California",
"postalOrZipCode": "510-286-4444",
"validatedBy": "Smarty Streets",
"postBoxNumber": "A3700",
"usePurpose": "Home Address",
"regionCode": "015",
"district": "Oakland",
"department": "",
"subDepartment": "",
"landmark": "San leandro community center"
}
]
}Sample Response
{
"id": "200722894",
"status": "Success",
"message": "string"
}The updatecontactDetails API amends the existing contact point and contact address records for a party.
PUT/party/parties/{partyId}/contactDetails
Sample Request
{
"contactPoint": [
{
"contactPointType": "Electronic Address",
"startDate": "2020-01-01",
"endDate": "2025-01-01",
"electronicAddress": {
"electronicAddressType": "Email",
"electronicAddress": "rolf@gmail.com",
"electronicCommunicationType": "Primary"
},
"phoneAddress": {
"phoneAddressType": "Home Number",
"internationalPhoneNumber": "+914155552671",
"iddPrefixPhone": "1",
"nationalPhoneNumber": "4155552671"
}
}
],
"contactAddress": [
{
"physicalAddressType": "Home",
"startDate": "2020-01-01",
"reliabilityType": "Confirmed",
"contactName": "Rolf",
"endDate": "2022-01-01",
"countryCode": "US",
"flatNumber": "151",
"floor": "2",
"buildingNumber": "3",
"buildingName": "Copenagen Flats",
"streetName": "Grand Avenue",
"town": "San leandro",
"countrySubdivision": "California",
"postalOrZipCode": "510-286-4444",
"validatedBy": "Smarty Streets",
"postBoxNumber": "A3700",
"usePurpose": "Home Address",
"regionCode": "015",
"district": "Oakland",
"department": "",
"subDepartment": "",
"landmark": "San leandro community center"
}
]
}Sample Response
{
"id": "200722894",
"status": "Success",
"message": "string"
}The getcontactDetails API retrieves the contact point and the contact address records of a party.
GET/party/parties/{partyId}/contactDetails
Sample Response
{
"contactPoints": [
{
"partyId": "200722894",
"contactPointType": "Electronic Address",
"startDate": "2020-01-01",
"endDate": "2025-01-01",
"electronicAddress": {
"electronicAddressType": "Email",
"electronicAddress": "rolf@gmail.com",
"electronicCommunicationType": "Primary"
},
"phoneAddress": {
"phoneAddressType": "Home Number",
"internationalPhoneNumber": "+914155552671",
"iddPrefixPhone": "1",
"nationalPhoneNumber": "4155552671"
}
}
],
"contactAddresss": [
{
"partyId": "200722894",
"physicalAddressType": "Home",
"startDate": "2020-01-01",
"reliabilityType": "Confirmed",
"contactName": "Rolf",
"endDate": "2022-01-01",
"countryCode": "US",
"flatNumber": "151",
"floor": "2",
"buildingNumber": "3",
"buildingName": "Copenagen Flats",
"streetName": "Grand Avenue",
"town": "San leandro",
"countrySubdivision": "California",
"postalOrZipCode": "510-286-4444",
"validatedBy": "Smarty Streets",
"postBoxNumber": "A3700",
"usePurpose": "Home Address",
"regionCode": "015",
"district": "Oakland",
"department": "",
"subDepartment": "",
"landmark": "San leandro community center"
}
]
}The createPartyIdentifier API creates a new identifier record for a party. Party identifiers can be created only for the existing parties.
POST/party/parties/{partyId}/partyIdentifiers
Sample Request
{
"partyIdentifier": [
{
"type": "Passport",
"status": "New",
"issuingAuthority": "Ministry of Foreign Affairs",
"identifierNumber": "JI35VEGVS",
"issuedDate": "2017-10-24",
"expiryDate": "2020-10-24",
"issuingCountry": "US",
"holderName": "Mr. Rolf Gerling",
"isLegalIdentifier": true,
"partyType": "Individual",
"isExternal": true
}
]
}Sample Response
{
"id": "200722894",
"status": "Success",
"message": "string"
}The updatePartyIdentifier API updates or changes the existing identifier record of a party.
PUT/party/parties/{partyId}/partyIdentifiers
Sample Request
{
"partyIdentifier": [
{
"type": "Passport",
"status": "New",
"issuingAuthority": "Ministry of Foreign Affairs",
"identifierNumber": "JI35VEGVS",
"issuedDate": "2017-10-24",
"expiryDate": "2020-10-24",
"issuingCountry": "US",
"holderName": "Mr. Rolf Gerling",
"isLegalIdentifier": true,
"partyType": "Individual",
"isExternal": true
}
]
}Sample Response
{
"id": "200722894",
"status": "Success",
"message": "string"
}
The getPartyIdentifier API retrieve the identifier records for a party.
GET/party/parties/{partyId}/partyIdentifiers
Sample Response
{
"partyIdentifiers": [
{
"partyId": "200722894",
"type": "Passport",
"status": "New",
"issuingAuthority": "Ministry of Foreign Affairs",
"identifierNumber": "JI35VEGVS",
"issuedDate": "2017-10-24",
"expiryDate": "2020-10-24",
"issuingCountry": "US",
"holderName": "Mr. Rolf Gerling",
"isLegalIdentifier": true,
"partyType": "Individual",
"isExternal": true
}
]
}The createPartyAssessment API creates a new assessment record for a party. Party assessment can be created only for the existing parties.
POST/party/parties/{partyId}/partyAssessments
Sample Request
{
"partyAssessment": [
{
"type": "Benchmark",
"status": "Pass",
"level": "Secured",
"score": "8",
"body": "CIBIL",
"conclusionDate": "2019-12-25",
"details": "",
"nature": "D",
"reason": "",
"nextAssessmentDate": "2019-12-25",
"expirydate": "2019-12-25"
}
]
}Sample Response
{
"id": "200722894",
"status": "Success",
"message": "string"
}The updatePartyAssessment API updates or changes the existing assessment records of a party.
PUT/party/parties/{partyId}/partyAssessments
Sample Request
{
"partyAssessment": [
{
"type": "Benchmark",
"status": "Pass",
"level": "Secured",
"score": "8",
"body": "CIBIL",
"conclusionDate": "2019-12-25",
"details": "",
"nature": "D",
"reason": "",
"nextAssessmentDate": "2019-12-25",
"expirydate": "2019-12-25"
}
]
}Sample Response
{
"id": "200722894",
"status": "Success",
"message": "string"
}The getPartyAssessment API retrieves the assessment records of a party.
GET/party/parties/{partyId}/partyAssessments
Sample Response
{
"partyAssessments": [
{
"partyId": "200722894",
"type": "Benchmark",
"status": "Pass",
"level": "Secured",
"score": "8",
"body": "CIBIL",
"conclusionDate": "2019-12-25",
"details": "",
"nature": "D",
"reason": "",
"nextAssessmentDate": "2019-12-25",
"expirydate": "2019-12-25"
}
]
}The createEmploymentDetails API creates a new employment details record for a party. Employment details can be created only for the existing parties.
POST/party/parties/{partyId}/employmentDetails
Sample Request
{
"employment": [
{
"type": "Salaried-Employee",
"country": "US",
"jobTitle": "Product Manager",
"employerName": "Temenos",
"startDate": "2019-02-09",
"endDate": "2029-02-09",
"employerSegment": "Services",
"employerOfficePhoneIdd": "1",
"employerOfficePhone": "8574963214",
"employerOfficeEmail": "rolf@temenos.com",
"salary": 1000,
"salaryInCurrency": "Dollar",
"salaryFrequency": "Monthly"
}
],
"occupation": [
{
"occupationType": "Part time job",
"occupationDescription": "At McDonalds as Cashier"
}
]
}Sample Response
{"id": "200722894",
"status": "Success",
"message": "string"
}
The updateEmploymentDetails API updates or changes the existing employment details record for a party.
PUT/party/parties/{partyId}/employmentDetails
Sample Request
{
"employment": [
{
"employmentReference": "EM20200J33YH",
"type": "Salaried-Employee",
"country": "US",
"jobTitle": "Product Manager",
"employerName": "Temenos",
"startDate": "2019-02-09",
"endDate": "2029-02-09",
"employerSegment": "Services",
"employerOfficePhoneIdd": "1",
"employerOfficePhone": "8574963214",
"employerOfficeEmail": "rolf@temenos.com",
"salary": 1000,
"salaryInCurrency": "Dollar",
"salaryFrequency": "Monthly",
"extensionData": {}
}
],
"occupation": [
{
"occupationType": "Part time job",
"occupationDescription": "At McDonalds as Cashier",
"extensionData": {}
}
]
}Sample Response
{
"id": "200722894",
"status": "Success",
"message": "string"
}The getEmploymentDetails API retrieves the employment details of a party.
GET/party/parties/{partyId}/employmentDetails
Sample Response
{
"employments": [
{
"partyId": "200722894",
"employmentReference": "EM20200J33YH",
"type": "Salaried-Employee",
"country": "US",
"jobTitle": "Product Manager",
"employerName": "Temenos",
"startDate": "2019-02-09",
"endDate": "2029-02-09",
"employerSegment": "Services",
"employerOfficePhoneIdd": "1",
"employerOfficePhone": "8574963214",
"employerOfficeEmail": "rolf@temenos.com",
"salary": 1000,
"salaryInCurrency": "Dollar",
"salaryFrequency": "Monthly",
"extensionData": {}
}
],
"occupations": [
{
"partyId": "200722894",
"occupationType": "Part time job",
"occupationDescription": "At McDonalds as Cashier",
"extensionData": {}
}
]
}The createTaxDetails API creates a new tax details record for a party. Tax details can be created only for the existing parties.
POST/party/parties/{partyId}/taxDetails
Sample Request
{
"taxDetails": [
{
"taxType": "Income Tax",
"country": "US",
"taxId": "2324-09-242",
"eligibilityType": "Consumption Tax",
"eligibilityReason": "Citizen of country",
"taxStartDate": "2020-05-10",
"endDate": "2021-05-10",
"taxReasonType": "Citizen",
"taxReasonComment": "",
"taxIdLackReason": "",
"isMainTaxResidency": "Yes"
}
]
}Sample Response
{
"id": "200722894",
"status": "Success",
"message": "string"
}The updateTaxDetails API updates or changes the existing tax details record for a party.
PUT/party/parties/{partyId}/taxDetails
Sample Request
{
"taxDetails": [
{
"taxReference": "TAX23101598",
"taxType": "Income Tax",
"country": "US",
"taxId": "2324-09-242",
"eligibilityType": "Consumption Tax",
"eligibilityReason": "Citizen of country",
"taxStartDate": "2020-05-10",
"endDate": "2021-05-10",
"taxReasonType": "Citizen",
"taxReasonComment": "",
"taxIdLackReason": "",
"isMainTaxResidency": "Yes",
"extensionData": {}
}
]
}Sample Response
{
"id": "200722894",
"status": "Success",
"message": "string"
}The getTaxDetails API retrieves the tax details records of a party.
GET/party/parties/{partyId}/taxDetails
Sample Response
{
"taxDetailss": [
{
"partyId": "200722894",
"taxReference": "TAX23101598",
"taxType": "Income Tax",
"country": "US",
"taxId": "2324-09-242",
"eligibilityType": "Consumption Tax",
"eligibilityReason": "Citizen of country",
"taxStartDate": "2020-05-10",
"endDate": "2021-05-10",
"taxReasonType": "Citizen",
"taxReasonComment": "",
"taxIdLackReason": "",
"isMainTaxResidency": "Yes",
"extensionData": {}
}
]
}The getReferenceDataForParty API retrieves reference data based on the reference ID.
GET/reference/{referenceId}
Sample Response
{
"genders": [
{
"id": "string",
"description": "string"
}
],
"maritalStatuss": [
{
"id": "string",
"description": "string"
}
],
"languages": [
{
"id": "string",
"description": "string"
}
],
"titles": [
{
"id": "string",
"description": "string"
}
],
"partyIdentifierStatuss": [
{
"id": "string",
"description": "string"
}
],
"lifeCycleStatusTypes": [
{
"id": "string",
"description": "string"
}
],
"contactPointTypes": [
{
"id": "string",
"description": "string"
}
],
"reliabilityTypes": [
{
"id": "string",
"description": "string"
}
],
"electronicAddressTypes": [
{
"id": "string",
"description": "string"
}
],
"electronicCommunicationTypes": [
{
"id": "string",
"description": "string"
}
],
"phoneAddressTypes": [
{
"id": "string",
"description": "string"
}
],
"physicalAddressTypes": [
{
"id": "string",
"description": "string"
}
],
"addressUsePurposes": [
{
"id": "string",
"description": "string"
}
],
"assessmentNatures": [
{
"id": "string",
"description": "string"
}
],
"assessmentLevels": [
{
"id": "string",
"description": "string"
}
],
"assessmentTypes": [
{
"id": "string",
"description": "string"
}
],
"residenceTypes": [
{
"id": "string",
"description": "string"
}
],
"residentialStatuss": [
{
"id": "string",
"description": "string"
}
],
"occupationTypes": [
{
"id": "string",
"description": "string"
}
],
"jobTitles": [
{
"id": "string",
"description": "string"
}
],
"currencys": [
{
"id": "string",
"description": "string"
}
],
"taxReasonTypes": [
{
"id": "string",
"description": "string"
}
],
"taxTypes": [
{
"id": "string",
"description": "string"
}
],
"taxEligibilityTypes": [
{
"id": "string",
"description": "string"
}
],
"vulnerabilityTypes": [
{
"id": "string",
"description": "string"
}
],
"riskIndicatorTypes": [
{
"id": "string",
"description": "string"
}
],
"partyRoleTypes": [
{
"id": "string",
"description": "string"
}
],
"legalIdentifierTypes": [
{
"id": "string",
"description": "string"
}
],
"isMainTaxResidencys": [
{
"id": "string",
"description": "string"
}
],
"partyTypes": [
{
"id": "string",
"description": "string"
}
],
"positionTypes": [
{
"id": "string",
"description": "string"
}
],
"personPositionCategorys": [
{
"id": "string",
"description": "string"
}
],
"partyStatuss": [
{
"id": "string",
"description": "string"
}
],
"informationSources": [
{
"informationSourceScope": "News",
"informationSourceValue": "Industry Classification Updated"
}
],
"residenceRegions": [
{
"residenceCountry": "United States",
"residenceRegion": "California"
}
],
"countrys": [
{
"countryCode": "US",
"countryName": "United States",
"numericCountryCode": 1,
"alpha3CountryCode": "USA",
"highRiskCountry": false,
"iddPrefix": 1
}
],
"employmentTypes": [
{
"employmentStatusType": "Employed",
"employmentType": "Self-Employed",
"description": "This record is applicable for all type of self-employees"
}
],
"personPositionTypes": [
{
"type": "Politically Exposed",
"category": "PEP",
"description": ""
}
]
}Version 1.0.1
The APIs of the V1.0.1 version contain the fixes from the APIs of the V1.0 version such as naming conventions.
The V1.0.1 version of Party microservice APIs contains seven functional groups with their respective operations as follows.
| Functional Group | Description | Operations | |||
|---|---|---|---|---|---|
| Party | Party is a group that the bank or the financial institution collects information for the business purpose. |
|
|||
| ContactPoint/ContactAddress | ContactPoint and ContactAddress store information about different end-points at which a party could be contacted. |
|
|||
| PartyIdentifier | The PartyIdentifier group identifies the legal identification documents that are associated with a party. |
|
|||
| PartyAssessment | The PartyAssesment group stores the results of various assessments. These assessments are done by third-party systems such as AML and PEP Screening. |
|
|||
| EmploymentDetails | The EmploymentDetails group contains the employment and occupational details of a party. |
|
|||
| TaxDetails | The TaxDetails group captures the taxation details of a party. |
|
|||
| ReferenceTables | The ReferenceTables group contains the static data for all the reference entities. | getReferenceDataForPartyV1_0_1 |
To view the Swagger Spec of the Party microservice APIs, click here.
The createPartyV1_0_1 API creates a new party record. This API is used to create party data such as party name, alternate identity, addresses, party identifier, and all the entities that are linked to the party
POST/party/parties
Sample Request
{
"dateOfBirth": "1990-09-09",
"dateOfDeath": "2045-09-09",
"notificationOfDeath": "2045-10-01",
"cityOfBirth": "Newyork",
"countryOfBirth": "US",
"gender": "Male",
"maritalStatus": "Married",
"nationalities": [
"US"
],
"defaultLanguage": "English",
"noOfDependents": 4,
"reasonForNoCitizenship": "Migration from another country",
"partyType": "Individual",
"partyStatus": "Prospect",
"partyLanguages": [
"English"
],
"citizenships": [
"US"
],
"partyNames": [
{
"title": "Mr",
"firstName": "Rolf",
"middleName": "J",
"lastName": "Gerling",
"nickName": "Rolf",
"suffix": "B.E.",
"alias": "Rolf",
"entityName": "Temenos Group",
"startDate": "2012-05-24",
"endDate": "2024-10-20",
"extensionData": {}
}
],
"partyAssessments": [
{
"type": "Benchmark",
"status": "Pass",
"level": "Secured",
"score": "8",
"body": "CIBIL",
"conclusionDate": "2019-12-25",
"details": "",
"nature": "D",
"reason": "",
"nextAssessmentDate": "2019-12-25",
"expirydate": "2019-12-25",
"extensionData": {}
}
],
"partyIdentifiers": [
{
"type": "Passport",
"status": "New",
"issuingAuthority": "Ministry of Foreign Affairs",
"identifierNumber": "JI35VEGVS",
"issuedDate": "2017-10-24",
"expiryDate": "2020-10-24",
"issuingCountry": "US",
"holderName": "Mr. Rolf Gerling",
"isLegalIdentifier": true,
"partyType": "Individual",
"isExternal": true,
"extensionData": {}
}
],
"personPositions": [
{
"personPositionType": "Politically Exposed-PEP",
"countryOfPosition": "US",
"effectiveFromDate": "2019-05-05",
"effectiveToDate": "2024-05-05",
"expiryDate": "2024-05-05",
"comments": "",
"lastUpdated": "2019-05-05",
"informationSource": "News",
"extensionData": {}
}
],
"partyLifeCycles": [
{
"type": "Recognised",
"startDate": "2020-01-01",
"endDate": "2021-01-01",
"changeReason": "",
"extensionData": {}
}
],
"occupations": [
{
"occupationType": "Part time job",
"occupationDescription": "At McDonalds as Cashier",
"extensionData": {}
}
],
"employments": [
{
"type": "Salaried-Employee",
"country": "US",
"jobTitle": "Product Manager",
"employerName": "Temenos",
"startDate": "2019-02-09",
"endDate": "2029-02-09",
"employerSegment": "Services",
"employerOfficePhoneIdd": "1",
"employerOfficePhone": "8574963214",
"employerOfficeEmail": "rolf@temenos.com",
"salary": 1000,
"salaryInCurrency": "Dollar",
"salaryFrequency": "Monthly",
"extensionData": {}
}
],
"otherRiskIndicators": [
{
"type": "Adverse Media",
"doesRiskApply": true,
"explanationIfApplies": "",
"explanationIfDoesnotApply": "",
"extensionData": {}
}
],
"residences": [
{
"type": "Residence",
"country": "US",
"status": "Renter",
"region": "California",
"statusComments": "",
"extensionData": {}
}
],
"vulnerabilities": [
{
"vulnerabilityType": "Physical",
"vulnerabilityComments": "By Birth",
"extensionData": {}
}
],
"taxDetails": [
{
"taxType": "Income Tax",
"country": "US",
"taxId": "2324-09-242",
"eligibilityType": "Consumption Tax",
"eligibilityReason": "Citizen of country",
"taxStartDate": "2020-05-10",
"endDate": "2021-05-10",
"taxReasonType": "Citizen",
"taxReasonComment": "",
"taxIdLackReason": "",
"isMainTaxResidency": "Yes",
"extensionData": {}
}
],
"contactPoints": [
{
"contactPointType": "Electronic Address",
"startDate": "2020-01-01",
"endDate": "2025-01-01",
"electronicAddress": {
"electronicAddressType": "Email",
"electronicAddress": "rolf@gmail.com",
"electronicCommunicationType": "Primary"
},
"phoneAddress": {
"phoneAddressType": "Home Number",
"internationalPhoneNumber": "+914155552671",
"iddPrefixPhone": "1",
"nationalPhoneNumber": "4155552671"
},
"extensionData": {}
}
],
"contactAddresses": [
{
"physicalAddressType": "Home",
"startDate": "2020-01-01",
"reliabilityType": "Confirmed",
"contactName": "Rolf",
"endDate": "2022-01-01",
"countryCode": "US",
"flatNumber": "151",
"floor": "2",
"buildingNumber": "3",
"buildingName": "Copenagen Flats",
"streetName": "Grand Avenue",
"town": "San leandro",
"countrySubdivision": "California",
"postalOrZipCode": "510-286-4444",
"validatedBy": "Smarty Streets",
"postBoxNumber": "A3700",
"usePurpose": "Home Address",
"regionCode": "015",
"district": "Oakland",
"department": "",
"subDepartment": "",
"landmark": "San leandro community center",
"extensionData": {}
}
],
"extensionData": {}
}Sample Response
{
"id": "200722894",
"status": "Success",
"message": "string"
}The udpatePartyV1_0_1 API updates or changes the existing records of a party.
PUT/party/parties/{partyId}
Sample Request
{
"dateOfBirth": "1990-09-09",
"dateOfDeath": "2045-09-09",
"notificationOfDeath": "2045-10-01",
"cityOfBirth": "Newyork",
"countryOfBirth": "US",
"gender": "Male",
"maritalStatus": "Married",
"nationalities": [
"US"
],
"defaultLanguage": "English",
"noOfDependents": 4,
"reasonForNoCitizenship": "Migration from another country",
"partyType": "Individual",
"partyStatus": "Prospect",
"partyLanguages": [
"English"
],
"citizenships": [
"US"
],
"partyNames": [
{
"title": "Mr",
"firstName": "Rolf",
"middleName": "J",
"lastName": "Gerling",
"nickName": "Rolf",
"suffix": "B.E.",
"alias": "Rolf",
"entityName": "Temenos Group",
"startDate": "2012-05-24",
"endDate": "2024-10-20",
"extensionData": {}
}
],
"partyAssessments": [
{
"type": "Benchmark",
"status": "Pass",
"level": "Secured",
"score": "8",
"body": "CIBIL",
"conclusionDate": "2019-12-25",
"details": "",
"nature": "D",
"reason": "",
"nextAssessmentDate": "2019-12-25",
"expirydate": "2019-12-25",
"extensionData": {}
}
],
"partyIdentifiers": [
{
"type": "Passport",
"status": "New",
"issuingAuthority": "Ministry of Foreign Affairs",
"identifierNumber": "JI35VEGVS",
"issuedDate": "2017-10-24",
"expiryDate": "2020-10-24",
"issuingCountry": "US",
"holderName": "Mr. Rolf Gerling",
"isLegalIdentifier": true,
"partyType": "Individual",
"isExternal": true,
"extensionData": {}
}
],
"personPositions": [
{
"personPositionType": "Politically Exposed-PEP",
"countryOfPosition": "US",
"effectiveFromDate": "2019-05-05",
"effectiveToDate": "2024-05-05",
"expiryDate": "2024-05-05",
"comments": "",
"lastUpdated": "2019-05-05",
"informationSource": "News",
"extensionData": {}
}
],
"partyLifeCycles": [
{
"type": "Recognised",
"startDate": "2020-01-01",
"endDate": "2021-01-01",
"changeReason": "",
"extensionData": {}
}
],
"occupations": [
{
"occupationType": "Part time job",
"occupationDescription": "At McDonalds as Cashier",
"extensionData": {}
}
],
"employments": [
{
"employmentReference": "EM20200J33YH",
"type": "Salaried-Employee",
"country": "US",
"jobTitle": "Product Manager",
"employerName": "Temenos",
"startDate": "2019-02-09",
"endDate": "2029-02-09",
"employerSegment": "Services",
"employerOfficePhoneIdd": "1",
"employerOfficePhone": "8574963214",
"employerOfficeEmail": "rolf@temenos.com",
"salary": 1000,
"salaryInCurrency": "Dollar",
"salaryFrequency": "Monthly",
"extensionData": {}
}
],
"otherRiskIndicators": [
{
"type": "Adverse Media",
"doesRiskApply": true,
"explanationIfApplies": "",
"explanationIfDoesnotApply": "",
"extensionData": {}
}
],
"residences": [
{
"type": "Residence",
"country": "US",
"status": "Renter",
"region": "California",
"statusComments": "",
"extensionData": {}
}
],
"vulnerabilities": [
{
"vulnerabilityType": "Physical",
"vulnerabilityComments": "By Birth",
"extensionData": {}
}
],
"taxDetails": [
{
"taxReference": "TAX23101598",
"taxType": "Income Tax",
"country": "US",
"taxId": "2324-09-242",
"eligibilityType": "Consumption Tax",
"eligibilityReason": "Citizen of country",
"taxStartDate": "2020-05-10",
"endDate": "2021-05-10",
"taxReasonType": "Citizen",
"taxReasonComment": "",
"taxIdLackReason": "",
"isMainTaxResidency": "Yes",
"extensionData": {}
}
],
"contactPoints": [
{
"contactPointType": "Electronic Address",
"startDate": "2020-01-01",
"endDate": "2025-01-01",
"electronicAddress": {
"electronicAddressType": "Email",
"electronicAddress": "rolf@gmail.com",
"electronicCommunicationType": "Primary"
},
"phoneAddress": {
"phoneAddressType": "Home Number",
"internationalPhoneNumber": "+914155552671",
"iddPrefixPhone": "1",
"nationalPhoneNumber": "4155552671"
},
"extensionData": {}
}
],
"contactAddresses": [
{
"physicalAddressType": "Home",
"startDate": "2020-01-01",
"reliabilityType": "Confirmed",
"contactName": "Rolf",
"endDate": "2022-01-01",
"countryCode": "US",
"flatNumber": "151",
"floor": "2",
"buildingNumber": "3",
"buildingName": "Copenagen Flats",
"streetName": "Grand Avenue",
"town": "San leandro",
"countrySubdivision": "California",
"postalOrZipCode": "510-286-4444",
"validatedBy": "Smarty Streets",
"postBoxNumber": "A3700",
"usePurpose": "Home Address",
"regionCode": "015",
"district": "Oakland",
"department": "",
"subDepartment": "",
"landmark": "San leandro community center",
"extensionData": {}
}
],
"extensionData": {}
}Sample Response
{
"id": "200722894",
"status": "Success",
"message": "string"
}The getPartyV1_0_1 API retrieves the details of a party.
GET/party/parties/{partyId}
Sample Response
{
"partyId": "200722894",
"dateOfBirth": "1990-09-09",
"dateOfDeath": "2045-09-09",
"notificationOfDeath": "2045-10-01",
"cityOfBirth": "Newyork",
"countryOfBirth": "US",
"gender": "Male",
"maritalStatus": "Married",
"nationalities": [
"US"
],
"defaultLanguage": "English",
"noOfDependents": 4,
"reasonForNoCitizenship": "Migration from another country",
"partyType": "Individual",
"partyStatus": "Prospect",
"extensionData": {},
"partyLanguages": [
"English"
],
"citizenships": [
"US"
],
"partyNames": [
{
"partyId": "200722894",
"title": "Mr",
"firstName": "Rolf",
"middleName": "J",
"lastName": "Gerling",
"nickName": "Rolf",
"suffix": "B.E.",
"alias": "Rolf",
"entityName": "Temenos Group",
"startDate": "2012-05-24",
"endDate": "2024-10-20",
"extensionData": {}
}
],
"partyAssessments": [
{
"partyId": "200722894",
"type": "Benchmark",
"status": "Pass",
"level": "Secured",
"score": "8",
"body": "CIBIL",
"conclusionDate": "2019-12-25",
"details": "",
"nature": "D",
"reason": "",
"nextAssessmentDate": "2019-12-25",
"expirydate": "2019-12-25",
"extensionData": {}
}
],
"partyIdentifiers": [
{
"partyId": "200722894",
"type": "Passport",
"status": "New",
"issuingAuthority": "Ministry of Foreign Affairs",
"identifierNumber": "JI35VEGVS",
"issuedDate": "2017-10-24",
"expiryDate": "2020-10-24",
"issuingCountry": "US",
"holderName": "Mr. Rolf Gerling",
"isLegalIdentifier": true,
"partyType": "Individual",
"isExternal": true,
"extensionData": {}
}
],
"personPositions": [
{
"partyId": "200722894",
"personPositionType": "Politically Exposed-PEP",
"countryOfPosition": "US",
"effectiveFromDate": "2019-05-05",
"effectiveToDate": "2024-05-05",
"expiryDate": "2024-05-05",
"comments": "",
"lastUpdated": "2019-05-05",
"informationSource": "News",
"extensionData": {}
}
],
"partyLifeCycles": [
{
"partyId": "200722894",
"type": "Recognised",
"startDate": "2020-01-01",
"endDate": "2021-01-01",
"changeReason": "",
"extensionData": {}
}
],
"occupations": [
{
"partyId": "200722894",
"occupationType": "Part time job",
"occupationDescription": "At McDonalds as Cashier",
"extensionData": {}
}
],
"employments": [
{
"partyId": "200722894",
"employmentReference": "EM20200J33YH",
"type": "Salaried-Employee",
"country": "US",
"jobTitle": "Product Manager",
"employerName": "Temenos",
"startDate": "2019-02-09",
"endDate": "2029-02-09",
"employerSegment": "Services",
"employerOfficePhoneIdd": "1",
"employerOfficePhone": "8574963214",
"employerOfficeEmail": "rolf@temenos.com",
"salary": 1000,
"salaryInCurrency": "Dollar",
"salaryFrequency": "Monthly",
"extensionData": {}
}
],
"otherRiskIndicators": [
{
"partyId": "200722894",
"type": "Adverse Media",
"doesRiskApply": true,
"explanationIfApplies": "",
"explanationIfDoesnotApply": "",
"extensionData": {}
}
],
"residences": [
{
"partyId": "200722894",
"type": "Residence",
"country": "US",
"status": "Renter",
"region": "California",
"statusComments": "",
"extensionData": {}
}
],
"vulnerabilities": [
{
"partyId": "200722894",
"vulnerabilityType": "Physical",
"vulnerabilityComments": "By Birth",
"extensionData": {}
}
],
"taxDetails": [
{
"partyId": "200722894",
"taxReference": "TAX23101598",
"taxType": "Income Tax",
"country": "US",
"taxId": "2324-09-242",
"eligibilityType": "Consumption Tax",
"eligibilityReason": "Citizen of country",
"taxStartDate": "2020-05-10",
"endDate": "2021-05-10",
"taxReasonType": "Citizen",
"taxReasonComment": "",
"taxIdLackReason": "",
"isMainTaxResidency": "Yes",
"extensionData": {}
}
],
"contactPoints": [
{
"partyId": "200722894",
"contactPointType": "Electronic Address",
"startDate": "2020-01-01",
"endDate": "2025-01-01",
"electronicAddress": {
"electronicAddressType": "Email",
"electronicAddress": "rolf@gmail.com",
"electronicCommunicationType": "Primary"
},
"phoneAddress": {
"phoneAddressType": "Home Number",
"internationalPhoneNumber": "+914155552671",
"iddPrefixPhone": "1",
"nationalPhoneNumber": "4155552671"
},
"extensionData": {}
}
],
"contactAddresses": [
{
"partyId": "200722894",
"physicalAddressType": "Home",
"startDate": "2020-01-01",
"reliabilityType": "Confirmed",
"contactName": "Rolf",
"endDate": "2022-01-01",
"countryCode": "US",
"flatNumber": "151",
"floor": "2",
"buildingNumber": "3",
"buildingName": "Copenagen Flats",
"streetName": "Grand Avenue",
"town": "San leandro",
"countrySubdivision": "California",
"postalOrZipCode": "510-286-4444",
"validatedBy": "Smarty Streets",
"postBoxNumber": "A3700",
"usePurpose": "Home Address",
"regionCode": "015",
"district": "Oakland",
"department": "",
"subDepartment": "",
"landmark": "San leandro community center",
"extensionData": {}
}
]
}The createcontactDetailsV1_0_1 API creates a new contact point and contact address records for a party. The contact point and the contact address can be created only for the existing parties.
POST/party/parties/{partyId}/contactDetails
Sample Request
{
"contactPoints": [
{
"contactPointType": "Electronic Address",
"startDate": "2020-01-01",
"endDate": "2025-01-01",
"electronicAddress": {
"electronicAddressType": "Email",
"electronicAddress": "rolf@gmail.com",
"electronicCommunicationType": "Primary"
},
"phoneAddress": {
"phoneAddressType": "Home Number",
"internationalPhoneNumber": "+914155552671",
"iddPrefixPhone": "1",
"nationalPhoneNumber": "4155552671"
}
}
],
"contactAddresses": [
{
"physicalAddressType": "Home",
"startDate": "2020-01-01",
"reliabilityType": "Confirmed",
"contactName": "Rolf",
"endDate": "2022-01-01",
"countryCode": "US",
"flatNumber": "151",
"floor": "2",
"buildingNumber": "3",
"buildingName": "Copenagen Flats",
"streetName": "Grand Avenue",
"town": "San leandro",
"countrySubdivision": "California",
"postalOrZipCode": "510-286-4444",
"validatedBy": "Smarty Streets",
"postBoxNumber": "A3700",
"usePurpose": "Home Address",
"regionCode": "015",
"district": "Oakland",
"department": "",
"subDepartment": "",
"landmark": "San leandro community center"
}
]
}Sample Response
{
"id": "200722894",
"status": "Success",
"message": "string"
}The updatecontactDetailsV1_0_1 API amends the existing contact point and contact address records for a party.
PUT/party/parties/{partyId}/contactDetails
Sample Request
{
"contactPoints": [
{
"contactPointType": "Electronic Address",
"startDate": "2020-01-01",
"endDate": "2025-01-01",
"electronicAddress": {
"electronicAddressType": "Email",
"electronicAddress": "rolf@gmail.com",
"electronicCommunicationType": "Primary"
},
"phoneAddress": {
"phoneAddressType": "Home Number",
"internationalPhoneNumber": "+914155552671",
"iddPrefixPhone": "1",
"nationalPhoneNumber": "4155552671"
}
}
],
"contactAddresses": [
{
"physicalAddressType": "Home",
"startDate": "2020-01-01",
"reliabilityType": "Confirmed",
"contactName": "Rolf",
"endDate": "2022-01-01",
"countryCode": "US",
"flatNumber": "151",
"floor": "2",
"buildingNumber": "3",
"buildingName": "Copenagen Flats",
"streetName": "Grand Avenue",
"town": "San leandro",
"countrySubdivision": "California",
"postalOrZipCode": "510-286-4444",
"validatedBy": "Smarty Streets",
"postBoxNumber": "A3700",
"usePurpose": "Home Address",
"regionCode": "015",
"district": "Oakland",
"department": "",
"subDepartment": "",
"landmark": "San leandro community center"
}
]
}Sample Response
{
"id": "200722894",
"status": "Success",
"message": "string"
}
The getcontactDetailsV1_0_1 API retrieves the contact point and the contact address records of a party.
GET/party/parties/{partyId}/contactDetails
Sample Response
{
"contactPoints": [
{
"partyId": "200722894",
"contactPointType": "Electronic Address",
"startDate": "2020-01-01",
"endDate": "2025-01-01",
"electronicAddress": {
"electronicAddressType": "Email",
"electronicAddress": "rolf@gmail.com",
"electronicCommunicationType": "Primary"
},
"phoneAddress": {
"phoneAddressType": "Home Number",
"internationalPhoneNumber": "+914155552671",
"iddPrefixPhone": "1",
"nationalPhoneNumber": "4155552671"
}
}
],
"contactAddresses": [
{
"partyId": "200722894",
"physicalAddressType": "Home",
"startDate": "2020-01-01",
"reliabilityType": "Confirmed",
"contactName": "Rolf",
"endDate": "2022-01-01",
"countryCode": "US",
"flatNumber": "151",
"floor": "2",
"buildingNumber": "3",
"buildingName": "Copenagen Flats",
"streetName": "Grand Avenue",
"town": "San leandro",
"countrySubdivision": "California",
"postalOrZipCode": "510-286-4444",
"validatedBy": "Smarty Streets",
"postBoxNumber": "A3700",
"usePurpose": "Home Address",
"regionCode": "015",
"district": "Oakland",
"department": "",
"subDepartment": "",
"landmark": "San leandro community center"
}
]
}The createPartyIdentifierV1_0_1 API creates a new identifier record for a party. Party identifiers can be created only for the existing parties.
POST/party/parties/{partyId}/partyIdentifiers
Sample Request
{
"partyIdentifiers": [
{
"type": "Passport",
"status": "New",
"issuingAuthority": "Ministry of Foreign Affairs",
"identifierNumber": "JI35VEGVS",
"issuedDate": "2017-10-24",
"expiryDate": "2020-10-24",
"issuingCountry": "US",
"holderName": "Mr. Rolf Gerling",
"isLegalIdentifier": true,
"partyType": "Individual",
"isExternal": true
}
]
}Sample Response
{
"id": "200722894",
"status": "Success",
"message": "string"
}The updatePartyIdentifierV1_0_1 API updates or changes the existing identifier record of a party.
PUT/party/parties/{partyId}/partyIdentifiers
Sample Request
{
"partyIdentifiers": [
{
"type": "Passport",
"status": "New",
"issuingAuthority": "Ministry of Foreign Affairs",
"identifierNumber": "JI35VEGVS",
"issuedDate": "2017-10-24",
"expiryDate": "2020-10-24",
"issuingCountry": "US",
"holderName": "Mr. Rolf Gerling",
"isLegalIdentifier": true,
"partyType": "Individual",
"isExternal": true
}
]
}Sample Response
{
"id": "200722894",
"status": "Success",
"message": "string"
}The getPartyIdentifierV1_0_1 API retrieve the identifier records for a party.
GET/party/parties/{partyId}/partyIdentifiers
Sample Response
{
"partyIdentifiers": [
{
"partyId": "200722894",
"type": "Passport",
"status": "New",
"issuingAuthority": "Ministry of Foreign Affairs",
"identifierNumber": "JI35VEGVS",
"issuedDate": "2017-10-24",
"expiryDate": "2020-10-24",
"issuingCountry": "US",
"holderName": "Mr. Rolf Gerling",
"isLegalIdentifier": true,
"partyType": "Individual",
"isExternal": true
}
]
}The createPartyAssessmentV1_0_1 API creates a new assessment record for a party. Party assessment can be created only for the existing parties.
POST/party/parties/{partyId}/partyAssessments
Sample Request
{
"partyAssessments": [
{
"type": "Benchmark",
"status": "Pass",
"level": "Secured",
"score": "8",
"body": "CIBIL",
"conclusionDate": "2019-12-25",
"details": "",
"nature": "D",
"reason": "",
"nextAssessmentDate": "2019-12-25",
"expirydate": "2019-12-25"
}
]
}Sample Response
{
"id": "200722894",
"status": "Success",
"message": "string"
}
The updatePartyAssessmentV1_0_1 API updates or changes the existing assessment records of a party.
PUT/party/parties/{partyId}/partyAssessments
Sample Request
{
"partyAssessments": [
{
"type": "Benchmark",
"status": "Pass",
"level": "Secured",
"score": "8",
"body": "CIBIL",
"conclusionDate": "2019-12-25",
"details": "",
"nature": "D",
"reason": "",
"nextAssessmentDate": "2019-12-25",
"expirydate": "2019-12-25"
}
]
}Sample Response
{
"id": "200722894",
"status": "Success",
"message": "string"
}The getPartyAssessmentV1_0_1 API retrieves the assessment records of a party.
GET/party/parties/{partyId}/partyAssessments
Sample Response
{
"partyAssessments": [
{
"partyId": "200722894",
"type": "Benchmark",
"status": "Pass",
"level": "Secured",
"score": "8",
"body": "CIBIL",
"conclusionDate": "2019-12-25",
"details": "",
"nature": "D",
"reason": "",
"nextAssessmentDate": "2019-12-25",
"expirydate": "2019-12-25"
}
]
}The createEmploymentDetailsV1_0_1 API creates a new employment details record for a party. Employment details can be created only for the existing parties.
POST/party/parties/{partyId}/employmentDetails
Sample Request
{
"employments": [
{
"type": "Salaried-Employee",
"country": "US",
"jobTitle": "Product Manager",
"employerName": "Temenos",
"startDate": "2019-02-09",
"endDate": "2029-02-09",
"employerSegment": "Services",
"employerOfficePhoneIdd": "1",
"employerOfficePhone": "8574963214",
"employerOfficeEmail": "rolf@temenos.com",
"salary": 1000,
"salaryInCurrency": "Dollar",
"salaryFrequency": "Monthly"
}
],
"occupations": [
{
"occupationType": "Part time job",
"occupationDescription": "At McDonalds as Cashier"
}
]
}
Sample Response
{
"id": "200722894",
"status": "Success",
"message": "string"
}The updateEmploymentDetailsV1_0_1 API updates or changes the existing employment details record for a party.
PUT/party/parties/{partyId}/employmentDetails
Sample Request
{
"employments": [
{
"employmentReference": "EM20200J33YH",
"type": "Salaried-Employee",
"country": "US",
"jobTitle": "Product Manager",
"employerName": "Temenos",
"startDate": "2019-02-09",
"endDate": "2029-02-09",
"employerSegment": "Services",
"employerOfficePhoneIdd": "1",
"employerOfficePhone": "8574963214",
"employerOfficeEmail": "rolf@temenos.com",
"salary": 1000,
"salaryInCurrency": "Dollar",
"salaryFrequency": "Monthly",
"extensionData": {}
}
],
"occupations": [
{
"occupationType": "Part time job",
"occupationDescription": "At McDonalds as Cashier",
"extensionData": {}
}
]
}Sample Response
{
"id": "200722894",
"status": "Success",
"message": "string"
}The getEmploymentDetailsV1_0_1 API retrieves the employment details of a party.
GET/party/parties/{partyId}/employmentDetails
Sample Response
{
"employments": [
{
"partyId": "200722894",
"employmentReference": "EM20200J33YH",
"type": "Salaried-Employee",
"country": "US",
"jobTitle": "Product Manager",
"employerName": "Temenos",
"startDate": "2019-02-09",
"endDate": "2029-02-09",
"employerSegment": "Services",
"employerOfficePhoneIdd": "1",
"employerOfficePhone": "8574963214",
"employerOfficeEmail": "rolf@temenos.com",
"salary": 1000,
"salaryInCurrency": "Dollar",
"salaryFrequency": "Monthly",
"extensionData": {}
}
],
"occupations": [
{
"partyId": "200722894",
"occupationType": "Part time job",
"occupationDescription": "At McDonalds as Cashier",
"extensionData": {}
}
]
}The createTaxDetailsV1_0_1 API creates a new tax details record for a party. Tax details can be created only for the existing parties.
POST/party/parties/{partyId}/taxDetails
Sample Request
{
"taxDetails": [
{
"taxType": "Income Tax",
"country": "US",
"taxId": "2324-09-242",
"eligibilityType": "Consumption Tax",
"eligibilityReason": "Citizen of country",
"taxStartDate": "2020-05-10",
"endDate": "2021-05-10",
"taxReasonType": "Citizen",
"taxReasonComment": "",
"taxIdLackReason": "",
"isMainTaxResidency": "Yes"
}
]
}Sample Response
{
"id": "200722894",
"status": "Success",
"message": "string"
}The updateTaxDetailsV1_0_1 API updates or changes the existing tax details record for a party.
PUT/party/parties/{partyId}/taxDetails
Sample Request
{
"taxDetails": [
{
"taxReference": "TAX23101598",
"taxType": "Income Tax",
"country": "US",
"taxId": "2324-09-242",
"eligibilityType": "Consumption Tax",
"eligibilityReason": "Citizen of country",
"taxStartDate": "2020-05-10",
"endDate": "2021-05-10",
"taxReasonType": "Citizen",
"taxReasonComment": "",
"taxIdLackReason": "",
"isMainTaxResidency": "Yes",
"extensionData": {}
}
]
}Sample Response
{
"id": "200722894",
"status": "Success",
"message": "string"
}The getTaxDetailsV1_0_1 API retrieves the tax details records of a party.
GET/party/parties/{partyId}/taxDetails
Sample Response
{
"taxDetails": [
{
"partyId": "200722894",
"taxReference": "TAX23101598",
"taxType": "Income Tax",
"country": "US",
"taxId": "2324-09-242",
"eligibilityType": "Consumption Tax",
"eligibilityReason": "Citizen of country",
"taxStartDate": "2020-05-10",
"endDate": "2021-05-10",
"taxReasonType": "Citizen",
"taxReasonComment": "",
"taxIdLackReason": "",
"isMainTaxResidency": "Yes",
"extensionData": {}
}
]
}The getReferenceDataForPartyV1_0_1 API retrieves reference data based on the reference ID.
GET/reference/{referenceId}
Gender
Sample Response
{
"gender": [
{
"id": "string",
"description": "string"
}
],
"maritalStatus": [
{
"id": "string",
"description": "string"
}
],
"language": [
{
"id": "string",
"description": "string"
}
],
"title": [
{
"id": "string",
"description": "string"
}
],
"partyIdentifierStatus": [
{
"id": "string",
"description": "string"
}
],
"lifeCycleStatusType": [
{
"id": "string",
"description": "string"
}
],
"contactPointType": [
{
"id": "string",
"description": "string"
}
],
"reliabilityType": [
{
"id": "string",
"description": "string"
}
],
"electronicAddressType": [
{
"id": "string",
"description": "string"
}
],
"electronicCommunicationType": [
{
"id": "string",
"description": "string"
}
],
"phoneAddressType": [
{
"id": "string",
"description": "string"
}
],
"physicalAddressType": [
{
"id": "string",
"description": "string"
}
],
"addressUsePurpose": [
{
"id": "string",
"description": "string"
}
],
"assessmentNature": [
{
"id": "string",
"description": "string"
}
],
"assessmentLevel": [
{
"id": "string",
"description": "string"
}
],
"assessmentType": [
{
"id": "string",
"description": "string"
}
],
"residenceType": [
{
"id": "string",
"description": "string"
}
],
"residentialStatus": [
{
"id": "string",
"description": "string"
}
],
"occupationType": [
{
"id": "string",
"description": "string"
}
],
"jobTitle": [
{
"id": "string",
"description": "string"
}
],
"currency": [
{
"id": "string",
"description": "string"
}
],
"taxReasonType": [
{
"id": "string",
"description": "string"
}
],
"taxType": [
{
"id": "string",
"description": "string"
}
],
"taxEligibilityType": [
{
"id": "string",
"description": "string"
}
],
"vulnerabilityType": [
{
"id": "string",
"description": "string"
}
],
"riskIndicatorType": [
{
"id": "string",
"description": "string"
}
],
"partyRoleType": [
{
"id": "string",
"description": "string"
}
],
"legalIdentifierType": [
{
"id": "string",
"description": "string"
}
],
"isMainTaxResidency": [
{
"id": "string",
"description": "string"
}
],
"partyType": [
{
"id": "string",
"description": "string"
}
],
"positionType": [
{
"id": "string",
"description": "string"
}
],
"personPositionCategory": [
{
"id": "string",
"description": "string"
}
],
"partyStatus": [
{
"id": "string",
"description": "string"
}
],
"informationSource": [
{
"informationSourceScope": "News",
"informationSourceValue": "Industry Classification Updated"
}
],
"residenceRegion": [
{
"residenceCountry": "United States",
"residenceRegion": "California"
}
],
"country": [
{
"countryCode": "US",
"countryName": "United States",
"numericCountryCode": 1,
"alpha3CountryCode": "USA",
"highRiskCountry": true,
"iddPrefix": 1
}
],
"employmentType": [
{
"employmentStatusType": "Employed",
"employmentType": "Self-Employed",
"description": "This record is applicable for all type of self-employees"
}
],
"personPositionType": [
{
"type": "Politically Exposed",
"category": "PEP",
"description": ""
}
]
}Version 2.0
The key features of the V2.0.0 version APIs are as follows:
- In addition to the legal identifier, you can also save the alternate identifier to the PartyIdentifier functional group.
- A new reference ID type named identityType is added to the ReferenceTables functional group.
- As the mentioned functional groups have undergone various changes, the Party functional group is updated in accordance with the changes of the other functional groups.
The V2.0.0 version of Party microservice APIs contains four functional groups with their respective operations as follows.
| Functional Group | Description | Operations | ||||
|---|---|---|---|---|---|---|
| Party | Party is a group that the bank or the financial institution collects information for the business purpose. |
|
||||
| PartyIdentifier | The PartyIdentifier group identifies the legal identification documents that are associated with a party. |
|
||||
| TaxDetails | The TaxDetails group captures the taxation details of a party. |
|
||||
| ReferenceTables | The ReferenceTables group contains the static data for all the reference entities. | getReferenceDataForPartyV2 |
To view the Swagger Spec of the Party microservice APIs, click here.
The createPartyV2 API creates a new party record. This API is used to create party data such as party name, alternate identity, addresses, party identifier, and all the entities that are linked to the party
POST/party/parties
Sample Request
{
"dateOfBirth": "1990-09-09",
"dateOfDeath": "2045-09-09",
"notificationOfDeath": "2045-10-01",
"cityOfBirth": "Newyork",
"countryOfBirth": "US",
"gender": "Male",
"maritalStatus": "Married",
"nationalities": [
"US"
],
"defaultLanguage": "English",
"noOfDependents": 4,
"reasonForNoCitizenship": "Migration from another country",
"partyType": "Individual",
"partyStatus": "Prospect",
"title": "Mr",
"firstName": "Rolf",
"middleName": "J",
"lastName": "Gerling",
"nickName": "Rolf",
"suffix": "B.E.",
"alias": "Rolf",
"entityName": "Temenos Group",
"startDate": "2042-05-24",
"organisationLegalType": "",
"incorporationCountry": "US",
"dateOfIncorporation": "2019-09-09",
"nameOfIncorporationAuthority": "",
"legalForm": "",
"numberOfEmployees": 500,
"partyLanguages": [
"English"
],
"citizenships": [
"US"
],
"partyAssessments": [
{
"type": "Benchmark",
"status": "Pass",
"level": "Secured",
"score": "8",
"body": "CIBIL",
"conclusionDate": "2019-12-25",
"details": "",
"nature": "D",
"reason": "",
"nextAssessmentDate": "2019-12-25",
"expirydate": "2019-12-25",
"extensionData": {}
}
],
"partyIdentifiers": [
{
"type": "Passport",
"status": "New",
"issuingAuthority": "Ministry of Foreign Affairs",
"identifierNumber": "JI35VEGVS",
"issuedDate": "2017-10-24",
"expiryDate": "2020-10-24",
"issuingCountry": "US",
"holderName": "Mr. Rolf Gerling",
"isLegalIdentifier": true,
"partyType": "Individual",
"isExternal": true,
"extensionData": {}
}
],
"alternateIdentities": [
{
"identityType": "Other System Reference",
"identityNumber": "123-45-6789",
"identitySource": "CBS",
"extensionData": {}
}
],
"personPositions": [
{
"personPositionType": "Politically Exposed-PEP",
"countryOfPosition": "US",
"effectiveFromDate": "2019-05-05",
"effectiveToDate": "2024-05-05",
"expiryDate": "2024-05-05",
"comments": "",
"lastUpdated": "2019-05-05",
"informationSource": "News",
"extensionData": {}
}
],
"partyLifeCycles": [
{
"type": "Recognised",
"startDate": "2020-01-01",
"endDate": "2021-01-01",
"changeReason": "",
"extensionData": {}
}
],
"occupations": [
{
"occupationType": "Part time job",
"occupationDescription": "At McDonalds as Cashier",
"extensionData": {}
}
],
"employments": [
{
"type": "Salaried-Employee",
"country": "US",
"jobTitle": "Product Manager",
"employerName": "Temenos",
"startDate": "2019-02-09",
"endDate": "2029-02-09",
"employerSegment": "Services",
"employerOfficePhoneIdd": "1",
"employerOfficePhone": "8574963214",
"employerOfficeEmail": "rolf@temenos.com",
"salary": 1000,
"salaryInCurrency": "Dollar",
"salaryFrequency": "Monthly",
"extensionData": {}
}
],
"otherRiskIndicators": [
{
"type": "Adverse Media",
"doesRiskApply": true,
"explanationIfApplies": "",
"explanationIfDoesnotApply": "",
"extensionData": {}
}
],
"residences": [
{
"type": "Residence",
"country": "US",
"status": "Renter",
"region": "California",
"statusComments": "",
"extensionData": {}
}
],
"vulnerabilities": [
{
"vulnerabilityType": "Physical",
"vulnerabilityComments": "By Birth",
"extensionData": {}
}
],
"taxDetails": [
{
"taxType": "Income Tax",
"country": "US",
"taxId": "2324-09-242",
"eligibilityType": "Consumption Tax",
"eligibilityReason": "Citizen of country",
"taxStartDate": "2020-05-10",
"endDate": "2021-05-10",
"taxReasonType": "Citizen",
"taxReasonComment": "",
"taxIdLackReason": "",
"isMainTaxResidency": "Yes",
"extensionData": {}
}
],
"contactPoints": [
{
"contactPointType": "Electronic Address",
"startDate": "2020-01-01",
"endDate": "2025-01-01",
"electronicAddress": {
"electronicAddressType": "Email",
"electronicAddress": "rolf@gmail.com",
"electronicCommunicationType": "Primary"
},
"phoneAddress": {
"phoneAddressType": "Home Number",
"internationalPhoneNumber": "+914155552671",
"iddPrefixPhone": "1",
"nationalPhoneNumber": "4155552671"
},
"extensionData": {}
}
],
"contactAddresses": [
{
"physicalAddressType": "Home",
"startDate": "2020-01-01",
"reliabilityType": "Confirmed",
"contactName": "Rolf",
"endDate": "2022-01-01",
"countryCode": "US",
"flatNumber": "151",
"floor": "2",
"buildingNumber": "3",
"buildingName": "Copenagen Flats",
"streetName": "Grand Avenue",
"town": "San leandro",
"countrySubdivision": "California",
"postalOrZipCode": "510-286-4444",
"validatedBy": "Smarty Streets",
"postBoxNumber": "A3700",
"usePurpose": "Home Address",
"regionCode": "015",
"district": "Oakland",
"department": "",
"subDepartment": "",
"landmark": "San leandro community center",
"extensionData": {}
}
],
"extensionData": {}
}Sample Response
{
"id": "200722894",
"status": "Success",
"message": "string"
}The udpatePartyV2 API updates or changes the existing records of a party.
PUT/party/parties/{partyId}
Sample Request
{
"dateOfBirth": "1990-09-09",
"dateOfDeath": "2045-09-09",
"notificationOfDeath": "2045-10-01",
"cityOfBirth": "Newyork",
"countryOfBirth": "US",
"gender": "Male",
"maritalStatus": "Married",
"nationalities": [
"US"
],
"defaultLanguage": "English",
"noOfDependents": 4,
"reasonForNoCitizenship": "Migration from another country",
"partyType": "Individual",
"partyStatus": "Prospect",
"title": "Mr",
"firstName": "Rolf",
"middleName": "J",
"lastName": "Gerling",
"nickName": "Rolf",
"suffix": "B.E.",
"alias": "Rolf",
"entityName": "Temenos Group",
"startDate": "2042-05-24",
"organisationLegalType": "",
"incorporationCountry": "US",
"dateOfIncorporation": "2019-09-09",
"nameOfIncorporationAuthority": "",
"legalForm": "",
"numberOfEmployees": 500,
"partyLanguages": [
"English"
],
"citizenships": [
"US"
],
"partyAssessments": [
{
"type": "Benchmark",
"status": "Pass",
"level": "Secured",
"score": "8",
"body": "CIBIL",
"conclusionDate": "2019-12-25",
"details": "",
"nature": "D",
"reason": "",
"nextAssessmentDate": "2019-12-25",
"expirydate": "2019-12-25",
"extensionData": {}
}
],
"partyIdentifiers": [
{
"type": "Passport",
"status": "New",
"issuingAuthority": "Ministry of Foreign Affairs",
"identifierNumber": "JI35VEGVS",
"issuedDate": "2017-10-24",
"expiryDate": "2020-10-24",
"issuingCountry": "US",
"holderName": "Mr. Rolf Gerling",
"isLegalIdentifier": true,
"partyType": "Individual",
"isExternal": true,
"extensionData": {}
}
],
"alternateIdentities": [
{
"identityType": "Other System Reference",
"identityNumber": "123-45-6789",
"identitySource": "CBS",
"extensionData": {}
}
],
"personPositions": [
{
"personPositionType": "Politically Exposed-PEP",
"countryOfPosition": "US",
"effectiveFromDate": "2019-05-05",
"effectiveToDate": "2024-05-05",
"expiryDate": "2024-05-05",
"comments": "",
"lastUpdated": "2019-05-05",
"informationSource": "News",
"extensionData": {}
}
],
"partyLifeCycles": [
{
"type": "Recognised",
"startDate": "2020-01-01",
"endDate": "2021-01-01",
"changeReason": "",
"extensionData": {}
}
],
"occupations": [
{
"occupationType": "Part time job",
"occupationDescription": "At McDonalds as Cashier",
"extensionData": {}
}
],
"employments": [
{
"employmentReference": "EM20200J33YH",
"type": "Salaried-Employee",
"country": "US",
"jobTitle": "Product Manager",
"employerName": "Temenos",
"startDate": "2019-02-09",
"endDate": "2029-02-09",
"employerSegment": "Services",
"employerOfficePhoneIdd": "1",
"employerOfficePhone": "8574963214",
"employerOfficeEmail": "rolf@temenos.com",
"salary": 1000,
"salaryInCurrency": "Dollar",
"salaryFrequency": "Monthly",
"extensionData": {}
}
],
"otherRiskIndicators": [
{
"type": "Adverse Media",
"doesRiskApply": true,
"explanationIfApplies": "",
"explanationIfDoesnotApply": "",
"extensionData": {}
}
],
"residences": [
{
"type": "Residence",
"country": "US",
"status": "Renter",
"region": "California",
"statusComments": "",
"extensionData": {}
}
],
"vulnerabilities": [
{
"vulnerabilityType": "Physical",
"vulnerabilityComments": "By Birth",
"extensionData": {}
}
],
"taxDetails": [
{
"taxReference": "TAX23101598",
"taxType": "Income Tax",
"country": "US",
"taxId": "2324-09-242",
"eligibilityType": "Consumption Tax",
"eligibilityReason": "Citizen of country",
"taxStartDate": "2020-05-10",
"endDate": "2021-05-10",
"taxReasonType": "Citizen",
"taxReasonComment": "",
"taxIdLackReason": "",
"isMainTaxResidency": "Yes",
"extensionData": {}
}
],
"contactPoints": [
{
"contactPointType": "Electronic Address",
"startDate": "2020-01-01",
"endDate": "2025-01-01",
"electronicAddress": {
"electronicAddressType": "Email",
"electronicAddress": "rolf@gmail.com",
"electronicCommunicationType": "Primary"
},
"phoneAddress": {
"phoneAddressType": "Home Number",
"internationalPhoneNumber": "+914155552671",
"iddPrefixPhone": "1",
"nationalPhoneNumber": "4155552671"
},
"extensionData": {}
}
],
"contactAddresses": [
{
"physicalAddressType": "Home",
"startDate": "2020-01-01",
"reliabilityType": "Confirmed",
"contactName": "Rolf",
"endDate": "2022-01-01",
"countryCode": "US",
"flatNumber": "151",
"floor": "2",
"buildingNumber": "3",
"buildingName": "Copenagen Flats",
"streetName": "Grand Avenue",
"town": "San leandro",
"countrySubdivision": "California",
"postalOrZipCode": "510-286-4444",
"validatedBy": "Smarty Streets",
"postBoxNumber": "A3700",
"usePurpose": "Home Address",
"regionCode": "015",
"district": "Oakland",
"department": "",
"subDepartment": "",
"landmark": "San leandro community center",
"extensionData": {}
}
],
"extensionData": {}
}Sample Response
{
"id": "200722894",
"status": "Success",
"message": "string"
}The getPartyV2 API retrieves the details of a party.
GET/party/parties/{partyId}
Sample Response
{
"partyId": "200722894",
"dateOfBirth": "1990-09-09",
"dateOfDeath": "2045-09-09",
"notificationOfDeath": "2045-10-01",
"cityOfBirth": "Newyork",
"countryOfBirth": "US",
"gender": "Male",
"maritalStatus": "Married",
"nationalities": [
"US"
],
"defaultLanguage": "English",
"noOfDependents": 4,
"reasonForNoCitizenship": "Migration from another country",
"partyType": "Individual",
"partyStatus": "Prospect",
"title": "Mr",
"firstName": "Rolf",
"middleName": "J",
"lastName": "Gerling",
"nickName": "Rolf",
"suffix": "B.E.",
"alias": "Rolf",
"entityName": "Temenos Group",
"startDate": "2012-05-24",
"organisationLegalType": "",
"incorporationCountry": "US",
"dateOfIncorporation": "2012-05-24",
"nameOfIncorporationAuthority": "",
"legalForm": "",
"numberOfEmployees": 500,
"partyLanguages": [
"English"
],
"citizenships": [
"US"
],
"partyNames": [
{
"partyId": "200722894",
"title": "Mr",
"firstName": "Rolf",
"middleName": "J",
"lastName": "Gerling",
"nickName": "Rolf",
"suffix": "B.E.",
"alias": "Rolf",
"entityName": "Temenos Group",
"startDate": "2012-05-24",
"endDate": "2024-10-20",
"extensionData": {}
}
],
"partyAssessments": [
{
"partyId": "200722894",
"type": "Benchmark",
"status": "Pass",
"level": "Secured",
"score": "8",
"body": "CIBIL",
"conclusionDate": "2019-12-25",
"details": "",
"nature": "D",
"reason": "",
"nextAssessmentDate": "2019-12-25",
"expirydate": "2019-12-25",
"extensionData": {}
}
],
"partyIdentifiers": [
{
"partyId": "200722894",
"type": "Passport",
"status": "New",
"issuingAuthority": "Ministry of Foreign Affairs",
"identifierNumber": "JI35VEGVS",
"issuedDate": "2017-10-24",
"expiryDate": "2020-10-24",
"issuingCountry": "US",
"holderName": "Mr. Rolf Gerling",
"isLegalIdentifier": true,
"partyType": "Individual",
"isExternal": true,
"extensionData": {}
}
],
"alternateIdentities": [
{
"partyId": "200722894",
"identityType": "Other System Reference",
"identityNumber": "123-45-6789",
"identitySource": "CBS",
"extensionData": {}
}
],
"personPositions": [
{
"partyId": "200722894",
"personPositionType": "Politically Exposed-PEP",
"countryOfPosition": "US",
"effectiveFromDate": "2019-05-05",
"effectiveToDate": "2024-05-05",
"expiryDate": "2024-05-05",
"comments": "",
"lastUpdated": "2019-05-05",
"informationSource": "News",
"extensionData": {}
}
],
"partyLifeCycles": [
{
"partyId": "200722894",
"type": "Recognised",
"startDate": "2020-01-01",
"endDate": "2021-01-01",
"changeReason": "",
"extensionData": {}
}
],
"occupations": [
{
"partyId": "200722894",
"occupationType": "Part time job",
"occupationDescription": "At McDonalds as Cashier",
"extensionData": {}
}
],
"employments": [
{
"partyId": "200722894",
"employmentReference": "EM20200J33YH",
"type": "Salaried-Employee",
"country": "US",
"jobTitle": "Product Manager",
"employerName": "Temenos",
"startDate": "2019-02-09",
"endDate": "2029-02-09",
"employerSegment": "Services",
"employerOfficePhoneIdd": "1",
"employerOfficePhone": "8574963214",
"employerOfficeEmail": "rolf@temenos.com",
"salary": 1000,
"salaryInCurrency": "Dollar",
"salaryFrequency": "Monthly",
"extensionData": {}
}
],
"otherRiskIndicators": [
{
"partyId": "200722894",
"type": "Adverse Media",
"doesRiskApply": true,
"explanationIfApplies": "",
"explanationIfDoesnotApply": "",
"extensionData": {}
}
],
"residences": [
{
"partyId": "200722894",
"type": "Residence",
"country": "US",
"status": "Renter",
"region": "California",
"statusComments": "",
"extensionData": {}
}
],
"vulnerabilities": [
{
"partyId": "200722894",
"vulnerabilityType": "Physical",
"vulnerabilityComments": "By Birth",
"extensionData": {}
}
],
"taxDetails": [
{
"partyId": "200722894",
"taxReference": "TAX23101598",
"taxType": "Income Tax",
"country": "US",
"taxId": "2324-09-242",
"eligibilityType": "Consumption Tax",
"eligibilityReason": "Citizen of country",
"taxStartDate": "2020-05-10",
"endDate": "2021-05-10",
"taxReasonType": "Citizen",
"taxReasonComment": "",
"taxIdLackReason": "",
"isMainTaxResidency": "Yes",
"extensionData": {}
}
],
"contactPoints": [
{
"partyId": "200722894",
"contactPointType": "Electronic Address",
"startDate": "2020-01-01",
"endDate": "2025-01-01",
"electronicAddress": {
"electronicAddressType": "Email",
"electronicAddress": "rolf@gmail.com",
"electronicCommunicationType": "Primary"
},
"phoneAddress": {
"phoneAddressType": "Home Number",
"internationalPhoneNumber": "+914155552671",
"iddPrefixPhone": "1",
"nationalPhoneNumber": "4155552671"
},
"extensionData": {}
}
],
"contactAddresses": [
{
"partyId": "200722894",
"physicalAddressType": "Home",
"startDate": "2020-01-01",
"reliabilityType": "Confirmed",
"contactName": "Rolf",
"endDate": "2022-01-01",
"countryCode": "US",
"flatNumber": "151",
"floor": "2",
"buildingNumber": "3",
"buildingName": "Copenagen Flats",
"streetName": "Grand Avenue",
"town": "San leandro",
"countrySubdivision": "California",
"postalOrZipCode": "510-286-4444",
"validatedBy": "Smarty Streets",
"postBoxNumber": "A3700",
"usePurpose": "Home Address",
"regionCode": "015",
"district": "Oakland",
"department": "",
"subDepartment": "",
"landmark": "San leandro community center",
"extensionData": {}
}
],
"extensionData": {}
}The getPartyBasedOnCriteriaV2 API retrieves a record of a party based on the selection criteria
GET/party/parties?identifierNumber={identifierNumber}&identifierType={identifierType}&lastName={lastName}&dateOfBirth={dateOfBirth}&emailId={emailId}
Sample Response
{
"parties": [
{
"partyId": "200722894",
"dateOfBirth": "1990-09-09",
"dateOfDeath": "2045-09-09",
"notificationOfDeath": "2045-10-01",
"cityOfBirth": "Newyork",
"countryOfBirth": "US",
"gender": "Male",
"maritalStatus": "Married",
"nationalities": [
"US"
],
"defaultLanguage": "English",
"noOfDependents": 4,
"reasonForNoCitizenship": "Migration from another country",
"partyType": "Individual",
"partyStatus": "Prospect",
"title": "Mr",
"firstName": "Rolf",
"middleName": "J",
"lastName": "Gerling",
"nickName": "Rolf",
"suffix": "B.E.",
"alias": "Rolf",
"entityName": "Temenos Group",
"startDate": "2012-05-24",
"organisationLegalType": "",
"incorporationCountry": "US",
"dateOfIncorporation": "2012-05-24",
"nameOfIncorporationAuthority": "",
"legalForm": "",
"numberOfEmployees": 500,
"partyLanguages": [
"English"
],
"citizenships": [
"US"
],
"partyNames": [
{
"partyId": "200722894",
"title": "Mr",
"firstName": "Rolf",
"middleName": "J",
"lastName": "Gerling",
"nickName": "Rolf",
"suffix": "B.E.",
"alias": "Rolf",
"entityName": "Temenos Group",
"startDate": "2012-05-24",
"endDate": "2024-10-20",
"extensionData": {}
}
],
"partyAssessments": [
{
"partyId": "200722894",
"type": "Benchmark",
"status": "Pass",
"level": "Secured",
"score": "8",
"body": "CIBIL",
"conclusionDate": "2019-12-25",
"details": "",
"nature": "D",
"reason": "",
"nextAssessmentDate": "2019-12-25",
"expirydate": "2019-12-25",
"extensionData": {}
}
],
"partyIdentifiers": [
{
"partyId": "200722894",
"type": "Passport",
"status": "New",
"issuingAuthority": "Ministry of Foreign Affairs",
"identifierNumber": "JI35VEGVS",
"issuedDate": "2017-10-24",
"expiryDate": "2020-10-24",
"issuingCountry": "US",
"holderName": "Mr. Rolf Gerling",
"isLegalIdentifier": true,
"partyType": "Individual",
"isExternal": true,
"extensionData": {}
}
],
"alternateIdentities": [
{
"partyId": "200722894",
"identityType": "Other System Reference",
"identityNumber": "123-45-6789",
"identitySource": "CBS",
"extensionData": {}
}
],
"personPositions": [
{
"partyId": "200722894",
"personPositionType": "Politically Exposed-PEP",
"countryOfPosition": "US",
"effectiveFromDate": "2019-05-05",
"effectiveToDate": "2024-05-05",
"expiryDate": "2024-05-05",
"comments": "",
"lastUpdated": "2019-05-05",
"informationSource": "News",
"extensionData": {}
}
],
"partyLifeCycles": [
{
"partyId": "200722894",
"type": "Recognised",
"startDate": "2020-01-01",
"endDate": "2021-01-01",
"changeReason": "",
"extensionData": {}
}
],
"occupations": [
{
"partyId": "200722894",
"occupationType": "Part time job",
"occupationDescription": "At McDonalds as Cashier",
"extensionData": {}
}
],
"employments": [
{
"partyId": "200722894",
"employmentReference": "EM20200J33YH",
"type": "Salaried-Employee",
"country": "US",
"jobTitle": "Product Manager",
"employerName": "Temenos",
"startDate": "2019-02-09",
"endDate": "2029-02-09",
"employerSegment": "Services",
"employerOfficePhoneIdd": "1",
"employerOfficePhone": "8574963214",
"employerOfficeEmail": "rolf@temenos.com",
"salary": 1000,
"salaryInCurrency": "Dollar",
"salaryFrequency": "Monthly",
"extensionData": {}
}
],
"otherRiskIndicators": [
{
"partyId": "200722894",
"type": "Adverse Media",
"doesRiskApply": true,
"explanationIfApplies": "",
"explanationIfDoesnotApply": "",
"extensionData": {}
}
],
"residences": [
{
"partyId": "200722894",
"type": "Residence",
"country": "US",
"status": "Renter",
"region": "California",
"statusComments": "",
"extensionData": {}
}
],
"vulnerabilities": [
{
"partyId": "200722894",
"vulnerabilityType": "Physical",
"vulnerabilityComments": "By Birth",
"extensionData": {}
}
],
"taxDetails": [
{
"partyId": "200722894",
"taxReference": "TAX23101598",
"taxType": "Income Tax",
"country": "US",
"taxId": "2324-09-242",
"eligibilityType": "Consumption Tax",
"eligibilityReason": "Citizen of country",
"taxStartDate": "2020-05-10",
"endDate": "2021-05-10",
"taxReasonType": "Citizen",
"taxReasonComment": "",
"taxIdLackReason": "",
"isMainTaxResidency": "Yes",
"extensionData": {}
}
],
"contactPoints": [
{
"partyId": "200722894",
"contactPointType": "Electronic Address",
"startDate": "2020-01-01",
"endDate": "2025-01-01",
"electronicAddress": {
"electronicAddressType": "Email",
"electronicAddress": "rolf@gmail.com",
"electronicCommunicationType": "Primary"
},
"phoneAddress": {
"phoneAddressType": "Home Number",
"internationalPhoneNumber": "+914155552671",
"iddPrefixPhone": "1",
"nationalPhoneNumber": "4155552671"
},
"extensionData": {}
}
],
"contactAddresses": [
{
"partyId": "200722894",
"physicalAddressType": "Home",
"startDate": "2020-01-01",
"reliabilityType": "Confirmed",
"contactName": "Rolf",
"endDate": "2022-01-01",
"countryCode": "US",
"flatNumber": "151",
"floor": "2",
"buildingNumber": "3",
"buildingName": "Copenagen Flats",
"streetName": "Grand Avenue",
"town": "San leandro",
"countrySubdivision": "California",
"postalOrZipCode": "510-286-4444",
"validatedBy": "Smarty Streets",
"postBoxNumber": "A3700",
"usePurpose": "Home Address",
"regionCode": "015",
"district": "Oakland",
"department": "",
"subDepartment": "",
"landmark": "San leandro community center",
"extensionData": {}
}
],
"extensionData": {}
}
]
}The createPartyIdentifierV2 API creates a new identifier record for a party. Party identifiers can be created only for the existing parties.
POST/party/parties/{partyId}/partyIdentifiers
Sample Request
{
"partyIdentifiers": [
{
"type": "Passport",
"status": "New",
"issuingAuthority": "Ministry of Foreign Affairs",
"identifierNumber": "JI35VEGVS",
"issuedDate": "2017-10-24",
"expiryDate": "2020-10-24",
"issuingCountry": "US",
"holderName": "Mr. Rolf Gerling",
"isLegalIdentifier": true,
"partyType": "Individual",
"isExternal": true
}
],
"alternateIdentities": [
{
"identityType": "Other System Reference",
"identityNumber": "123-45-6789",
"identitySource": ""
}
]
}Sample Response
{
"id": "200722894",
"status": "Success",
"message": "string"
}The updatePartyIdentifierV2 API updates or changes the existing identifier record of a party.
PUT/party/parties/{partyId}/partyIdentifiers
Sample Request
{
"partyIdentifiers": [
{
"type": "Passport",
"status": "New",
"issuingAuthority": "Ministry of Foreign Affairs",
"identifierNumber": "JI35VEGVS",
"issuedDate": "2017-10-24",
"expiryDate": "2020-10-24",
"issuingCountry": "US",
"holderName": "Mr. Rolf Gerling",
"isLegalIdentifier": true,
"partyType": "Individual",
"isExternal": true
}
],
"alternateIdentities": [
{
"identityType": "Other System Reference",
"identityNumber": "123-45-6789",
"identitySource": ""
}
]
}Sample Response
{
"id": "200722894",
"status": "Success",
"message": "string"
}The getPartyIdentifierV2 API retrieve the identifier records for a party.
GET/party/parties/{partyId}/partyIdentifiers
Sample Response
{
"partyIdentifiers": [
{
"partyId": "200722894",
"type": "Passport",
"status": "New",
"issuingAuthority": "Ministry of Foreign Affairs",
"identifierNumber": "JI35VEGVS",
"issuedDate": "2017-10-24",
"expiryDate": "2020-10-24",
"issuingCountry": "US",
"holderName": "Mr. Rolf Gerling",
"isLegalIdentifier": true,
"partyType": "Individual",
"isExternal": true
}
],
"alternateIdentities": [
{
"partyId": "200722894",
"identityType": "Other System Reference",
"identityNumber": "123-45-6789",
"identitySource": ""
}
]
}The createTaxDetailsV2 API creates a new tax details record for a party. Tax details can be created only for the existing parties.
POST/party/parties/{partyId}/taxDetails
Sample Request
{
"taxDetails": [
{
"taxType": "Income Tax",
"country": "US",
"taxId": "2324-09-242",
"eligibilityType": "Consumption Tax",
"eligibilityReason": "Citizen of country",
"taxStartDate": "2020-05-10",
"endDate": "2021-05-10",
"taxReasonType": "Citizen",
"taxReasonComment": "",
"taxIdLackReason": "",
"isMainTaxResidency": "Yes",
"extensionData": {}
}
]
}Sample Response
{
"id": "200722894",
"status": "Success",
"message": "string"
}The updateTaxDetailsV2 API updates or changes the existing tax details record for a party.
PUT/party/parties/{partyId}/taxDetails
Sample Request
{
"taxDetails": [
{
"taxReference": "TAX23101598",
"taxType": "Income Tax",
"country": "US",
"taxId": "2324-09-242",
"eligibilityType": "Consumption Tax",
"eligibilityReason": "Citizen of country",
"taxStartDate": "2020-05-10",
"endDate": "2021-05-10",
"taxReasonType": "Citizen",
"taxReasonComment": "",
"taxIdLackReason": "",
"isMainTaxResidency": "Yes",
"extensionData": {}
}
]
}Sample Response
{
"id": "200722894",
"status": "Success",
"message": "string"
}The getTaxDetailsV2 API retrieves the tax details records of a party.
GET/party/parties/{partyId}/taxDetails
Sample Response
{
"taxDetails": [
{
"partyId": "200722894",
"taxReference": "TAX23101598",
"taxType": "Income Tax",
"country": "US",
"taxId": "2324-09-242",
"eligibilityType": "Consumption Tax",
"eligibilityReason": "Citizen of country",
"taxStartDate": "2020-05-10",
"endDate": "2021-05-10",
"taxReasonType": "Citizen",
"taxReasonComment": "",
"taxIdLackReason": "",
"isMainTaxResidency": "Yes",
"extensionData": {}
}
]
}The getReferenceDataForPartyV2 API retrieves reference data based on the reference ID.
GET/reference/{referenceId}
Sample Response
{
"gender": [
{
"id": "string",
"description": "string"
}
],
"maritalStatus": [
{
"id": "string",
"description": "string"
}
],
"language": [
{
"id": "string",
"description": "string"
}
],
"title": [
{
"id": "string",
"description": "string"
}
],
"partyIdentifierStatus": [
{
"id": "string",
"description": "string"
}
],
"lifeCycleStatusType": [
{
"id": "string",
"description": "string"
}
],
"contactPointType": [
{
"id": "string",
"description": "string"
}
],
"reliabilityType": [
{
"id": "string",
"description": "string"
}
],
"electronicAddressType": [
{
"id": "string",
"description": "string"
}
],
"electronicCommunicationType": [
{
"id": "string",
"description": "string"
}
],
"phoneAddressType": [
{
"id": "string",
"description": "string"
}
],
"physicalAddressType": [
{
"id": "string",
"description": "string"
}
],
"addressUsePurpose": [
{
"id": "string",
"description": "string"
}
],
"assessmentNature": [
{
"id": "string",
"description": "string"
}
],
"assessmentLevel": [
{
"id": "string",
"description": "string"
}
],
"assessmentType": [
{
"id": "string",
"description": "string"
}
],
"residenceType": [
{
"id": "string",
"description": "string"
}
],
"residentialStatus": [
{
"id": "string",
"description": "string"
}
],
"occupationType": [
{
"id": "string",
"description": "string"
}
],
"identityType": [
{
"id": "string",
"description": "string"
}
],
"jobTitle": [
{
"id": "string",
"description": "string"
}
],
"currency": [
{
"id": "string",
"description": "string"
}
],
"taxReasonType": [
{
"id": "string",
"description": "string"
}
],
"taxType": [
{
"id": "string",
"description": "string"
}
],
"taxEligibilityType": [
{
"id": "string",
"description": "string"
}
],
"vulnerabilityType": [
{
"id": "string",
"description": "string"
}
],
"riskIndicatorType": [
{
"id": "string",
"description": "string"
}
],
"legalIdentifierType": [
{
"id": "string",
"description": "string"
}
],
"partyType": [
{
"id": "string",
"description": "string"
}
],
"positionType": [
{
"id": "string",
"description": "string"
}
],
"personPositionCategory": [
{
"id": "string",
"description": "string"
}
],
"partyStatus": [
{
"id": "string",
"description": "string"
}
],
"informationSource": [
{
"informationSourceScope": "News",
"informationSourceValue": "Industry Classification Updated"
}
],
"residenceRegion": [
{
"residenceCountry": "United States",
"residenceRegion": "California"
}
],
"country": [
{
"countryCode": "US",
"countryName": "United States",
"numericCountryCode": 1,
"alpha3CountryCode": "USA",
"highRiskCountry": false,
"iddPrefix": 1
}
],
"employmentType": [
{
"employmentStatusType": "Employed",
"employmentType": "Self-Employed",
"description": "This record is applicable for all type of self-employees"
}
],
"isMainTaxResidency": [
{
"id": "string",
"description": "string"
}
],
"personPositionType": [
{
"type": "Politically Exposed",
"category": "PEP",
"description": ""
}
]
}Version 3.0
The key features of the V3.0.0 version APIs are as follows:
-
The following functional groups are added:
- Observations
- Party Legal Status
- Roles
- Contact References
- Classifications
- Party Relations
- Code Hierarchies
- Relation Types
- Address
- The CRUD APIs are added to the reference entities.
- You can now capture the classifications of a party based on codes and various schemes.
- You can now capture contact information of a party depending on the communication type (Email, Phone, Address).
The V3.0.0 version of Party microservice APIs contains four functional groups with their respective operations as follows.
| Functional Group | Description | Operations | |||||
|---|---|---|---|---|---|---|---|
| Party | Party is a group that the bank or the financial institution collects information for the business purpose. |
|
|||||
| PartyIdentifier & AlternateIdentity | The PartyIdentifier group identifies the legal identification documents that are associated with a party. |
|
|||||
| TaxDetails | The TaxDetails group captures the taxation details of a party. |
|
|||||
| EmploymentDetails | The EmploymentDetails group captures the employment and occupation records of a party. |
|
|||||
| Observations | The Observations group captures information about the party that may require attention or restrict the management of the party. |
|
|||||
| Party Legal Status | The Party Legal Status group captures legal documents' information about the party that has direct impact on party by restricting/blocking. |
|
|||||
| Roles | The Roles group maintains multiple roles for party during different periods of time. |
|
|||||
| Addresses | The Address group captures the contact information of the party depending on the communication type (Email, Phone, Address) and address type (Personal Email, Mobile Phone, Office Address). |
|
|||||
| Contact References | The Contact References group maintains different end-points information through which a party can be contacted. |
|
|||||
| Classifications | The Classifications group captures the actual information about how a party is classified based on classification schemes and codes. |
|
|||||
| Party Relations |
The Party Relations group maintains the relationship between different parties. |
|
|||||
| Code Hierarchies | The Code Hierarchies group maintains the hierarchical relation information between party classification codes within the same or different classifications schemes. |
|
|||||
| Relation Types | The Relation Types group defines the relationship that can be used across parties. |
|
|||||
| Reference | The Reference group contains the static data for all the reference entities. |
|
To view the Swagger Spec of the Party microservice APIs, click here.
The createPartyV3 API creates a new party record. This API is used to create party data such as party name, alternate identity, addresses, party identifier, and all the entities that are linked to the party.
POST/party/parties
Sample Request
{
"dateOfBirth": "1990-09-09",
"dateOfDeath": "2045-09-09",
"notificationOfDeath": "2045-10-01",
"cityOfBirth": "Newyork",
"countryOfBirth": "US",
"gender": "Male",
"maritalStatus": "Married",
"defaultLanguage": "English",
"noOfDependents": 4,
"reasonForNoCitizenship": "Migration from another country",
"partyType": "Individual",
"partyStatus": "Prospect",
"title": "Mr",
"firstName": "Rolf",
"middleName": "J",
"lastName": "Gerling",
"nickName": "Rolf",
"suffix": "B.E.",
"alias": "Rolf",
"entityName": "Temenos Group",
"nameStartDate": "2042-05-24",
"organisationLegalType": "Legal",
"incorporationCountry": "US",
"dateOfIncorporation": "2019-09-09",
"nameOfIncorporationAuthority": "",
"legalForm": "Listed Company",
"numberOfEmployees": 500,
"nationalities": [
{
"country": "US"
}
],
"partyLanguages": [
{
"language": "English"
}
],
"citizenships": [
{
"countryOfCitizenship": "US",
"endDate": "2030-12-25"
}
],
"partyAssessments": [
{
"type": "Benchmark",
"status": "Pass",
"level": "Secured",
"score": "500-800",
"body": "CIBIL",
"conclusionDate": "2019-12-25",
"details": "Credit Score Fail",
"nature": "D",
"reason": "Apply for Mortgage",
"nextAssessmentDate": "2019-12-25",
"expirydate": "2019-12-25",
"extensionData": {}
}
],
"partyIdentifiers": [
{
"type": "Passport",
"status": "New",
"issuingAuthority": "Ministry of Foreign Affairs",
"identifierNumber": "JI35VEGVS",
"issuedDate": "2017-10-24",
"expiryDate": "2020-10-24",
"issuingCountry": "US",
"holderName": "Mr. Rolf Gerling",
"extensionData": {}
}
],
"alternateIdentities": [
{
"identityType": "Other System Reference",
"identityNumber": "123-45-6789",
"identitySource": "CBS",
"startDate": "2020-05-05",
"extensionData": {}
}
],
"personPositions": [
{
"personPositionType": "Politically Exposed-PEP",
"countryOfPosition": "US",
"effectiveFromDate": "2019-05-05",
"effectiveToDate": "2024-05-05",
"expiryDate": "2024-05-05",
"comments": "",
"lastUpdated": "2019-05-05",
"informationSource": "News",
"extensionData": {}
}
],
"partyLifeCycles": [
{
"type": "Recognised",
"startDate": "2020-01-01",
"endDate": "2021-01-01",
"changeReason": "",
"extensionData": {}
}
],
"occupations": [
{
"occupationType": "Part time job",
"occupationDescription": "At McDonalds as Cashier",
"extensionData": {}
}
],
"employments": [
{
"type": "Salaried-Employee",
"country": "US",
"jobTitle": "Product Manager",
"employerName": "Temenos",
"startDate": "2019-02-09",
"endDate": "2029-02-09",
"employerSegment": "Services",
"employerOfficePhoneIdd": "1",
"employerOfficePhone": "8574963214",
"employerOfficeEmail": "rolf@temenos.com",
"salary": 1000,
"salaryInCurrency": "Dollar",
"salaryFrequency": "Monthly",
"primaryEmployment": true,
"extensionData": {}
}
],
"otherRiskIndicators": [
{
"type": "Adverse Media",
"doesRiskApply": true,
"explanationIfApplies": "",
"explanationIfDoesnotApply": "",
"extensionData": {}
}
],
"residences": [
{
"type": "Residence",
"country": "US",
"status": "Renter",
"region": "California",
"statutoryRequirementMet": true,
"statusComments": "",
"endDate": "2021-05-10",
"extensionData": {}
}
],
"vulnerabilities": [
{
"vulnerabilityType": "Physical",
"vulnerabilityComments": "By Birth",
"extensionData": {}
}
],
"taxDetails": [
{
"taxType": "Income Tax",
"country": "US",
"taxId": "2324-09-242",
"eligibilityType": "Consumption Tax",
"eligibilityReason": "Citizen of country",
"taxStartDate": "2020-05-10",
"endDate": "2021-05-10",
"taxReasonType": "Citizen",
"taxReasonComment": "",
"taxIdLackReason": "",
"isMainTaxResidency": "Yes",
"extensionData": {}
}
],
"otherNames": [
{
"nameType": "LegalName",
"fromDate": "2020-09-20",
"name": "John",
"nameLanguage": "English",
"toDate": "2024-10-20",
"extensionData": {}
}
],
"observations": [
{
"type": "Under Recovery",
"observationDate": "2020-01-01",
"detail": "Party needs to be checked for missing documents",
"reason": "Missing Identification documents",
"source": "Bank User",
"extensionData": {}
}
],
"partyLegalStatus": [
{
"type": "Liquidation",
"country": "US",
"effectiveFrom": "2020-01-01",
"effectiveTo": "2030-01-01",
"changeReason": "Dissolution of the company",
"extensionData": {}
}
],
"roles": [
{
"roleType": "Person Customer",
"fromDate": "2020-01-01",
"status": "Deactivated",
"exitDate": "2030-01-01",
"exitReason": "Decides to leave the bank as he wants to transfer his loan to another bank for a better loan interest",
"decisionBody": "Credit Officer",
"comments": "",
"customerships": [
{
"companyLegalUnit": "Temenos Bank",
"status": "Active",
"responsibleUnits": [
{
"responsibleUnitType": "Local Responsible Unit",
"businessUnit": "Credit Officer.1",
"relationshipOfficer": "Denmark Branch 01",
"startDate": "2020-01-01",
"endDate": "2030-01-01",
"extensionData": {}
}
],
"extensionData": {}
}
],
"extensionData": {}
}
],
"addresses": [
{
"communicationNature": "Physical",
"communicationType": "Residence",
"addressType": "Primary",
"electronicAddress": "rolf@gmail.com",
"iddPrefixPhone": "1",
"phoneNo": "7534550012",
"countryCode": "US",
"flatNumber": "151",
"floor": "2",
"buildingNumber": "3",
"buildingName": "Copenagen Flats",
"streetName": "Grand Avenue",
"town": "San leandro",
"countrySubdivision": "California",
"postalOrZipCode": "510-286-4444",
"validatedBy": "Smarty Streets",
"postBoxNumber": "A3700",
"usePurpose": "Home Address",
"regionCode": "015",
"district": "Oakland",
"department": "Sales",
"subDepartment": "Sales Support",
"landmark": "San leandro community center",
"website": "temenos.com",
"extensionData": {}
}
],
"classifications": [
{
"classificationCode": "NACE.Rev.2-12000",
"classificationDate": "2018-09-09",
"reason": "Industry classification updated ",
"source": "Documentation",
"endDate": "2021-01-01",
"extensionData": {}
}
],
"extensionData": {}
}Sample Response
{
"id": "200722894",
"status": "Success",
"message": "Completed Successfully"
}The updatePartyV3 API amends the existing party records.
PUT/party/parties/{partyId}
Sample Request
{
"dateOfBirth": "1990-09-09",
"dateOfDeath": "2045-09-09",
"notificationOfDeath": "2045-10-01",
"cityOfBirth": "Newyork",
"countryOfBirth": "US",
"gender": "Male",
"maritalStatus": "Married",
"defaultLanguage": "English",
"noOfDependents": 4,
"reasonForNoCitizenship": "Migration from another country",
"partyType": "Individual",
"partyStatus": "Prospect",
"title": "Mr",
"firstName": "Rolf",
"middleName": "J",
"lastName": "Gerling",
"nickName": "Rolf",
"suffix": "B.E.",
"alias": "Rolf",
"entityName": "Temenos Group",
"nameStartDate": "2042-05-24",
"organisationLegalType": "Legal",
"incorporationCountry": "US",
"dateOfIncorporation": "2019-09-09",
"nameOfIncorporationAuthority": "",
"legalForm": "Listed Company",
"numberOfEmployees": 500,
"nationalities": [
{
"country": "US"
}
],
"partyLanguages": [
{
"language": "English"
}
],
"citizenships": [
{
"countryOfCitizenship": "US",
"endDate": "2030-12-25"
}
],
"partyAssessments": [
{
"type": "Benchmark",
"status": "Pass",
"level": "Secured",
"score": "500-800",
"body": "CIBIL",
"conclusionDate": "2019-12-25",
"details": "Credit Score Fail",
"nature": "D",
"reason": "Apply for Mortgage",
"nextAssessmentDate": "2019-12-25",
"expirydate": "2019-12-25",
"extensionData": {}
}
],
"partyIdentifiers": [
{
"type": "Passport",
"status": "New",
"issuingAuthority": "Ministry of Foreign Affairs",
"identifierNumber": "JI35VEGVS",
"issuedDate": "2017-10-24",
"expiryDate": "2020-10-24",
"issuingCountry": "US",
"holderName": "Mr. Rolf Gerling",
"extensionData": {}
}
],
"alternateIdentities": [
{
"identityType": "Other System Reference",
"identityNumber": "123-45-6789",
"identitySource": "CBS",
"startDate": "2020-05-05",
"extensionData": {}
}
],
"personPositions": [
{
"personPositionType": "Politically Exposed-PEP",
"countryOfPosition": "US",
"effectiveFromDate": "2019-05-05",
"effectiveToDate": "2024-05-05",
"expiryDate": "2024-05-05",
"comments": "",
"lastUpdated": "2019-05-05",
"informationSource": "News",
"extensionData": {}
}
],
"partyLifeCycles": [
{
"type": "Recognised",
"startDate": "2020-01-01",
"endDate": "2021-01-01",
"changeReason": "",
"extensionData": {}
}
],
"occupations": [
{
"occupationType": "Part time job",
"occupationDescription": "At McDonalds as Cashier",
"extensionData": {}
}
],
"employments": [
{
"employmentReference": "EM20200J33YH",
"type": "Salaried-Employee",
"country": "US",
"jobTitle": "Product Manager",
"employerName": "Temenos",
"startDate": "2019-02-09",
"endDate": "2029-02-09",
"employerSegment": "Services",
"employerOfficePhoneIdd": "1",
"employerOfficePhone": "8574963214",
"employerOfficeEmail": "rolf@temenos.com",
"salary": 1000,
"salaryInCurrency": "Dollar",
"salaryFrequency": "Monthly",
"primaryEmployment": true,
"extensionData": {}
}
],
"otherRiskIndicators": [
{
"type": "Adverse Media",
"doesRiskApply": true,
"explanationIfApplies": "",
"explanationIfDoesnotApply": "",
"extensionData": {}
}
],
"residences": [
{
"type": "Residence",
"country": "US",
"status": "Renter",
"region": "California",
"statutoryRequirementMet": true,
"statusComments": "",
"endDate": "2021-05-10",
"extensionData": {}
}
],
"vulnerabilities": [
{
"vulnerabilityType": "Physical",
"vulnerabilityComments": "By Birth",
"extensionData": {}
}
],
"taxDetails": [
{
"taxReference": "TAX20200J33Y",
"taxType": "Income Tax",
"country": "US",
"taxId": "2324-09-242",
"eligibilityType": "Consumption Tax",
"eligibilityReason": "Citizen of country",
"taxStartDate": "2020-05-10",
"endDate": "2021-05-10",
"taxReasonType": "Citizen",
"taxReasonComment": "",
"taxIdLackReason": "",
"isMainTaxResidency": "Yes",
"extensionData": {}
}
],
"otherNames": [
{
"nameType": "LegalName",
"fromDate": "2020-09-20",
"name": "John",
"nameLanguage": "English",
"toDate": "2024-10-20",
"extensionData": {}
}
],
"observations": [
{
"observationReference": "OB20200J33YH",
"type": "Under Recovery",
"observationDate": "2020-01-01",
"detail": "Party needs to be checked for missing documents",
"reason": "Missing Identification documents",
"source": "Bank User",
"extensionData": {}
}
],
"partyLegalStatus": [
{
"type": "Liquidation",
"country": "US",
"effectiveFrom": "2020-01-01",
"effectiveTo": "2030-01-01",
"changeReason": "Dissolution of the company",
"extensionData": {}
}
],
"roles": [
{
"roleType": "Person Customer",
"fromDate": "2020-01-01",
"status": "Deactivated",
"exitDate": "2030-01-01",
"exitReason": "Decides to leave the bank as he wants to transfer his loan to another bank for a better loan interest",
"decisionBody": "Credit Officer",
"comments": "",
"customerships": [
{
"companyLegalUnit": "Temenos Bank",
"status": "Active",
"responsibleUnits": [
{
"responsibleUnitType": "Local Responsible Unit",
"businessUnit": "Credit Officer.1",
"relationshipOfficer": "Denmark Branch 01",
"startDate": "2020-01-01",
"endDate": "2030-01-01",
"extensionData": {}
}
],
"extensionData": {}
}
],
"extensionData": {}
}
],
"addresses": [
{
"addressesReference": "AD20200J33YH",
"communicationType": "Residence",
"communicationNature": "Physical",
"addressType": "Primary",
"electronicAddress": "rolf@gmail.com",
"iddPrefixPhone": "1",
"phoneNo": "7534550012",
"countryCode": "US",
"flatNumber": "151",
"floor": "2",
"buildingNumber": "3",
"buildingName": "Copenagen Flats",
"streetName": "Grand Avenue",
"town": "San leandro",
"countrySubdivision": "California",
"postalOrZipCode": "510-286-4444",
"validatedBy": "Smarty Streets",
"postBoxNumber": "A3700",
"usePurpose": "Home Address",
"regionCode": "015",
"district": "Oakland",
"department": "Sales",
"subDepartment": "Sales Support",
"landmark": "San leandro community center",
"website": "temenos.com",
"extensionData": {}
}
],
"contactReferences": [
{
"contactReferences": "CR20200YOEHJ",
"reliabilityType": "Confirmed",
"contactAddressId": "AD20200J33YH",
"contactName": "John",
"startDate": "2020-01-01",
"endDate": "2025-01-01",
"extensionData": {}
}
],
"classifications": [
{
"classificationCode": "NACE.Rev.2-12000",
"classificationDate": "2018-09-09",
"reason": "Industry classification updated ",
"source": "Documentation",
"endDate": "2021-01-01",
"extensionData": {}
}
],
"extensionData": {}
} Sample Response
{
"id": "200722894",
"status": "Success",
"message": "Completed Successfully"
}The getPartyV3 API retrieves the details of a party.
GET/party/parties/{partyId}
Sample Response
{
"partyId": "200722894",
"dateOfBirth": "1990-09-09",
"dateOfDeath": "2045-09-09",
"notificationOfDeath": "2045-10-01",
"cityOfBirth": "Newyork",
"countryOfBirth": "US",
"gender": "Male",
"maritalStatus": "Married",
"defaultLanguage": "English",
"noOfDependents": 4,
"reasonForNoCitizenship": "Migration from another country",
"partyType": "Individual",
"partyStatus": "Prospect",
"title": "Mr",
"firstName": "Rolf",
"middleName": "J",
"lastName": "Gerling",
"nickName": "Rolf",
"suffix": "B.E.",
"alias": "Rolf",
"entityName": "Temenos Group",
"nameStartDate": "2012-05-24",
"organisationLegalType": "Legal",
"incorporationCountry": "US",
"dateOfIncorporation": "2019-09-09",
"nameOfIncorporationAuthority": "",
"legalForm": "Listed Company",
"numberOfEmployees": 500,
"nationalities": [
{
"partyId": "200722894",
"country": "US"
}
],
"partyLanguages": [
{
"partyId": "200722894",
"language": "English"
}
],
"citizenships": [
{
"partyId": "200722894",
"countryOfCitizenship": "US",
"endDate": "2030-12-25"
}
],
"partyNames": [
{
"partyId": "200722894",
"title": "Mr",
"firstName": "Rolf",
"middleName": "J",
"lastName": "Gerling",
"nickName": "Rolf",
"suffix": "B.E.",
"alias": "Rolf",
"entityName": "Temenos Group",
"startDate": "2012-05-24",
"endDate": "2024-10-20",
"extensionData": {}
}
],
"partyAssessments": [
{
"partyId": "200722894",
"type": "Benchmark",
"status": "Pass",
"level": "Secured",
"score": "500-800",
"body": "CIBIL",
"conclusionDate": "2019-12-25",
"details": "Credit Score Fail",
"nature": "D",
"reason": "Apply for Mortgage",
"nextAssessmentDate": "2019-12-25",
"expirydate": "2019-12-25",
"extensionData": {}
}
],
"partyIdentifiers": [
{
"partyId": "200722894",
"type": "Passport",
"status": "New",
"issuingAuthority": "Ministry of Foreign Affairs",
"identifierNumber": "JI35VEGVS",
"issuedDate": "2017-10-24",
"expiryDate": "2020-10-24",
"issuingCountry": "US",
"holderName": "Mr. Rolf Gerling",
"extensionData": {}
}
],
"alternateIdentities": [
{
"partyId": "200722894",
"identityType": "Other System Reference",
"identityNumber": "123-45-6789",
"identitySource": "CBS",
"startDate": "2020-05-05",
"extensionData": {}
}
],
"personPositions": [
{
"partyId": "200722894",
"personPositionType": "Politically Exposed-PEP",
"countryOfPosition": "US",
"effectiveFromDate": "2019-05-05",
"effectiveToDate": "2024-05-05",
"expiryDate": "2024-05-05",
"comments": "",
"lastUpdated": "2019-05-05",
"informationSource": "News",
"extensionData": {}
}
],
"partyLifeCycles": [
{
"partyId": "200722894",
"type": "Recognised",
"startDate": "2020-01-01",
"endDate": "2021-01-01",
"changeReason": "",
"extensionData": {}
}
],
"occupations": [
{
"partyId": "200722894",
"occupationType": "Part time job",
"occupationDescription": "At McDonalds as Cashier",
"extensionData": {}
}
],
"employments": [
{
"partyId": "200722894",
"employmentReference": "EM20200J33YH",
"type": "Salaried-Employee",
"country": "US",
"jobTitle": "Product Manager",
"employerName": "Temenos",
"startDate": "2019-02-09",
"endDate": "2029-02-09",
"employerSegment": "Services",
"employerOfficePhoneIdd": "1",
"employerOfficePhone": "8574963214",
"employerOfficeEmail": "rolf@temenos.com",
"salary": 1000,
"salaryInCurrency": "Dollar",
"salaryFrequency": "Monthly",
"primaryEmployment": true,
"extensionData": {}
}
],
"otherRiskIndicators": [
{
"partyId": "200722894",
"type": "Adverse Media",
"doesRiskApply": true,
"explanationIfApplies": "",
"explanationIfDoesnotApply": "",
"extensionData": {}
}
],
"residences": [
{
"partyId": "200722894",
"type": "Residence",
"country": "US",
"status": "Renter",
"region": "California",
"statutoryRequirementMet": true,
"statusComments": "",
"endDate": "2021-05-10",
"extensionData": {}
}
],
"vulnerabilities": [
{
"partyId": "200722894",
"vulnerabilityType": "Physical",
"vulnerabilityComments": "By Birth",
"extensionData": {}
}
],
"taxDetails": [
{
"partyId": "200722894",
"taxReference": "TAX20200J33Y",
"taxType": "Income Tax",
"country": "US",
"taxId": "2324-09-242",
"eligibilityType": "Consumption Tax",
"eligibilityReason": "Citizen of country",
"taxStartDate": "2020-05-10",
"endDate": "2021-05-10",
"taxReasonType": "Citizen",
"taxReasonComment": "",
"taxIdLackReason": "",
"isMainTaxResidency": "Yes",
"extensionData": {}
}
],
"otherNames": [
{
"partyId": "200722894",
"nameType": "LegalName",
"fromDate": "2020-09-20",
"name": "John",
"nameLanguage": "English",
"toDate": "2024-10-20",
"extensionData": {}
}
],
"observations": [
{
"partyId": "200722894",
"observationReference": "OB20200J33YH",
"type": "Under Recovery",
"observationDate": "2020-01-01",
"detail": "Party needs to be checked for missing documents",
"reason": "Missing Identification documents",
"source": "Bank User",
"extensionData": {}
}
],
"partyLegalStatus": [
{
"partyId": "200722894",
"type": "Liquidation",
"country": "US",
"effectiveFrom": "2020-01-01",
"effectiveTo": "2030-01-01",
"changeReason": "Dissolution of the company",
"extensionData": {}
}
],
"roles": [
{
"partyId": "200722894",
"roleType": "Person Customer",
"fromDate": "2020-01-01",
"status": "Deactivated",
"exitDate": "2030-01-01",
"exitReason": "Decides to leave the bank as he wants to transfer his loan to another bank for a better loan interest",
"decisionBody": "Credit Officer",
"comments": "",
"customerships": [
{
"companyLegalUnit": "Temenos Bank",
"status": "Active",
"responsibleUnits": [
{
"responsibleUnitType": "Local Responsible Unit",
"businessUnit": "Credit Officer.1",
"relationshipOfficer": "Denmark Branch 01",
"startDate": "2020-01-01",
"endDate": "2030-01-01",
"extensionData": {}
}
],
"extensionData": {}
}
],
"extensionData": {}
}
],
"addresses": [
{
"partyId": "200722894",
"addressesReference": "AD20200J33YH",
"communicationNature": "Physical",
"communicationType": "Residence",
"addressType": "Primary",
"electronicAddress": "rolf@gmail.com",
"iddPrefixPhone": "1",
"phoneNo": "7534550012",
"countryCode": "US",
"flatNumber": "151",
"floor": "2",
"buildingNumber": "3",
"buildingName": "Copenagen Flats",
"streetName": "Grand Avenue",
"town": "San leandro",
"countrySubdivision": "California",
"postalOrZipCode": "510-286-4444",
"validatedBy": "Smarty Streets",
"postBoxNumber": "A3700",
"usePurpose": "Home Address",
"regionCode": "015",
"district": "Oakland",
"department": "Sales",
"subDepartment": "Sales Support",
"landmark": "San leandro community center",
"website": "temenos.com",
"extensionData": {}
}
],
"contactReferences": [
{
"partyId": "200722894",
"contactReferences": "CR20200YOEHJ",
"reliabilityType": "Confirmed",
"contactAddressId": "AD20200J33YH",
"contactName": "John",
"startDate": "2020-01-01",
"endDate": "2025-01-01",
"extensionData": {}
}
],
"classifications": [
{
"partyId": "200722894",
"classificationCode": "NACE.Rev.2-12000",
"classificationDate": "2018-09-09",
"reason": "Industry classification updated ",
"source": "Documentation",
"endDate": "2021-01-01",
"extensionData": {}
}
],
"extensionData": {}
}The getPartyBasedOnCriteriaV3 API retrieves the details of a party based on the selected criteria.
GET/party/parties?identifierNumber={identifierNumber}&identifierType={identifierType}&lastName={lastName}&dateOfBirth={dateOfBirth}&emailId={emailId}
Sample Response
{
"parties": [
{
"partyId": "200722894",
"dateOfBirth": "1990-09-09",
"dateOfDeath": "2045-09-09",
"notificationOfDeath": "2045-10-01",
"cityOfBirth": "Newyork",
"countryOfBirth": "US",
"gender": "Male",
"maritalStatus": "Married",
"defaultLanguage": "English",
"noOfDependents": 4,
"reasonForNoCitizenship": "Migration from another country",
"partyType": "Individual",
"partyStatus": "Prospect",
"title": "Mr",
"firstName": "Rolf",
"middleName": "J",
"lastName": "Gerling",
"nickName": "Rolf",
"suffix": "B.E.",
"alias": "Rolf",
"entityName": "Temenos Group",
"nameStartDate": "2012-05-24",
"organisationLegalType": "Legal",
"incorporationCountry": "US",
"dateOfIncorporation": "2019-09-09",
"nameOfIncorporationAuthority": "",
"legalForm": "Listed Company",
"numberOfEmployees": 500,
"nationalities": [
{
"partyId": "200722894",
"country": "US"
}
],
"partyLanguages": [
{
"partyId": "200722894",
"language": "English"
}
],
"citizenships": [
{
"partyId": "200722894",
"countryOfCitizenship": "US",
"endDate": "2030-12-25"
}
],
"partyNames": [
{
"partyId": "200722894",
"title": "Mr",
"firstName": "Rolf",
"middleName": "J",
"lastName": "Gerling",
"nickName": "Rolf",
"suffix": "B.E.",
"alias": "Rolf",
"entityName": "Temenos Group",
"startDate": "2012-05-24",
"endDate": "2024-10-20",
"extensionData": {}
}
],
"partyAssessments": [
{
"partyId": "200722894",
"type": "Benchmark",
"status": "Pass",
"level": "Secured",
"score": "500-800",
"body": "CIBIL",
"conclusionDate": "2019-12-25",
"details": "Credit Score Fail",
"nature": "D",
"reason": "Apply for Mortgage",
"nextAssessmentDate": "2019-12-25",
"expirydate": "2019-12-25",
"extensionData": {}
}
],
"partyIdentifiers": [
{
"partyId": "200722894",
"type": "Passport",
"status": "New",
"issuingAuthority": "Ministry of Foreign Affairs",
"identifierNumber": "JI35VEGVS",
"issuedDate": "2017-10-24",
"expiryDate": "2020-10-24",
"issuingCountry": "US",
"holderName": "Mr. Rolf Gerling",
"extensionData": {}
}
],
"alternateIdentities": [
{
"partyId": "200722894",
"identityType": "Other System Reference",
"identityNumber": "123-45-6789",
"identitySource": "CBS",
"startDate": "2020-05-05",
"extensionData": {}
}
],
"personPositions": [
{
"partyId": "200722894",
"personPositionType": "Politically Exposed-PEP",
"countryOfPosition": "US",
"effectiveFromDate": "2019-05-05",
"effectiveToDate": "2024-05-05",
"expiryDate": "2024-05-05",
"comments": "",
"lastUpdated": "2019-05-05",
"informationSource": "News",
"extensionData": {}
}
],
"partyLifeCycles": [
{
"partyId": "200722894",
"type": "Recognised",
"startDate": "2020-01-01",
"endDate": "2021-01-01",
"changeReason": "",
"extensionData": {}
}
],
"occupations": [
{
"partyId": "200722894",
"occupationType": "Part time job",
"occupationDescription": "At McDonalds as Cashier",
"extensionData": {}
}
],
"employments": [
{
"partyId": "200722894",
"employmentReference": "EM20200J33YH",
"type": "Salaried-Employee",
"country": "US",
"jobTitle": "Product Manager",
"employerName": "Temenos",
"startDate": "2019-02-09",
"endDate": "2029-02-09",
"employerSegment": "Services",
"employerOfficePhoneIdd": "1",
"employerOfficePhone": "8574963214",
"employerOfficeEmail": "rolf@temenos.com",
"salary": 1000,
"salaryInCurrency": "Dollar",
"salaryFrequency": "Monthly",
"primaryEmployment": true,
"extensionData": {}
}
],
"otherRiskIndicators": [
{
"partyId": "200722894",
"type": "Adverse Media",
"doesRiskApply": true,
"explanationIfApplies": "",
"explanationIfDoesnotApply": "",
"extensionData": {}
}
],
"residences": [
{
"partyId": "200722894",
"type": "Residence",
"country": "US",
"status": "Renter",
"region": "California",
"statutoryRequirementMet": true,
"statusComments": "",
"endDate": "2021-05-10",
"extensionData": {}
}
],
"vulnerabilities": [
{
"partyId": "200722894",
"vulnerabilityType": "Physical",
"vulnerabilityComments": "By Birth",
"extensionData": {}
}
],
"taxDetails": [
{
"partyId": "200722894",
"taxReference": "TAX20200J33Y",
"taxType": "Income Tax",
"country": "US",
"taxId": "2324-09-242",
"eligibilityType": "Consumption Tax",
"eligibilityReason": "Citizen of country",
"taxStartDate": "2020-05-10",
"endDate": "2021-05-10",
"taxReasonType": "Citizen",
"taxReasonComment": "",
"taxIdLackReason": "",
"isMainTaxResidency": "Yes",
"extensionData": {}
}
],
"otherNames": [
{
"partyId": "200722894",
"nameType": "LegalName",
"fromDate": "2020-09-20",
"name": "John",
"nameLanguage": "English",
"toDate": "2024-10-20",
"extensionData": {}
}
],
"observations": [
{
"partyId": "200722894",
"observationReference": "OB20200J33YH",
"type": "Under Recovery",
"observationDate": "2020-01-01",
"detail": "Party needs to be checked for missing documents",
"reason": "Missing Identification documents",
"source": "Bank User",
"extensionData": {}
}
],
"partyLegalStatus": [
{
"partyId": "200722894",
"type": "Liquidation",
"country": "US",
"effectiveFrom": "2020-01-01",
"effectiveTo": "2030-01-01",
"changeReason": "Dissolution of the company",
"extensionData": {}
}
],
"roles": [
{
"partyId": "200722894",
"roleType": "Person Customer",
"fromDate": "2020-01-01",
"status": "Deactivated",
"exitDate": "2030-01-01",
"exitReason": "Decides to leave the bank as he wants to transfer his loan to another bank for a better loan interest",
"decisionBody": "Credit Officer",
"comments": "",
"customerships": [
{
"companyLegalUnit": "Temenos Bank",
"status": "Active",
"responsibleUnits": [
{
"responsibleUnitType": "Local Responsible Unit",
"businessUnit": "Credit Officer.1",
"relationshipOfficer": "Denmark Branch 01",
"startDate": "2020-01-01",
"endDate": "2030-01-01",
"extensionData": {}
}
],
"extensionData": {}
}
],
"extensionData": {}
}
],
"addresses": [
{
"partyId": "200722894",
"addressesReference": "AD20200J33YH",
"communicationNature": "Physical",
"communicationType": "Residence",
"addressType": "Primary",
"electronicAddress": "rolf@gmail.com",
"iddPrefixPhone": "1",
"phoneNo": "7534550012",
"countryCode": "US",
"flatNumber": "151",
"floor": "2",
"buildingNumber": "3",
"buildingName": "Copenagen Flats",
"streetName": "Grand Avenue",
"town": "San leandro",
"countrySubdivision": "California",
"postalOrZipCode": "510-286-4444",
"validatedBy": "Smarty Streets",
"postBoxNumber": "A3700",
"usePurpose": "Home Address",
"regionCode": "015",
"district": "Oakland",
"department": "Sales",
"subDepartment": "Sales Support",
"landmark": "San leandro community center",
"website": "temenos.com",
"extensionData": {}
}
],
"contactReferences": [
{
"partyId": "200722894",
"contactReferences": "CR20200YOEHJ",
"reliabilityType": "Confirmed",
"contactAddressId": "AD20200J33YH",
"contactName": "John",
"startDate": "2020-01-01",
"endDate": "2025-01-01",
"extensionData": {}
}
],
"classifications": [
{
"partyId": "200722894",
"classificationCode": "NACE.Rev.2-12000",
"classificationDate": "2018-09-09",
"reason": "Industry classification updated ",
"source": "Documentation",
"endDate": "2021-01-01",
"extensionData": {}
}
],
"extensionData": {}
}
]
}The createPartyIdentifierV3 API creates new party identifier records. Party Identifier can be created only for an existing party.
POST/party/parties/{partyId}/partyIdentifiers
Sample Request
{
"partyIdentifiers": [
{
"type": "Passport",
"status": "New",
"issuingAuthority": "Ministry of Foreign Affairs",
"identifierNumber": "JI35VEGVS",
"issuedDate": "2017-10-24",
"expiryDate": "2020-10-24",
"issuingCountry": "US",
"holderName": "Mr. Rolf Gerling",
"extensionData": {}
}
],
"alternateIdentities": [
{
"identityType": "Other System Reference",
"identityNumber": "123-45-6789",
"identitySource": "CBS",
"startDate": "2020-05-05",
"extensionData": {}
}
]
}Sample Response
Success Response
Media type
application/json
Controls Accept header.
Example Value
Schema
{
"id": "200722894",
"status": "Success",
"message": "Completed Successfully"
}The updatePartyIdentifierV3 amends the existing party identifier records.
PUT/party/parties/{partyId}/partyIdentifiers
Sample Request
{
"partyIdentifiers": [
{
"type": "Passport",
"status": "New",
"issuingAuthority": "Ministry of Foreign Affairs",
"identifierNumber": "JI35VEGVS",
"issuedDate": "2017-10-24",
"expiryDate": "2020-10-24",
"issuingCountry": "US",
"holderName": "Mr. Rolf Gerling",
"extensionData": {}
}
],
"alternateIdentities": [
{
"identityType": "Other System Reference",
"identityNumber": "123-45-6789",
"identitySource": "CBS",
"startDate": "2020-05-05",
"extensionData": {}
}
]
}Sample Response
{
"id": "200722894",
"status": "Success",
"message": "Completed Successfully"
}The getPartyIdentifierV3 API retrieves the party identifier records for a party.
GET/party/parties/{partyId}/partyIdentifiers
Sample Response
{
"partyIdentifiers": [
{
"partyId": "200722894",
"type": "Passport",
"status": "New",
"issuingAuthority": "Ministry of Foreign Affairs",
"identifierNumber": "JI35VEGVS",
"issuedDate": "2017-10-24",
"expiryDate": "2020-10-24",
"issuingCountry": "US",
"holderName": "Mr. Rolf Gerling",
"extensionData": {}
}
],
"alternateIdentities": [
{
"partyId": "200722894",
"identityType": "Other System Reference",
"identityNumber": "123-45-6789",
"identitySource": "CBS",
"startDate": "2020-05-05",
"extensionData": {}
}
]
}The createTaxDetailsV3 API creates new tax details’ records. Tax details can be created only for an existing party.
POST/party/parties/{partyId}/taxDetails
Sample Request
{
"taxDetails": [
{
"taxType": "Income Tax",
"country": "US",
"taxId": "2324-09-242",
"eligibilityType": "Consumption Tax",
"eligibilityReason": "Citizen of country",
"taxStartDate": "2020-05-10",
"endDate": "2021-05-10",
"taxReasonType": "Citizen",
"taxReasonComment": "",
"taxIdLackReason": "",
"isMainTaxResidency": "Yes",
"extensionData": {}
}
]
}Sample Response
{
"id": "200722894",
"status": "Success",
"message": "Completed Successfully"
}The updateTaxDetailsV3 API amends the existing tax details’ records.
PUT/party/parties/{partyId}/taxDetails
Sample Request
{
"taxDetails": [
{
"taxReference": "TAX20200J33Y",
"taxType": "Income Tax",
"country": "US",
"taxId": "2324-09-242",
"eligibilityType": "Consumption Tax",
"eligibilityReason": "Citizen of country",
"taxStartDate": "2020-05-10",
"endDate": "2021-05-10",
"taxReasonType": "Citizen",
"taxReasonComment": "",
"taxIdLackReason": "",
"isMainTaxResidency": "Yes",
"extensionData": {}
}
]
}Sample Response
{
"id": "200722894",
"status": "Success",
"message": "Completed Successfully"
}The getTaxDetailsV3 API retrieves the tax details’ records of a party.
GET/party/parties/{partyId}/taxDetails
Sample Response
{
"taxDetails": [
{
"partyId": "200722894",
"taxReference": "TAX20200J33Y",
"taxType": "Income Tax",
"country": "US",
"taxId": "2324-09-242",
"eligibilityType": "Consumption Tax",
"eligibilityReason": "Citizen of country",
"taxStartDate": "2020-05-10",
"endDate": "2021-05-10",
"taxReasonType": "Citizen",
"taxReasonComment": "",
"taxIdLackReason": "",
"isMainTaxResidency": "Yes",
"extensionData": {}
}
]
}The createEmploymentDetailsV3 API creates new tax details and occupation records for a party.
POST/party/parties/{partyId}/employmentDetails
Sample Request
{
"employments": [
{
"type": "Salaried-Employee",
"country": "US",
"jobTitle": "Product Manager",
"employerName": "Temenos",
"startDate": "2019-02-09",
"endDate": "2029-02-09",
"employerSegment": "Services",
"employerOfficePhoneIdd": "1",
"employerOfficePhone": "8574963214",
"employerOfficeEmail": "rolf@temenos.com",
"salary": 1000,
"salaryInCurrency": "Dollar",
"salaryFrequency": "Monthly",
"primaryEmployment": true,
"extensionData": {}
}
],
"occupations": [
{
"occupationType": "Part time job",
"occupationDescription": "At McDonalds as Cashier",
"extensionData": {}
}
]
}Sample Response
{
"id": "200722894",
"employmentReferences": "EM20200J33YH",
"status": "Success",
"message": "Completed Successfully"
}The updateEmploymentDetailsV3 API amends the existing tax details occupation records for a party.
PUT/party/parties/{partyId}/employmentDetails
Sample Request
{
"employments": [
{
"employmentReference": "EM20200J33YH",
"type": "Salaried-Employee",
"country": "US",
"jobTitle": "Product Manager",
"employerName": "Temenos",
"startDate": "2019-02-09",
"endDate": "2029-02-09",
"employerSegment": "Services",
"employerOfficePhoneIdd": "1",
"employerOfficePhone": "8574963214",
"employerOfficeEmail": "rolf@temenos.com",
"salary": 1000,
"salaryInCurrency": "Dollar",
"salaryFrequency": "Monthly",
"primaryEmployment": true,
"extensionData": {}
}
],
"occupations": [
{
"occupationType": "Part time job",
"occupationDescription": "At McDonalds as Cashier",
"extensionData": {}
}
]
}Sample Response
{
"id": "200722894",
"employmentReferences": "EM20200J33YH",
"status": "Success",
"message": "Completed Successfully"
}The getEmploymentDetailsV3 API retrieves the existing tax details and occupation records for a party.
GET/party/parties/{partyId}/employmentDetails
Sample Response
{
"employments": [
{
"partyId": "200722894",
"employmentReference": "EM20200J33YH",
"type": "Salaried-Employee",
"country": "US",
"jobTitle": "Product Manager",
"employerName": "Temenos",
"startDate": "2019-02-09",
"endDate": "2029-02-09",
"employerSegment": "Services",
"employerOfficePhoneIdd": "1",
"employerOfficePhone": "8574963214",
"employerOfficeEmail": "rolf@temenos.com",
"salary": 1000,
"salaryInCurrency": "Dollar",
"salaryFrequency": "Monthly",
"primaryEmployment": true,
"extensionData": {}
}
],
"occupations": [
{
"partyId": "200722894",
"occupationType": "Part time job",
"occupationDescription": "At McDonalds as Cashier",
"extensionData": {}
}
]
}The createObservationV3 creates new observation record for a party.
POST/party/parties/{partyId}/observations
Sample Request
{
"observations": [
{
"type": "Under Recovery",
"observationDate": "2020-01-01",
"detail": "Party needs to be checked for missing documents",
"reason": "Missing Identification documents",
"source": "Bank User",
"extensionData": {}
}
]
}Sample Response
{
"id": "200722894",
"status": "Success",
"message": "Completed Successfully"
}The updateObservationV3 API amends the existing observation records for a party.
PUT/party/parties/{partyId}/observations
Sample Request
{
"observations": [
{
"observationReference": "OB20200J33YH",
"type": "Under Recovery",
"observationDate": "2020-01-01",
"detail": "Party needs to be checked for missing documents",
"reason": "Missing Identification documents",
"source": "Bank User",
"extensionData": {}
}
]
}
Sample Response
{
"id": "200722894",
"status": "Success",
"message": "Completed Successfully"
}The getObservationV3 API retrieves observation records for a party.
GET/party/parties/{partyId}/observations
Sample Response
{
"observations": [
{
"partyId": "200722894",
"observationReference": "OB20200J33YH",
"type": "Under Recovery",
"observationDate": "2020-01-01",
"detail": "Party needs to be checked for missing documents",
"reason": "Missing Identification documents",
"source": "Bank User",
"extensionData": {}
}
]
}The createPartyLegalStatusV3 API creates new party legal status record for a party.
POST/party/parties/{partyId}/partyLegalStatus
Sample Request
{
"partyLegalStatus": [
{
"type": "Liquidation",
"country": "US",
"effectiveFrom": "2020-01-01",
"effectiveTo": "2030-01-01",
"changeReason": "Dissolution of the company",
"extensionData": {}
}
]
}Sample Response
{
"id": "200722894",
"status": "Success",
"message": "Completed Successfully"
}The updatePartyLegalStatusV3 API amends the existing party legal status records for a party.
PUT/party/parties/{partyId}/partyLegalStatus
Sample Request
{
"partyLegalStatus": [
{
"type": "Liquidation",
"country": "US",
"effectiveFrom": "2020-01-01",
"effectiveTo": "2030-01-01",
"changeReason": "Dissolution of the company",
"extensionData": {}
}
]
}Sample Response
{
"id": "200722894",
"status": "Success",
"message": "Completed Successfully"
}The getPartyLegalStatusV3 API retrieves the party legal status records for a party.
GET/party/parties/{partyId}/partyLegalStatus
Sample Response
{
"partyLegalStatus": [
{
"partyId": "200722894",
"type": "Liquidation",
"country": "US",
"effectiveFrom": "2020-01-01",
"effectiveTo": "2030-01-01",
"changeReason": "Dissolution of the company",
"extensionData": {}
}
]
}The createRoleV3 API creates new roles’ record for a party.
POST/party/parties/{partyId}/roles
Sample Request
{
"roles": [
{
"roleType": "Person Customer",
"fromDate": "2020-01-01",
"status": "Deactivated",
"exitDate": "2030-01-01",
"exitReason": "Decides to leave the bank as he wants to transfer his loan to another bank for a better loan interest",
"decisionBody": "Credit Officer",
"comments": "",
"customerships": [
{
"companyLegalUnit": "Temenos Bank",
"status": "Active",
"responsibleUnits": [
{
"responsibleUnitType": "Local Responsible Unit",
"businessUnit": "Credit Officer.1",
"relationshipOfficer": "Denmark Branch 01",
"startDate": "2020-01-01",
"endDate": "2030-01-01",
"extensionData": {}
}
],
"extensionData": {}
}
],
"extensionData": {}
}
]
}Sample Response
{
"id": "200722894",
"status": "Success",
"message": "Completed Successfully"
}The updateRoleV3 API amends the existing roles’ records for a party.
PUT/party/parties/{partyId}/roles
Sample Request
{
"roles": [
{
"roleType": "Person Customer",
"fromDate": "2020-01-01",
"status": "Deactivated",
"exitDate": "2030-01-01",
"exitReason": "Decides to leave the bank as he wants to transfer his loan to another bank for a better loan interest",
"decisionBody": "Credit Officer",
"comments": "",
"customerships": [
{
"companyLegalUnit": "Temenos Bank",
"status": "Active",
"responsibleUnits": [
{
"responsibleUnitType": "Local Responsible Unit",
"businessUnit": "Credit Officer.1",
"relationshipOfficer": "Denmark Branch 01",
"startDate": "2020-01-01",
"endDate": "2030-01-01",
"extensionData": {}
}
],
"extensionData": {}
}
],
"extensionData": {}
}
]
}Sample Response
{
"id": "200722894",
"status": "Success",
"message": "Completed Successfully"
}The getRoleV3 API retrieves roles’ record for a party.
GET/party/parties/{partyId}/roles
Sample Response
{
"roles": [
{
"partyId": "200722894",
"roleType": "Person Customer",
"fromDate": "2020-01-01",
"status": "Deactivated",
"exitDate": "2030-01-01",
"exitReason": "Decides to leave the bank as he wants to transfer his loan to another bank for a better loan interest",
"decisionBody": "Credit Officer",
"comments": "",
"customerships": [
{
"companyLegalUnit": "Temenos Bank",
"status": "Active",
"responsibleUnits": [
{
"responsibleUnitType": "Local Responsible Unit",
"businessUnit": "Credit Officer.1",
"relationshipOfficer": "Denmark Branch 01",
"startDate": "2020-01-01",
"endDate": "2030-01-01",
"extensionData": {}
}
],
"extensionData": {}
}
],
"extensionData": {}
}
]
}The createAddressesV3 API creates new address record for a party.
POST/party/parties/{partyId}/addresses
Sample Request
{
"addresses": [
{
"communicationNature": "Physical",
"communicationType": "Residence",
"addressType": "Primary",
"electronicAddress": "rolf@gmail.com",
"iddPrefixPhone": "1",
"phoneNo": "7534550012",
"countryCode": "US",
"flatNumber": "151",
"floor": "2",
"buildingNumber": "3",
"buildingName": "Copenagen Flats",
"streetName": "Grand Avenue",
"town": "San leandro",
"countrySubdivision": "California",
"postalOrZipCode": "510-286-4444",
"validatedBy": "Smarty Streets",
"postBoxNumber": "A3700",
"usePurpose": "Home Address",
"regionCode": "015",
"district": "Oakland",
"department": "Sales",
"subDepartment": "Sales Support",
"landmark": "San leandro community center",
"website": "temenos.com",
"extensionData": {}
}
]
}
Sample Response
{
"id": "200722894",
"status": "Success",
"message": "Completed Successfully"
}The updateAddressesV3 API amends the existing address records for a party.
PUT/party/parties/{partyId}/addresses
Sample Request
{
"addresses": [
{
"addressesReference": "AD20200J33YH",
"communicationType": "Residence",
"communicationNature": "Physical",
"addressType": "Primary",
"electronicAddress": "rolf@gmail.com",
"iddPrefixPhone": "1",
"phoneNo": "7534550012",
"countryCode": "US",
"flatNumber": "151",
"floor": "2",
"buildingNumber": "3",
"buildingName": "Copenagen Flats",
"streetName": "Grand Avenue",
"town": "San leandro",
"countrySubdivision": "California",
"postalOrZipCode": "510-286-4444",
"validatedBy": "Smarty Streets",
"postBoxNumber": "A3700",
"usePurpose": "Home Address",
"regionCode": "015",
"district": "Oakland",
"department": "Sales",
"subDepartment": "Sales Support",
"landmark": "San leandro community center",
"website": "temenos.com",
"extensionData": {}
}
]
}Sample Response
{
"id": "200722894",
"status": "Success",
"message": "Completed Successfully"
}The updateAddressTypeV3 API updates the address type for a communication nature.
PUT/party/parties/{partyId}/addressTypes/?communicationNature={communicationNature}
Sample Request
{
"addresses": [
{
"addressesReference": "AD20200J33YH",
"addressType": "Primary"
}
]
}Sample Response
{
"id": "200722894",
"status": "Success",
"message": "Completed Successfully"
}The getAddressesV3 API retrieves the address record for a party.
GET/party/parties/{partyId}/addresses
Sample Response
{
"addresses": [
{
"partyId": "200722894",
"addressesReference": "AD20200J33YH",
"communicationNature": "Physical",
"communicationType": "Residence",
"addressType": "Primary",
"electronicAddress": "rolf@gmail.com",
"iddPrefixPhone": "1",
"phoneNo": "7534550012",
"countryCode": "US",
"flatNumber": "151",
"floor": "2",
"buildingNumber": "3",
"buildingName": "Copenagen Flats",
"streetName": "Grand Avenue",
"town": "San leandro",
"countrySubdivision": "California",
"postalOrZipCode": "510-286-4444",
"validatedBy": "Smarty Streets",
"postBoxNumber": "A3700",
"usePurpose": "Home Address",
"regionCode": "015",
"district": "Oakland",
"department": "Sales",
"subDepartment": "Sales Support",
"landmark": "San leandro community center",
"website": "temenos.com",
"extensionData": {}
}
]
}The createContactReferencesV3 API creates new contact references’ record for a party.
POST/party/parties/{partyId}/contactReferences
Sample Request
{
"contactReferences": [
{
"reliabilityType": "Confirmed",
"contactAddressId": "AD20200J33YH",
"contactName": "John",
"startDate": "2020-01-01",
"endDate": "2025-01-01",
"extensionData": {}
}
]
}Sample Response
{
"id": "200722894",
"status": "Success",
"message": "Completed Successfully"
}The updateContactReferencesV3 API amends the existing contact references’ records for a party.
PUT/party/parties/{partyId}/contactReferences
Sample Request
{
"contactReferences": [
{
"contactReferences": "CR20200YOEHJ",
"reliabilityType": "Confirmed",
"contactAddressId": "AD20200J33YH",
"contactName": "John",
"startDate": "2020-01-01",
"endDate": "2025-01-01",
"extensionData": {}
}
]
}Sample Response
{
"id": "200722894",
"status": "Success",
"message": "Completed Successfully"
}The getContactReferencesV3 API retrieves the contact references’ record for a party.
GET/party/parties/{partyId}/contactReferences
Sample Response
{
"contactReferences": [
{
"partyId": "200722894",
"contactReferences": "CR20200YOEHJ",
"reliabilityType": "Confirmed",
"contactAddressId": "AD20200J33YH",
"contactName": "John",
"startDate": "2020-01-01",
"endDate": "2025-01-01",
"extensionData": {}
}
]
}The createClassificationV3 API creates a new classification record for a party.
POST/party/parties/{partyId}/classifications
Sample Request
{
"classifications": [
{
"classificationCode": "NACE.Rev.2-12000",
"classificationDate": "2018-09-09",
"reason": "Industry classification updated ",
"source": "Documentation",
"endDate": "2021-01-01",
"extensionData": {}
}
]
}Sample Response
{
"id": "200722894",
"status": "Success",
"message": "Completed Successfully"
}The updateClassificationV3 API amends the existing classification records for a party.
PUT/party/parties/{partyId}/classifications
Sample Request
{
"classifications": [
{
"classificationCode": "NACE.Rev.2-12000",
"classificationDate": "2018-09-09",
"reason": "Industry classification updated ",
"source": "Documentation",
"endDate": "2021-01-01",
"extensionData": {}
}
]
}Sample Response
{
"id": "200722894",
"status": "Success",
"message": "Completed Successfully"
}The getClassificationV3 API retrieves the classifications record for a party.
GET/party/parties/{partyId}/classifications
Sample Response
{
"classifications": [
{
"partyId": "200722894",
"classificationCode": "NACE.Rev.2-12000",
"classificationDate": "2018-09-09",
"reason": "Industry classification updated ",
"source": "Documentation",
"endDate": "2021-01-01",
"extensionData": {}
}
]
}The createPartyRelationshipsV3 API creates new party relations’ record for a party.
POST/party/parties/{partyId}/relationships
Sample Request
{
"partyRelations": [
{
"startDate": "2020-09-29",
"relatedParty": "200722124",
"relationType": "ParentOf",
"hierarchyType": "Other",
"ownershipPercentage": 50,
"endDate": "2020-09-29",
"comments": "comments if any",
"extensionData": {}
}
]
}Sample Response
{
"id": "200722894",
"status": "Success",
"message": "Completed Successfully"
}The endPartyRelationshipsV3 API updates the end date along with comments (if needed) for an existing relationship type that is created through the create relation type API.
POST/party/parties/{partyId}/relationships?relationType={relationType}
Sample Request
{
"endDate": "2020-09-29",
"comments": "Updated end date"
}Sample Response
{
"id": "200722894",
"status": "Success",
"message": "Completed Successfully"
}The updateOwnershipPercentageV3 API updates the ownership percentage and comments (if needed) for an existing relationship type created.
PUT/party/parties/{partyId}/relationships /ownershipPercentage
Sample Request
{
"ownershipPercentage": 50,
"comments": "Updated ownership percentage",
"extensionData": {}
}Sample Response
{
"id": "200722894",
"status": "Success",
"message": "Completed Successfully"
}The getPartyRelationshipsBasedOnCriteriaV3 API retrieves the direct party relations based on the Party ID and the Relation Type.
GET/party/parties/{partyId}/relationships?relationType={relationType}&hierarchyType={hierarchyType}
Sample Response
{
"partyRelations": [
{
"relationshipReference": "PYRL20135AX6HT",
"partyId": "200722894",
"startDate": "2020-09-29",
"relatedParty": "200722124",
"relationType": "ParentOf",
"hierarchyType": "Other",
"ownershipPercentage": 50,
"endDate": "2020-09-29",
"comments": "comments if any",
"extensionData": {}
}
]
}The createCodeHierarchyV3 API creates new code hierarchy records for the provided classification codes.
POST/reference/references/codeHierarchies
Sample Request
{
"codeHierarchies": [
{
"classificationCode": "NACE.Rev.2-12000",
"relatedClassificationType": "Parent",
"relatedClassificationCode": "ESA2010-1100",
"depth": "1",
"extensionData": {}
}
]
}Sample Response
{
"id": "200722894",
"status": "Success",
"message": "Completed Successfully"
}The updateCodeHierarchyV3 API amends the existing code hierarchy records for a party.
PUT/reference/references/codeHierarchies
Sample Request
{
"codeHierarchies": [
{
"classificationCode": "NACE.Rev.2-12000",
"relatedClassificationType": "Parent",
"relatedClassificationCode": "ESA2010-1100",
"depth": "1",
"extensionData": {}
}
]
}Sample Response
{
"id": "200722894",
"status": "Success",
"message": "Completed Successfully"
}The getCodeHierarchyV3 API retrieves the existing code hierarchy records that contain the relationship between the classification codes.
GET/reference/references/codeHierarchies
Sample Response
{
"codeHierarchies": [
{
"classificationCode": "NACE.Rev.2-12000",
"relatedClassificationType": "Parent",
"relatedClassificationCode": "ESA2010-1100",
"depth": "1",
"extensionData": {}
}
]
}The createRelationshipTypesV3 API creates a relation type, which is used to specify a party relationship. This API is used to define the possible type of relationships of parties as well as their reverse relation type.
POST/reference/relationTypes/{relationType}
Sample Request
{
"description": "Related as parent",
"reverseRelationType": "ChildOf",
"reverseRelationTypeDescription": "Related as child",
"relationNature": "",
"hierarchyType": "Other",
"partyRoles": [
"AssociatedParty"
],
"extensionData": {}
}Sample Response
{
"relationType": "ParentOf",
"status": "Success",
"message": "Completed Successfully"
}The updateRelationshipTypesV3 API updates the existing relation type created through the create relation type API. The possible relationship types created, and their reverse relation type can be updated through this API.
PUT/reference/relationTypes/{relationType}
Sample Request
{
"description": "Related as parent",
"reverseRelationTypeDescription": "Related as child",
"relationNature": "",
"hierarchyType": "Other",
"partyRoles": [
"AssociatedParty"
],
"extensionData": {}
}Sample Response
{
"relationType": "ParentOf",
"status": "Success",
"message": "Completed Successfully"
}The getRelationshipTypesBasedOnCriteriaV3 API retrieve the relation type based on the provided hierarchy type.
GET/reference/relationTypes?hierarchyType={hierarchyType}
Sample Response
{
"relationTypes": [
{
"relationType": "ParentOf",
"description": "Related as parent",
"reverseRelationType": "ChildOf",
"reverseRelationTypeDescription": "Related as child",
"relationNature": "",
"hierarchyType": "Other",
"partyRoles": [
"AssociatedParty"
],
"extensionData": {}
}
]
}The createReferenceDataForPartyV3 API create the dynamic references required for a party.
POST/reference/references/parties
Sample Request
{
"references": {
"Gender": [
{
"id": "Male",
"description": "Male"
}
],
"MaritalStatus": [
{
"id": "Married",
"description": "Married"
}
],
"Language": [
{
"id": "English",
"description": "English"
}
],
"Title": [
{
"id": "MR",
"description": "Mister"
}
],
"PartyIdentifierStatus": [
{
"id": "New",
"description": "New"
}
],
"LifeCycleStatusType": [
{
"id": "Recognised",
"description": "Recognised"
}
],
"ReliabilityType": [
{
"id": "Confirmed",
"description": "Confirmed"
}
],
"AssessmentNature": [
{
"id": "A",
"description": "A"
}
],
"AssessmentLevel": [
{
"id": "Secured",
"description": "Secured"
}
],
"AssessmentType": [
{
"id": "Benchmark",
"description": "Benchmark"
}
],
"ResidenceType": [
{
"id": "Domicile",
"description": "Domicile"
}
],
"ResidentialStatus": [
{
"id": "Owner",
"description": "Owner"
}
],
"OccupationType": [
{
"id": "Full time job",
"description": "Full time job"
}
],
"IdentityType": [
{
"id": "Other System Reference",
"description": "Other System Reference"
}
],
"JobTitle": [
{
"id": "Product Manager",
"description": "Product Manager"
}
],
"Currency": [
{
"id": "Dollar",
"description": "Dollar"
}
],
"TaxReasonType": [
{
"id": "Citizen",
"description": "Citizen"
}
],
"TaxType": [
{
"id": "Income Tax",
"description": "Income Tax"
}
],
"TaxEligibilityType": [
{
"id": "Consumption Tax",
"description": "Consumption Tax"
}
],
"VulnerabilityType": [
{
"id": "Physical",
"description": "Physical"
}
],
"RiskIndicatorType": [
{
"id": "Adverse Media",
"description": "Adverse Media"
}
],
"LegalIdentifierType": [
{
"id": "Passport",
"description": "Passport"
}
],
"PartyType": [
{
"id": "Individual",
"description": "Individual"
}
],
"PartyStatus": [
{
"id": "Prospect",
"description": "Prospect"
}
],
"IsMainTaxResidency": [
{
"id": "Yes",
"description": "Yes"
}
],
"RoleType": [
{
"id": "Person Customer",
"description": "Person Customer"
}
],
"RoleStatus": [
{
"id": "Deactivated",
"description": "Deactivated"
}
],
"CompanyLegalUnit": [
{
"id": "Temenos Bank",
"description": "Temenos Bank"
}
],
"ResponsibleUnitType": [
{
"id": "Local Responsible Unit",
"description": "Local Responsible Unit"
}
],
"BusinessUnit": [
{
"id": "Credit Officer.1",
"description": "Credit Officer.1"
}
],
"RelationshipOfficer": [
{
"id": "RelationshipOfficer-Denmark Branch 01",
"description": "RelationshipOfficer-Denmark Branch 01"
}
],
"ObservationType": [
{
"id": "Under Recovery",
"description": "Under Recovery"
}
],
"LegalStatusType": [
{
"id": "Liquidation",
"description": "Liquidation"
}
],
"OrganisationLegalType": [
{
"id": "Legal",
"description": "Legal"
}
],
"LegalForm": [
{
"id": "Listed Company",
"description": "Listed Company"
}
],
"EmploymentStatusType": [
{
"id": "Employed",
"description": "Employed"
}
],
"PositionType": [
{
"id": "Prime Minister",
"description": "Prime Minister"
}
],
"CommunicationTypeNature": [
{
"id": "Electronic",
"description": "Electronic"
}
],
"NameType": [
{
"id": "LegalName",
"description": "LegalName"
}
],
"PersonPositionCategory": [
{
"id": "PEP",
"description": "PEP"
}
],
"RelatedClassificationType": [
{
"id": "Parent",
"description": "Parent"
}
],
"AllowUsage": [
{
"id": "Yes",
"description": "Yes"
}
],
"InternalFlag": [
{
"id": "Yes",
"description": "Yes"
}
],
"ClassificationSource": [
{
"id": "Documentation",
"description": "Documentation"
}
],
"PartyRole": [
{
"id": "Customer",
"description": "Customer"
}
],
"HierarchyType": [
{
"id": "Parent",
"description": "Parent"
}
],
"RelationNature": [
{
"id": "GoldenParty",
"description": "GoldenParty"
}
],
"AddressType": [
{
"addressTypeName": "Primary",
"description": "Specifies Primary contact details of a party"
}
],
"CommunicationType": [
{
"typeName": "Email",
"typeNature": "Electronic",
"description": "Electronic mail"
}
],
"InformationSource": [
{
"informationSourceScope": "News",
"informationSourceValue": "Industry Classification Updated"
}
],
"ResidenceRegion": [
{
"residenceCountry": "United States",
"residenceRegion": "California"
}
],
"Country": [
{
"countryCode": "US",
"countryName": "United States",
"numericCountryCode": 1,
"alpha3CountryCode": "USA",
"highRiskCountry": true,
"iddPrefix": 1
}
],
"EmploymentType": [
{
"employmentStatusType": "Employed",
"employmentType": "Self-Employed",
"description": "This record is applicable for all type of self-employees"
}
],
"PartyIdentifierType": [
{
"identifierType": "Internal",
"isLegalIdentifier": true,
"allowedPartyType": "Individual",
"isExternal": true
}
],
"PersonPositionType": [
{
"type": "Prime Minister",
"category": "PEP",
"description": ""
}
],
"ClassificationCode": [
{
"schemeId": "NACE.Rev.2",
"code": "12000",
"name": "Mining",
"description": "Including mining coal and minerals operations",
"level": "1",
"allowUsage": "Yes"
}
],
"ClassificationScheme": [
{
"schemeId": "NACE.Rev.2",
"description": "European Industry Classification",
"authority": "European Union",
"categoryName": "Industry",
"internalFlag": "No"
}
]
}
}Sample Response
{
"id": "Gender",
"status": "Success",
"message": "Completed Successfully"
}The getReferenceDataForPartyV3 API retrieves the existing dynamic references.
GET/reference/references/parties
Sample Response
{
"references": {
"Gender": [
{
"id": "Male",
"description": "Male"
}
],
"MaritalStatus": [
{
"id": "Married",
"description": "Married"
}
],
"Language": [
{
"id": "English",
"description": "English"
}
],
"Title": [
{
"id": "MR",
"description": "Mister"
}
],
"PartyIdentifierStatus": [
{
"id": "New",
"description": "New"
}
],
"LifeCycleStatusType": [
{
"id": "Recognised",
"description": "Recognised"
}
],
"ReliabilityType": [
{
"id": "Confirmed",
"description": "Confirmed"
}
],
"AssessmentNature": [
{
"id": "A",
"description": "A"
}
],
"AssessmentLevel": [
{
"id": "Secured",
"description": "Secured"
}
],
"AssessmentType": [
{
"id": "Benchmark",
"description": "Benchmark"
}
],
"ResidenceType": [
{
"id": "Domicile",
"description": "Domicile"
}
],
"ResidentialStatus": [
{
"id": "Owner",
"description": "Owner"
}
],
"OccupationType": [
{
"id": "Full time job",
"description": "Full time job"
}
],
"IdentityType": [
{
"id": "Other System Reference",
"description": "Other System Reference"
}
],
"JobTitle": [
{
"id": "Product Manager",
"description": "Product Manager"
}
],
"Currency": [
{
"id": "Dollar",
"description": "Dollar"
}
],
"TaxReasonType": [
{
"id": "Citizen",
"description": "Citizen"
}
],
"TaxType": [
{
"id": "Income Tax",
"description": "Income Tax"
}
],
"TaxEligibilityType": [
{
"id": "Consumption Tax",
"description": "Consumption Tax"
}
],
"VulnerabilityType": [
{
"id": "Physical",
"description": "Physical"
}
],
"RiskIndicatorType": [
{
"id": "Adverse Media",
"description": "Adverse Media"
}
],
"LegalIdentifierType": [
{
"id": "Passport",
"description": "Passport"
}
],
"PartyType": [
{
"id": "Individual",
"description": "Individual"
}
],
"PartyStatus": [
{
"id": "Prospect",
"description": "Prospect"
}
],
"IsMainTaxResidency": [
{
"id": "Yes",
"description": "Yes"
}
],
"RoleType": [
{
"id": "Person Customer",
"description": "Person Customer"
}
],
"RoleStatus": [
{
"id": "Deactivated",
"description": "Deactivated"
}
],
"CompanyLegalUnit": [
{
"id": "Temenos Bank",
"description": "Temenos Bank"
}
],
"ResponsibleUnitType": [
{
"id": "Local Responsible Unit",
"description": "Local Responsible Unit"
}
],
"BusinessUnit": [
{
"id": "Credit Officer.1",
"description": "Credit Officer.1"
}
],
"RelationshipOfficer": [
{
"id": "RelationshipOfficer-Denmark Branch 01",
"description": "RelationshipOfficer-Denmark Branch 01"
}
],
"ObservationType": [
{
"id": "Under Recovery",
"description": "Under Recovery"
}
],
"LegalStatusType": [
{
"id": "Liquidation",
"description": "Liquidation"
}
],
"OrganisationLegalType": [
{
"id": "Legal",
"description": "Legal"
}
],
"LegalForm": [
{
"id": "Listed Company",
"description": "Listed Company"
}
],
"EmploymentStatusType": [
{
"id": "Employed",
"description": "Employed"
}
],
"PositionType": [
{
"id": "Prime Minister",
"description": "Prime Minister"
}
],
"CommunicationTypeNature": [
{
"id": "Electronic",
"description": "Electronic"
}
],
"NameType": [
{
"id": "LegalName",
"description": "LegalName"
}
],
"PersonPositionCategory": [
{
"id": "PEP",
"description": "PEP"
}
],
"RelatedClassificationType": [
{
"id": "Parent",
"description": "Parent"
}
],
"AllowUsage": [
{
"id": "Yes",
"description": "Yes"
}
],
"InternalFlag": [
{
"id": "Yes",
"description": "Yes"
}
],
"ClassificationSource": [
{
"id": "Documentation",
"description": "Documentation"
}
],
"PartyRole": [
{
"id": "Customer",
"description": "Customer"
}
],
"HierarchyType": [
{
"id": "Parent",
"description": "Parent"
}
],
"RelationNature": [
{
"id": "GoldenParty",
"description": "GoldenParty"
}
],
"AddressType": [
{
"id": "Primary",
"addressTypeName": "Primary",
"description": "Specifies Primary contact details of a party"
}
],
"CommunicationType": [
{
"id": "Email-Electronic",
"typeName": "Email",
"typeNature": "Electronic",
"description": "Electronic mail"
}
],
"InformationSource": [
{
"id": "News",
"informationSourceScope": "News",
"informationSourceValue": "Industry Classification Updated"
}
],
"ResidenceRegion": [
{
"id": "California",
"residenceCountry": "United States",
"residenceRegion": "California"
}
],
"Country": [
{
"id": "US",
"countryCode": "US",
"countryName": "United States",
"numericCountryCode": 1,
"alpha3CountryCode": "USA",
"highRiskCountry": true,
"iddPrefix": 1
}
],
"EmploymentType": [
{
"id": "Self-Employed",
"employmentStatusType": "Employed",
"employmentType": "Self-Employed",
"description": "This record is applicable for all type of self-employees"
}
],
"PartyIdentifierType": [
{
"id": "Internal",
"identifierType": "Internal",
"isLegalIdentifier": true,
"allowedPartyType": "Individual",
"isExternal": true
}
],
"PersonPositionType": [
{
"id": "Prime Minister-PEP",
"type": "Prime Minister",
"category": "PEP",
"description": ""
}
],
"ClassificationCode": [
{
"id": "NACE.Rev.2-12000",
"schemeId": "NACE.Rev.2",
"code": "12000",
"name": "Mining",
"description": "Including mining coal and minerals operations",
"level": "1",
"allowUsage": "Yes"
}
],
"ClassificationScheme": [
{
"id": "NACE.Rev.2",
"schemeId": "NACE.Rev.2",
"description": "European Industry Classification",
"authority": "European Union",
"categoryName": "Industry",
"internalFlag": "No"
}
]
}
}The updateReferenceDataForPartyV3 API amends the existing dynamic references.
PUT/reference/references/parties
Sample Request
{
"references": {
"Gender": [
{
"id": "Male",
"description": "Male"
}
],
"MaritalStatus": [
{
"id": "Married",
"description": "Married"
}
],
"Language": [
{
"id": "English",
"description": "English"
}
],
"Title": [
{
"id": "MR",
"description": "Mister"
}
],
"PartyIdentifierStatus": [
{
"id": "New",
"description": "New"
}
],
"LifeCycleStatusType": [
{
"id": "Recognised",
"description": "Recognised"
}
],
"ReliabilityType": [
{
"id": "Confirmed",
"description": "Confirmed"
}
],
"AssessmentNature": [
{
"id": "A",
"description": "A"
}
],
"AssessmentLevel": [
{
"id": "Secured",
"description": "Secured"
}
],
"AssessmentType": [
{
"id": "Benchmark",
"description": "Benchmark"
}
],
"ResidenceType": [
{
"id": "Domicile",
"description": "Domicile"
}
],
"ResidentialStatus": [
{
"id": "Owner",
"description": "Owner"
}
],
"OccupationType": [
{
"id": "Full time job",
"description": "Full time job"
}
],
"IdentityType": [
{
"id": "Other System Reference",
"description": "Other System Reference"
}
],
"JobTitle": [
{
"id": "Product Manager",
"description": "Product Manager"
}
],
"Currency": [
{
"id": "Dollar",
"description": "Dollar"
}
],
"TaxReasonType": [
{
"id": "Citizen",
"description": "Citizen"
}
],
"TaxType": [
{
"id": "Income Tax",
"description": "Income Tax"
}
],
"TaxEligibilityType": [
{
"id": "Consumption Tax",
"description": "Consumption Tax"
}
],
"VulnerabilityType": [
{
"id": "Physical",
"description": "Physical"
}
],
"RiskIndicatorType": [
{
"id": "Adverse Media",
"description": "Adverse Media"
}
],
"LegalIdentifierType": [
{
"id": "Passport",
"description": "Passport"
}
],
"PartyType": [
{
"id": "Individual",
"description": "Individual"
}
],
"PartyStatus": [
{
"id": "Prospect",
"description": "Prospect"
}
],
"IsMainTaxResidency": [
{
"id": "Yes",
"description": "Yes"
}
],
"RoleType": [
{
"id": "Person Customer",
"description": "Person Customer"
}
],
"RoleStatus": [
{
"id": "Deactivated",
"description": "Deactivated"
}
],
"CompanyLegalUnit": [
{
"id": "Temenos Bank",
"description": "Temenos Bank"
}
],
"ResponsibleUnitType": [
{
"id": "Local Responsible Unit",
"description": "Local Responsible Unit"
}
],
"BusinessUnit": [
{
"id": "Credit Officer.1",
"description": "Credit Officer.1"
}
],
"RelationshipOfficer": [
{
"id": "RelationshipOfficer-Denmark Branch 01",
"description": "RelationshipOfficer-Denmark Branch 01"
}
],
"ObservationType": [
{
"id": "Under Recovery",
"description": "Under Recovery"
}
],
"LegalStatusType": [
{
"id": "Liquidation",
"description": "Liquidation"
}
],
"OrganisationLegalType": [
{
"id": "Legal",
"description": "Legal"
}
],
"LegalForm": [
{
"id": "Listed Company",
"description": "Listed Company"
}
],
"EmploymentStatusType": [
{
"id": "Employed",
"description": "Employed"
}
],
"PositionType": [
{
"id": "Prime Minister",
"description": "Prime Minister"
}
],
"CommunicationTypeNature": [
{
"id": "Electronic",
"description": "Electronic"
}
],
"NameType": [
{
"id": "LegalName",
"description": "LegalName"
}
],
"PersonPositionCategory": [
{
"id": "PEP",
"description": "PEP"
}
],
"RelatedClassificationType": [
{
"id": "Parent",
"description": "Parent"
}
],
"AllowUsage": [
{
"id": "Yes",
"description": "Yes"
}
],
"InternalFlag": [
{
"id": "Yes",
"description": "Yes"
}
],
"ClassificationSource": [
{
"id": "Documentation",
"description": "Documentation"
}
],
"PartyRole": [
{
"id": "Customer",
"description": "Customer"
}
],
"HierarchyType": [
{
"id": "Parent",
"description": "Parent"
}
],
"RelationNature": [
{
"id": "GoldenParty",
"description": "GoldenParty"
}
],
"AddressType": [
{
"addressTypeName": "Primary",
"description": "Specifies Primary contact details of a party"
}
],
"CommunicationType": [
{
"typeName": "Email",
"typeNature": "Electronic",
"description": "Electronic mail"
}
],
"InformationSource": [
{
"informationSourceScope": "News",
"informationSourceValue": "Industry Classification Updated"
}
],
"ResidenceRegion": [
{
"residenceCountry": "United States",
"residenceRegion": "California"
}
],
"Country": [
{
"countryCode": "US",
"countryName": "United States",
"numericCountryCode": 1,
"alpha3CountryCode": "USA",
"highRiskCountry": true,
"iddPrefix": 1
}
],
"EmploymentType": [
{
"employmentStatusType": "Employed",
"employmentType": "Self-Employed",
"description": "This record is applicable for all type of self-employees"
}
],
"PartyIdentifierType": [
{
"identifierType": "Internal",
"isLegalIdentifier": true,
"allowedPartyType": "Individual",
"isExternal": true
}
],
"PersonPositionType": [
{
"type": "Prime Minister",
"category": "PEP",
"description": ""
}
],
"ClassificationCode": [
{
"schemeId": "NACE.Rev.2",
"code": "12000",
"name": "Mining",
"description": "Including mining coal and minerals operations",
"level": "1",
"allowUsage": "Yes"
}
],
"ClassificationScheme": [
{
"schemeId": "NACE.Rev.2",
"description": "European Industry Classification",
"authority": "European Union",
"categoryName": "Industry",
"internalFlag": "No"
}
]
}
}Sample Response
{
"id": "Gender",
"status": "Success",
"message": "Completed Successfully"
}The addReferenceDataForPartyV3 API adds the reference data for the existing type provided.
POST/reference/parties/{referenceType}
Sample Request
{
"references": {
"Gender": [
{
"id": "Male",
"description": "Male"
}
],
"MaritalStatus": [
{
"id": "Married",
"description": "Married"
}
],
"Language": [
{
"id": "English",
"description": "English"
}
],
"Title": [
{
"id": "MR",
"description": "Mister"
}
],
"PartyIdentifierStatus": [
{
"id": "New",
"description": "New"
}
],
"LifeCycleStatusType": [
{
"id": "Recognised",
"description": "Recognised"
}
],
"ReliabilityType": [
{
"id": "Confirmed",
"description": "Confirmed"
}
],
"AssessmentNature": [
{
"id": "A",
"description": "A"
}
],
"AssessmentLevel": [
{
"id": "Secured",
"description": "Secured"
}
],
"AssessmentType": [
{
"id": "Benchmark",
"description": "Benchmark"
}
],
"ResidenceType": [
{
"id": "Domicile",
"description": "Domicile"
}
],
"ResidentialStatus": [
{
"id": "Owner",
"description": "Owner"
}
],
"OccupationType": [
{
"id": "Full time job",
"description": "Full time job"
}
],
"IdentityType": [
{
"id": "Other System Reference",
"description": "Other System Reference"
}
],
"JobTitle": [
{
"id": "Product Manager",
"description": "Product Manager"
}
],
"Currency": [
{
"id": "Dollar",
"description": "Dollar"
}
],
"TaxReasonType": [
{
"id": "Citizen",
"description": "Citizen"
}
],
"TaxType": [
{
"id": "Income Tax",
"description": "Income Tax"
}
],
"TaxEligibilityType": [
{
"id": "Consumption Tax",
"description": "Consumption Tax"
}
],
"VulnerabilityType": [
{
"id": "Physical",
"description": "Physical"
}
],
"RiskIndicatorType": [
{
"id": "Adverse Media",
"description": "Adverse Media"
}
],
"LegalIdentifierType": [
{
"id": "Passport",
"description": "Passport"
}
],
"PartyType": [
{
"id": "Individual",
"description": "Individual"
}
],
"PartyStatus": [
{
"id": "Prospect",
"description": "Prospect"
}
],
"IsMainTaxResidency": [
{
"id": "Yes",
"description": "Yes"
}
],
"RoleType": [
{
"id": "Person Customer",
"description": "Person Customer"
}
],
"RoleStatus": [
{
"id": "Deactivated",
"description": "Deactivated"
}
],
"CompanyLegalUnit": [
{
"id": "Temenos Bank",
"description": "Temenos Bank"
}
],
"ResponsibleUnitType": [
{
"id": "Local Responsible Unit",
"description": "Local Responsible Unit"
}
],
"BusinessUnit": [
{
"id": "Credit Officer.1",
"description": "Credit Officer.1"
}
],
"RelationshipOfficer": [
{
"id": "RelationshipOfficer-Denmark Branch 01",
"description": "RelationshipOfficer-Denmark Branch 01"
}
],
"ObservationType": [
{
"id": "Under Recovery",
"description": "Under Recovery"
}
],
"LegalStatusType": [
{
"id": "Liquidation",
"description": "Liquidation"
}
],
"OrganisationLegalType": [
{
"id": "Legal",
"description": "Legal"
}
],
"LegalForm": [
{
"id": "Listed Company",
"description": "Listed Company"
}
],
"EmploymentStatusType": [
{
"id": "Employed",
"description": "Employed"
}
],
"PositionType": [
{
"id": "Prime Minister",
"description": "Prime Minister"
}
],
"CommunicationTypeNature": [
{
"id": "Electronic",
"description": "Electronic"
}
],
"NameType": [
{
"id": "LegalName",
"description": "LegalName"
}
],
"PersonPositionCategory": [
{
"id": "PEP",
"description": "PEP"
}
],
"RelatedClassificationType": [
{
"id": "Parent",
"description": "Parent"
}
],
"AllowUsage": [
{
"id": "Yes",
"description": "Yes"
}
],
"InternalFlag": [
{
"id": "Yes",
"description": "Yes"
}
],
"ClassificationSource": [
{
"id": "Documentation",
"description": "Documentation"
}
],
"PartyRole": [
{
"id": "Customer",
"description": "Customer"
}
],
"HierarchyType": [
{
"id": "Parent",
"description": "Parent"
}
],
"RelationNature": [
{
"id": "GoldenParty",
"description": "GoldenParty"
}
],
"AddressType": [
{
"addressTypeName": "Primary",
"description": "Specifies Primary contact details of a party"
}
],
"CommunicationType": [
{
"typeName": "Email",
"typeNature": "Electronic",
"description": "Electronic mail"
}
],
"InformationSource": [
{
"informationSourceScope": "News",
"informationSourceValue": "Industry Classification Updated"
}
],
"ResidenceRegion": [
{
"residenceCountry": "United States",
"residenceRegion": "California"
}
],
"Country": [
{
"countryCode": "US",
"countryName": "United States",
"numericCountryCode": 1,
"alpha3CountryCode": "USA",
"highRiskCountry": true,
"iddPrefix": 1
}
],
"EmploymentType": [
{
"employmentStatusType": "Employed",
"employmentType": "Self-Employed",
"description": "This record is applicable for all type of self-employees"
}
],
"PartyIdentifierType": [
{
"identifierType": "Internal",
"isLegalIdentifier": true,
"allowedPartyType": "Individual",
"isExternal": true
}
],
"PersonPositionType": [
{
"type": "Prime Minister",
"category": "PEP",
"description": ""
}
],
"ClassificationCode": [
{
"schemeId": "NACE.Rev.2",
"code": "12000",
"name": "Mining",
"description": "Including mining coal and minerals operations",
"level": "1",
"allowUsage": "Yes"
}
],
"ClassificationScheme": [
{
"schemeId": "NACE.Rev.2",
"description": "European Industry Classification",
"authority": "European Union",
"categoryName": "Industry",
"internalFlag": "No"
}
]
}
}Sample Response
{
"id": "Gender",
"status": "Success",
"message": "Completed Successfully"
}Add Bookmark
save your best linksView Bookmarks
Visit your best links
BACK
Are you sure you want to log-off?