Microservices
Updated On 24 March 2024 |
Min(s) read
Reference APIs
This section gives an overview on Due Diligence reference data types and describes the associated APIs.
The following types of Reference Data are available in Due Diligence Microservices:
- User-defined Reference - User-defined codes are customer-specific codes that need to be configured and validated in the Microservices.
- MS Specific Reference - Reference data specific to a particular Microservice.
User-defined Reference
In case of user-defined code type, you can make use of custom data for the attributes marked with reference data support (x-referencetype) in the API documentation. To create, update or delete the user defined references, see the APIs section.
User defined Reference in Swagger
properties:
eventType:
description: "Type of event for which CDD assessment will be perfomed for a party"
type: string
nullable: false
example: "AML"
x-referencetype: EventType
MS Specific Reference
Reference data which are specific to Due Diligence Microservice is handled by the Due Diligence APIs.
Below is the list of reference data supported in Due Diligence Microservice:
Version 1.0.0
The V2.0.0 version of Reference APIs of Party microservice are as follows.
| API | Entity | Field(s) | Reference ID | Reference Type |
|---|---|---|---|---|
| createAssessmentEventsForParty | AssessmentEvent | eventType | EventType | User-defined |
| AssessmentEvent | triggerType | TriggerType | User-defined | |
| AssessmentEvent | triggerSourceReason | TriggerSourceReason | User-defined | |
| updateAssessmentEventsForParty | AssessmentEvent | triggerSourceReason | TriggerSourceReason | User-defined |
| createSourceOfFundsForParty | SourceOfFunds | fundsType | FundsType | User-defined |
| SourceOfFunds | fundsSource | FundsSource | User-defined | |
| SourceOfFunds | purpose | FundsPurpose | User-defined | |
| SourceOfFunds | fundsCurrency | Currency | User-defined | |
| SourceOfFunds | fundsFrequency | FundsFrequency | Static | |
| SourceOfFunds | fundsCountry | Country | MS-Specific | |
| updateSourceOfFundsForParty | SourceOfFunds | purpose | FundsPurpose | User-defined |
| SourceOfFunds | fundsCurrency | Currency | User-defined | |
| SourceOfFunds | fundsFrequency | FundsFrequency | Static | |
| SourceOfFunds | fundsCountry | Country | MS-Specific | |
| createIntentionsForParty | Intentions | productNature | ProductNature | User-defined |
| Intentions | transactionType | TransactionType | User-defined | |
| Intentions | purpose | IntentionPurpose | User-defined | |
| Intentions | estimatedVolumeCurrency | Currency | User-defined | |
| Intentions | frequency | Frequency | Static | |
| updateIntentionsForParty | Intentions | purpose | IntentionPurpose | User-defined |
| Intentions | estimatedVolumeCurrency | Currency | User-defined | |
| Intentions | frequency | Frequency | Static | |
|
createFinancialInformationsForParty / updateFinancialInformationsForParty |
FinancialInformation | financialType | FinancialType | User-defined |
| FinancialInformation | currency | Currency | User-defined | |
| FinancialInformation | realisedCountry | Country | MS-Specific | |
|
createAssetLiabDetailsForParty/ updateAssetLiabDetailsForParty |
AssetLiabDetails | currency | Currency | User-defined |
| AssetLiabDetails | type | AssetLiabTypes | MS-Specific | |
| AssetLiabDetails | classification | Classification | User-defined |
Version 2.0.0
The V2.0.0 version of Reference APIs of Party microservice are as follows.
| API | Entity | Field(s) | Reference Data | Reference Type |
|---|---|---|---|---|
| createAssessmentEventsForPartyV2 | AssessmentEvent | eventType | EventType | User-defined |
| AssessmentEvent | triggerType | TriggerType | User-defined | |
| AssessmentEvent | triggerSourceReason | TriggerSourceReason | User-defined | |
| updateAssessmentEventsForPartyV2 | AssessmentEvent | triggerSourceReason | TriggerSourceReason | User-defined |
| createRegistrationDetailsForParty | RegistrationDetails | organisationLegalForm | OrganisationLegalForm | User-defined |
| RegistrationDetails | registerationCountry | Country | MS-Specific | |
| updateRegistrationDetailsForParty | RegistrationDetails | organisationLegalForm | OrganisationLegalForm | User-defined |
| RegistrationDetails | registerationCountry | Country | MS-Specific | |
| createTradingDetailsForParty | TradingDetails | bearerSharesIndicator | BearerSharesIndicator | User-defined |
| TradingDetails | issuanceShareIndicator | IssuanceShareIndicator | User-defined | |
| TradingDetails | shareCancelIndicator | ShareCancelIndicator | User-defined | |
| TradingDetails | exchangeName | ExchangeName | User-defined | |
| updateTradingDetailsForParty | TradingDetails | bearerSharesIndicator | BearerSharesIndicator | User-defined |
| TradingDetails | issuanceShareIndicator | IssuanceShareIndicator | User-defined | |
| TradingDetails | shareCancelIndicator | ShareCancelIndicator | User-defined | |
| TradingDetails | exchangeName | ExchangeName | User-defined | |
| createEconomicActivitiesForParty | EconomicActivities | activityType | ActivityType | User-defined |
| EconomicActivities | country | Country | MS-Specific | |
| EconomicActivities | activityPurpose | ActivityPurpose | User-defined | |
| EconomicActivities | regulatedBody | RegulatedBody | User-defined | |
| EconomicActivities | businessPartyType | BusinessPartyType | User-defined | |
| EconomicActivities | productNature | ProductNature | User-defined | |
| EconomicActivities | domainType | DomainType | User-defined | |
| EconomicActivities | workforceBased | WorkforceBased | User-defined | |
| EconomicActivities | salaryPaymentType | SalaryPaymentType | User-defined | |
| updateEconomicActivitiesForParty | EconomicActivities | activityPurpose | ActivityPurpose | User-defined |
| EconomicActivities | regulatedBody | RegulatedBody | User-defined | |
| EconomicActivities | businessPartyType | BusinessPartyType | User-defined | |
| EconomicActivities | productNature | ProductNature | User-defined | |
| EconomicActivities | domainType | DomainType | User-defined | |
| EconomicActivities | workforceBased | WorkforceBased | User-defined | |
| EconomicActivities | salaryPaymentType | SalaryPaymentType | User-defined | |
| createSourceOfFundsForPartyV2 | SourceOfFunds | fundsType | FundsType | User-defined |
| SourceOfFunds | fundsSource | FundsSource | User-defined | |
| SourceOfFunds | purpose | FundsPurpose | User-defined | |
| SourceOfFunds | fundsCountry | Country | MS-Specific | |
| SourceOfFunds | fundsCurrency | Currency | User-defined | |
| SourceOfFunds | fundsFrequency | FundsFrequency | Static | |
| updateSourceOfFundsForPartyV2 | SourceOfFunds | purpose | FundsPurpose | User-defined |
| SourceOfFunds | fundsCountry | Country | MS-Specific | |
| SourceOfFunds | fundsCurrency | Currency | User-defined | |
| SourceOfFunds | fundsFrequency | FundsFrequency | Static |
APIs
To view the complete specification of the reference APIs, click here.
In this topic