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:

  • Static Reference - Codes are standard and common across the banking industry.
  • 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.

Static Reference

As a part of design time, standard reference types are statically defined in the swagger.

ClosedStandard Reference in Swagger 
Frequency:
  type: string
  enum:
    - Monthly
    - Yearly
    - Daily
    - Weekly

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.

ClosedUser 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:

API Entity Field(s) Reference Data 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

APIs

This section shows the reference APIs.

CREATE REFERENCE DATA
This API is used to create reference data with given details.

POST/reference

Sample URL
http://localhost:8004/ms-duediligence-api/api/v1.0.0/reference
Request
{
  "references": {
    "ContactPointType": [
      {
        "value": "email",
        "description": "Electronic Address"
      },
      {
        "value": "phone",
        "description": "Phone Address"
      },
      {
        "value": "address",
        "description": "Physical Address"
      }
    ],
    "PhysicalAddressType": [
      {
        "value": "home",
        "description": "Home"
      },
      {
        "value": "residencial",
        "description": "Residencial"
      },
      {
        "value": "office",
        "description": "Office"
      }
    ]
  }
}
Response
{
  "status": 200,
  "message": "Operation successful"
}
GET THE LIST OF DYNAMIC REFERENCE DATA
This API is used to retrieve the list of dynamic reference data for given reference data type.

GET/reference

Sample URL
http://localhost:8004/ms-duediligence-api/api/v1.0.0/reference
Response
{
  "references": {
    "LegalIdentifierType": [
      {
        "value": "passport",
        "description": "Passport"
      },
      {
        "value": "driverslicense",
        "description": "Driver's license"
      }
    ]
  },
  "status": 200,
  "message": "Operation successful"
}
UPDATE REFERENCE DATA
This API is used to update reference data's description of the given reference details.

PUT/reference

Sample URL
http://localhost:8004/ms-duediligence-api/api/v1.0.0/reference
Request
{
  "references": {
    "ContactPointType": [
      {
        "value": "email",
        "description": "Electronic Address"
      },
      {
        "value": "phone",
        "description": "Phone Address"
      },
      {
        "value": "address",
        "description": "Physical Address"
      }
    ],
    "PhysicalAddressType": [
      {
        "value": "home",
        "description": "Home"
      },
      {
        "value": "residencial",
        "description": "Residencial"
      },
      {
        "value": "office",
        "description": "Office"
      }
    ]
  }
}
Response
{
  "status": 200,
  "message": "Operation successful"
}
ADD COLLECTION ITEM
This API is used to add an existing collection item with the new values.

POST/reference/{types}

Sample URL
http://localhost:8004/ms-duediligence-api/api/v1.0.0/reference/{types}
Request
{
  "value": "GuardianAddress",
  "description": "Guardian's Address"
}
Response
{
  "status": 200,
  "message": "Operation successful"
}
DELETE REFERENCE DATA
This API is used to delete the reference data for a given reference data type and value.

DELETE/reference/{types}

Sample URL
http://localhost:8004/ms-duediligence-api/api/v1.0.0/reference/{types}
Response
{
  "status": 200,
  "message": "Delete successful"
}

Bookmark Name Actions
BACK

In this topic

Feedback
x

Are you sure you want to log-off?