Enterprise APIs
This section covers the details of the APIs supported by Due Diligence microservice.
Version 1.0.0
The V1.0.0 version of Due Diligence microservice APIs are as follows.
|
FUNCTIONAL GROUP |
OPERATION ID |
URI |
API DESCRIPTION |
FUNCTIONAL GROUP DESCRIPTION |
|---|---|---|---|---|
|
Assessment Events |
getAssessmentEventsBasedOnCriteria |
/party/parties/{partyId}/assessmentEvents |
This API is used to retrieve assessment events for a party and it can be further filtered based on the event type and expiry date. |
Assessment Events records details of every CDD assessment that are performed for a party. For example, KYC Assessment, AML Assessment, and PEP Assessment. Assessment can be a self-declaration. for example, a party declares themselves as a PEP. In this case, Self-Declaration is one of the trigger sources reasons. |
|
createAssessmentEventsForParty |
/party/parties/{partyId}/assessmentEvents |
This API creates an assessment event whenever an assessment is triggered for a party. All the details of the assessment including the details of assessment expiry and next assessment can be captured. |
||
|
updateAssessmentEventsForParty |
/party/parties/{partyId}/assessmentEvents |
This API is used to update an already existing assessment event record for the provided assessment reference. The assessment reference gets generated during the creation of a new assessment event. |
||
|
Source Of Funds |
getSourceOfFundsBasedOnCriteria |
/party/parties/{partyId}/sourceOfFunds |
This API is used to retrieve source of funds details for a party and it can be further filtered based on source of funds reference. |
Source of Funds register information that is related to the source of funds for a party. It is applicable for organizations or sole traders to capture the funds that are obtained for their capital. |
|
createSourceOfFundsForParty |
/party/parties/{partyId}/sourceOfFunds |
This API is used to record the source of funds details for a party. A reference gets generated while creating source of funds records, which is associated to the party. |
||
|
updateSourceOfFundsForParty |
/party/parties/{partyId}/sourceOfFunds |
This API is used to update an already existing source of funds data based on party id and source of funds reference. |
||
|
Intentions |
getIntentionsForParty |
/party/parties/{partyId}/intentions |
This API is used to retrieve all the recorded intentions of a party. |
Intentions captures information about the party intentions (transaction related) when applying for specific products such as current accounts and saving accounts. |
|
createIntentionsForParty |
/party/parties/{partyId}/intentions |
This API is used to create intention for a party. |
||
|
updateIntentionsForParty |
/party/parties/{partyId}/intentions |
This API is used to update the intention details of a party. |
||
|
Financial Information |
getFinancialInformationsForParty |
/party/parties/{partyId}/financialInformations |
This API is used to retrieve financial information based on selection criteria. |
Captures information about financial details of a party. It contains realised amounts for different financial types, such as: profit, revenue, purchase and so on. |
|
createFinancialInformationsForParty |
/party/parties/{partyId}/financialInformations |
This API creates a new financial information record. |
||
|
updateFinancialInformationsForParty |
/party/parties/{partyId}/financialInformations |
This API updates a financial information record. |
||
| Asset Liab Details | getAssetLiabDetailsForParty | /party/parties/{partyId}/assetLiabDetails | This API retrieves the Asset Liab Details records for a particular Party. | Captures information about asset liab details of a party. |
| createAssetLiabDetailsForParty | /party/parties/{partyId}/assetLiabDetails | This API creates a new Asset Liab Details records for a particular Party. | ||
| updateAssetLiabDetailsForParty | /party/parties/{partyId}/assetLiabDetails | This API updates an existing Asset Liab Details records for a particular Party. | ||
|
Reference Data
|
getReferenceDataForCDD |
/reference/references/dueDiligence |
This API is used to retrieve the list of dynamic reference data for a given reference data type. |
Reference data holds the static information for all the reference entities. Country is the only reference specific to Due Diligence. |
|
createReferenceDataForCDD |
/reference/references/dueDiligence |
This API is used to create reference data for the existing reference type provided. |
||
|
updateReferenceDataForCDD |
/reference/references/dueDiligence |
This API is used to update the reference data's description of the given reference details. |
||
|
addReferenceDataForCDD |
/reference/dueDiligence/{referenceType} |
This API is used to create a reference type based on given details. |
||
|
deleteReferenceDataForCDD |
/reference/dueDiligence/{referenceType} |
This API is used to delete the reference data based on given reference data type and value. |
To view the complete APIs specification, refer to Service Spec (Swagger) and the Swagger JSON file.
Version 2.0.0
The V2.0.0 version of Due Diligence microservice APIs are as follows.
| FUNCTIONAL GROUP |
OPERATION ID |
URI |
API DESCRIPTION |
FUNCTIONAL GROUP DESCRIPTION |
|---|---|---|---|---|
|
Assessment Events |
getAssessmentEventsBasedOnCriteriaV2 |
/party/parties/assessments/assessmentEvents |
This API retrieves assessment events for a party, and further filtered based on the event type and expiry date. |
Assessment Events records details of every CDD assessment for a party. For example, KYC Assessment, AML Assessment, and PEP Assessment. Assessment can be a self-declaration. For example, a party declares itself as a PEP. In this case, Self-Declaration is one of the trigger sources reasons. |
| createAssessmentEventsForPartyV2 | /party/parties/{partyId}/assessmentEvents | This API creates a new Assessment Event records whenever an assessment triggers for a party. This captures the details of the assessment including assessment expiry and the next assessment date. | ||
| updateAssessmentEventsForPartyV2 | /party/parties/{partyId}/assessmentEvents | This API updates the existing assessment event record for the provided assessment reference. An assessment reference gets generated in the process of creating new assessment event. | ||
| getAssessmentEventsForPartyV2 | /party/parties/{partyId}/assessmentEvents | This API retrieves Assessment events for a party and further filtered based on the event type and expiry date. | ||
|
Ownership Structure |
createOwnershipStructureForParty |
/party/parties/{partyId}/ownershipStructure |
This API creates the details of the ownership of an organization that includes information about high risk ownership. |
Ownership structure entity captures the details of the ownership of an organization that includes information about high risk ownership. For example, Beneficial owners. |
|
updateOwnershipStructureForParty |
/party/parties/{partyId}/ownershipStructure |
This API updates the existing ownership structure for the provided party. |
||
|
getOwnershipStructureForParty |
/party/parties/{partyId}/ownershipStructure |
This API retrieves the Ownership Structure records for the provided party. |
||
|
Registration Details |
createRegistrationDetailsForParty |
/party/parties/{partyId}/registrationDetails |
This API creates the registration details of an organization that describes the countries that are registered and operating. |
Registration Detail entity describes about the countries in which the organization is registered and operating. |
|
updateRegistrationDetailsForParty |
/party/parties/{partyId}/registrationDetails |
This API updates the existing Registration Details records for the provided party. |
||
|
getRegistrationDetailsBasedOnCriteria |
/party/parties/{partyId}/registrationDetails |
This API returns the registration details record based on Party, Registration Country, and Registration Number. |
||
|
Trading Details |
createTradingDetailsForParty |
/party/parties/{partyId}/tradingDetails |
This API create trading details records that includes the information regarding bearer shares information for a party. |
Trading Details entity captures information about bearer shares. A bearer share is an equity security that is owned by a person who holds the physical stock certificate. |
|
updateTradingDetailsForParty |
/party/parties/{partyId}/tradingDetails |
This API updates the existing Trading Details record for the provided party. |
||
|
getTradingDetailsForParty |
/party/parties/{partyId}/tradingDetails |
This API returns the trading details records that includes the bearer shares information for the provided party. |
||
|
Economic Activities |
createEconomicActivitiesForParty |
/party/parties/{partyId}/economicActivities |
This API creates economic activities record that captures the information regarding economic activities that are performed by an organization. |
Economic Activities captures information about economic activities that an organization performs. |
|
updateEconomicActivitiesForParty |
/party/parties/{partyId}/economicActivities |
This API updates the existing economic activities record for the provided party. |
||
|
getEconomicActivitiesForParty |
/party/parties/{partyId}/economicActivities |
This API returns the economic activities record for the provided party. |
||
| Source of Funds
|
createSourceOfFundsForPartyV2 | /party/parties/{partyId}/sourceOfFunds | This API creates a new Source Of Funds record. A Reference generates on creating a source of funds records that are associated with the party. | Register information related to the source of funds for a party. It is mostly applicable for organizations or sole traders to capture the funds obtained for their capital. |
| updateSourceOfFundsForPartyV2 | /party/parties/{partyId}/sourceOfFunds | This API updates and existing source of funds data based on party ID and source of funds reference. | ||
| getSourceOfFundsBasedOnCriteriaV2 | /party/parties/{partyId}/sourceOfFunds | This API retrives all Source of Funds details for a party and further filtered based on the source of funds reference. | ||
|
Reference Data
|
createReferenceDataForCDDV2 |
/reference/references/dueDiligence |
This API creates a new reference type along with the given details. |
Reference data holds the static information for all the reference entities. Country is the only reference specific to due diligence. |
|
getReferenceDataForCDDV2 |
/reference/references/dueDiligence |
This API retrieves the list of dynamic reference data for given reference data type. |
||
|
updateReferenceDataForCDDV2 |
/reference/references/dueDiligence |
This API updates the reference data description of the given reference details. |
||
|
addReferenceDataForCDDV2 |
/reference/dueDiligence/{referenceType} |
This API creates reference data for the existing type that is provided. |
||
|
deleteReferenceDataForCDDV2 |
/reference/dueDiligence/{referenceType} |
This API deletes a reference data for the given reference data type and value. |
To view the complete APIs specification, refer to Service Spec (Swagger) and the Swagger JSON file.
Version 3.0.0
The V3.0.0 version of Due Diligence microservice APIs are as follows.
| FUNCTIONAL GROUP |
OPERATION ID |
URI |
API DESCRIPTION |
FUNCTIONAL GROUP DESCRIPTION |
|---|---|---|---|---|
|
Assessment Events |
getAssessmentEventsBasedOnCriteriaV3 |
/party/parties/assessments/assessmentEvents |
This API retrieves assessment events for a party, and further filtered based on the event type and expiry date. |
Assessment Events records details of every CDD assessment for a party. For example, KYC Assessment, AML Assessment, and PEP Assessment. Assessment can be a self-declaration. For example, a party declares itself as a PEP. In this case, Self-Declaration is one of the trigger sources reasons. |
To view the complete APIs specification, refer to Service Spec (Swagger) and the Swagger JSON file.
Latest Version APIs
The V3.0.0 version of Due Diligence microservice APIs are as follows.
|
FUNCTIONAL GROUP |
OPERATION ID |
Version |
URI |
API DESCRIPTION |
|---|---|---|---|---|
|
Assessment Events |
getAssessmentEventsBasedOnCriteriaV3 |
V3.0.0 |
/party/parties/assessments/assessmentEvents |
This API retrieves the assessment events for a party and further filtered based on the event type and expiry date. |
| getAssessmentEventsForPartyV2 | V2.0.0 | /party/parties/{partyId}/assessmentEvents | This API retrieves the Assessment events for a party and further filtered based on the event type and expiry date. | |
|
createAssessmentEventsForPartyV2 |
V2.0.0 |
/party/parties/{partyId}/assessmentEvents |
This API creates a new Assessment Event records whenever an assessment triggers for a party. This captures the details of the assessment including assessment expiry and the next assessment date. |
|
|
updateAssessmentEventsForPartyV2 |
V2.0.0 |
/party/parties/{partyId}/assessmentEvents |
This API updates an existing assessment event record for the provided assessment reference. An assessment reference gets generated in the process of creating new assessment event. |
|
|
Source Of Funds |
getSourceOfFundsBasedOnCriteriaV2 |
V2.0.0 |
/party/parties/{partyId}/sourceOfFunds |
This API retrieves source of funds details for a party and further filtered based on source of funds reference. |
|
createSourceOfFundsForPartyV2 |
V2.0.0 |
/party/parties/{partyId}/sourceOfFunds |
This API records the source of funds details for a party. A reference gets generated while creating source of funds records, which is associated to the party. |
|
|
updateSourceOfFundsForPartyV2 |
V2.0.0 |
/party/parties/{partyId}/sourceOfFunds |
This API updates an already existing source of funds data based on party id and source of funds reference. |
|
|
Intentions |
getIntentionsForParty |
V1.0.0 |
/party/parties/{partyId}/intentions |
This API is used to retrieve all the recorded intentions of a party. |
|
createIntentionsForParty |
V1.0.0 |
/party/parties/{partyId}/intentions |
This API is used to create intention for a party. |
|
|
updateIntentionsForParty |
V1.0.0 |
/party/parties/{partyId}/intentions |
This API is used to update the intention details of a party. |
|
|
Financial Information |
getFinancialInformationsForParty |
V1.0.0 |
/party/parties/{partyId}/financialInformations |
This API is used to retrieve financial information based on selection criteria. |
|
createFinancialInformationsForParty |
V1.0.0 |
/party/parties/{partyId}/financialInformations |
This API creates a new financial information record. |
|
|
updateFinancialInformationsForParty |
V1.0.0 |
/party/parties/{partyId}/financialInformations |
This API updates a financial information record. |
|
| Asset Liab Details | getAssetLiabDetailsForParty | V1.0.0 | /party/parties/{partyId}/assetLiabDetails | This API retrieves the Asset Liab Details records for a particular Party. |
| createAssetLiabDetailsForParty | V1.0.0 | /party/parties/{partyId}/assetLiabDetails | This API creates a new Asset Liab Details records for a particular Party. | |
| updateAssetLiabDetailsForParty | V1.0.0 | /party/parties/{partyId}/assetLiabDetails | This API updates an existing Asset Liab Details records for a particular Party. | |
| Ownership Structure |
createOwnershipStructureForParty |
V2.0.0 | /party/parties/{partyId}/ownershipStructure |
This API creates the details of the ownership of an organization that includes information about high risk ownership. |
|
updateOwnershipStructureForParty |
V2.0.0 | /party/parties/{partyId}/ownershipStructure |
This API updates the existing ownership structure for the provided party. |
|
|
getOwnershipStructureForParty |
V2.0.0 | /party/parties/{partyId}/ownershipStructure |
This API retrieves the Ownership Structure records for the provided party. |
|
| Registration Details |
createRegistrationDetailsForParty |
V2.0.0 |
/party/parties/{partyId}/registrationDetails |
This API creates the registration details of an organization that describes the countries that are registered and operating. |
|
updateRegistrationDetailsForParty |
V2.0.0 |
/party/parties/{partyId}/registrationDetails |
This API updates the existing Registration Details records for the provided party. |
|
|
getRegistrationDetailsBasedOnCriteria |
V2.0.0 |
/party/parties/{partyId}/registrationDetails |
This API returns the registration details record based on Party, Registration Country, and Registration Number. |
|
| Trading Details |
createTradingDetailsForParty |
V2.0.0 |
/party/parties/{partyId}/tradingDetails |
This API create trading details records that includes the information regarding bearer shares information for a party. |
|
updateTradingDetailsForParty |
V2.0.0 |
/party/parties/{partyId}/tradingDetails |
This API updates the existing Trading Details record for the provided party. |
|
|
getTradingDetailsForParty |
V2.0.0 |
/party/parties/{partyId}/tradingDetails |
This API returns the trading details records that includes the bearer shares information for the provided party. |
|
| Economic Activities |
createEconomicActivitiesForParty |
V2.0.0 |
/party/parties/{partyId}/economicActivities |
This API creates economic activities record that captures the information regarding economic activities that are performed by an organization. |
|
updateEconomicActivitiesForParty |
V2.0.0 |
/party/parties/{partyId}/economicActivities |
This API updates the existing economic activities record for the provided party. |
|
|
getEconomicActivitiesForParty |
V2.0.0 |
/party/parties/{partyId}/economicActivities |
This API returns the economic activities record for the provided party. |
|
|
Reference Data
|
getReferenceDataForCDD |
V2.0.0 |
/reference/references/dueDiligence |
This API creates a new reference type along with the given details. |
|
createReferenceDataForCDD |
V2.0.0 |
/reference/references/dueDiligence |
This API retrieves the list of dynamic reference data for given reference data type. |
|
|
updateReferenceDataForCDD |
V2.0.0 |
/reference/references/dueDiligence |
This API updates the reference data description of the given reference details. |
|
|
addReferenceDataForCDD |
V2.0.0 |
/reference/dueDiligence/{referenceType} |
This API creates reference data for the existing type that is provided. |
|
|
deleteReferenceDataForCDD |
V2.0.0 |
/reference/dueDiligence/{referenceType} |
This API deletes a reference data for the given reference data type and value. |
To learn about Reference data and APIs, see the Reference APIs section.
In this topic