APIs

This section covers the details of the APIs supported by Due Diligence microservices.

To view the Swagger Spec of the Due Diligence microservice APIs, click here.

To learn about Reference data and APIs, see the Reference APIs section.

CREATE ASSESSMENT EVENT
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.

POST/party/parties/{partyId}/assessmentEvents

Sample URL
http://localhost:8004/ms-duediligence-api/api/v1.0.0/party/parties/{partyId}/assessmentEvents
Request
{
  "assessmentEvents": [
    {
      "eventType": "AML",
      "triggerType": "Automatic",
      "triggerDate": "2020-01-01",
      "triggerSourceReason": "AdverseMedia",
      "triggerUser": "AMLUser",
      "triggerBusinessArea": "",
      "triggerComments": "",
      "riskScoringMethodology": "4th EU AML Directive",
      "externalEventReference": "AML12345678",
      "conclusionDate": "2030-01-01",
      "decisionMakingBody": "FCA",
      "decisionComments": "",
      "level": "Secured",
      "nature": "D",
      "score": 7.1,
      "status": "InProgress",
      "nextAssessmentDate": "2020-12-25",
      "expiryDate": "2030-12-25",
      "extensionData": {}
    }
  ]
}
Response
{
  "assessmentReference": "ASMT20355YT56J",
  "status": "Success",
  "message": "Completed Successfully"
}
UPDATE AN ASSESSMENT EVENT
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.

PUT/party/parties/{partyId}/assessmentEvents

Sample URL
http://localhost:8004/ms-duediligence-api/api/v1.0.0/party/parties/{partyId}/assessmentEvents
Request
{
  "assessmentEvents": [
    {
      "assessmentReference": "ASMT20355YT56J",
      "triggerSourceReason": "AdverseMedia",
      "triggerUser": "AMLUser",
      "triggerBusinessArea": "",
      "triggerComments": "",
      "riskScoringMethodology": "4th EU AML Directive",
      "externalEventReference": "AML12345678",
      "conclusionDate": "2030-01-01",
      "decisionMakingBody": "FCA",
      "decisionComments": "",
      "level": "Secured",
      "nature": "D",
      "score": 8,
      "status": "InProgress",
      "nextAssessmentDate": "2020-12-25",
      "expiryDate": "2030-12-25",
      "extensionData": {}
    }
  ]
}
Response
{
  "assessmentReference": "ASMT20355YT56J",
  "status": "Success",
  "message": "Completed Successfully"
}
GET ASSESSMENT EVENT
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.

GET/party/parties/{partyId}/assessmentEvents

Sample URL
http://localhost:8004/ms-duediligence-api/api/v1.0.0/party/parties/{partyId}/assessmentEvents?eventType={eventType}&expiryDate={expiryDate}
Response
{
   "assessmentEvents": [
    {
      "assessmentReference": "ASMT20355YT56J",
      "partyId": "200722894",
      "eventType": "AML",
      "triggerType": "Automatic",
      "triggerDate": "2020-01-01",
      "triggerSourceReason": "AdverseMedia",
      "triggerUser": "AMLUser",
      "triggerBusinessArea": "",
      "triggerComments": "",
      "riskScoringMethodology": "4th EU AML Directive",
      "externalEventReference": "AML12345678",
      "conclusionDate": "2030-01-01",
      "decisionMakingBody": "FCA",
      "decisionComments": "",
      "level": "Secured",
      "nature": "D",
      "score": 7.1,
      "status": "InProgress",
      "nextAssessmentDate": "2020-12-25",
      "expiryDate": "2030-12-25",
      "extensionData": {}
    }
  ]
}
CREATE A SOURCE OF FUND REQUEST FOR PARTY
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.

POST/party/parties/{partyId}/sourceOfFunds

Sample URL
http://localhost:8004/ms-duediligence-api/api/v1.0.0/party/parties/{partyId}/sourceOfFunds
Request
{
  "sourceOfFunds": [
    {
      "fundsType": "Capital",
      "fundsSource": "Investor",
      "sourceName": "Bill Gates",
      "purpose": "CapitalIncrease",
      "fundsCountry": "USA",
      "fundsCurrency": "USD",
      "fundsRange": "",
      "fundsAmount": 10,
      "fundsFrequency": "Yearly",
      "isSourceVerified": true,
      "comments": "",
      "extensionData": {}
    }
  ]
}
Response
{
  "sourceOfFundsReference": "FUND20355YT56J",
  "status": "Success",
  "message": "Completed Successfully"
}
UPDATE SOURCE OF FUND DATA
This API is used to update an already existing source of funds data based on party id and source of funds reference.

PUT/party/parties/{partyId}/sourceOfFunds

Sample URL
http://localhost:8004/ms-duediligence-api/api/v1.0.0/party/parties/{partyId}/sourceOfFunds
Request
{
  "sourceOfFunds": [
    {
      "sourceOfFundsReference": "FUND20355YT56J",
      "sourceName": "Bill Gates",
      "purpose": "CapitalIncrease",
      "fundsCountry": "USA",
      "fundsCurrency": "USD",
      "fundsRange": "",
      "fundsAmount": 10,
      "fundsFrequency": "Yearly",
      "isSourceVerified": true,
      "comments": "",
      "extensionData": {}
    }
  ]
}
Response
{
  "sourceOfFundsReference": "FUND20355YT56J",
  "status": "Success",
  "message": "Completed Successfully"
}
GET SOURCE OF FUND DATA
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.

GET/party/parties/{partyId}/sourceOfFunds

Sample URL
http://localhost:8004/ms-duediligence-api/api/v1.0.0/party/parties/{partyId}/sourceOfFunds?sourceOfFundsReference={sourceOfFundsReference}
Response
{
  "sourceOfFunds": [
    {
      "partyId": "200722894",
      "sourceOfFundsReference": "FUND20355YT56J",
      "fundsType": "Capital",
      "fundsSource": "Investor",
      "sourceName": "Bill Gates",
      "purpose": "CapitalIncrease",
      "fundsCountry": "USA",
      "fundsCurrency": "USD",
      "fundsRange": "",
      "fundsAmount": 10,
      "fundsFrequency": "Yearly",
      "isSourceVerified": true,
      "comments": "",
      "extensionData": {}
    }
  ]
}
CREATE INTENTION FOR A PARTY
This API is used to create intention for a party.

POST/party/parties/{partyId}/intentions

Sample URL
http://localhost:8004/ms-duediligence-api/api/v1.0.0/party/parties/{partyId}/intentions
Request
{
  "intentions": [
    {
      "productNature": "Accounts",
      "transactionType": "InternationalPayments",
      "source": "Onboarding",
      "sourceDate": "2020-09-26",
      "purpose": "PaySalaries",
      "intendedTransactionCountry": "UK",
      "estimatedVolumeCurrency": "GBP",
      "estimatedVolume": 50000,
      "estimatedTransactionNumber": 20,
      "frequency": "Monthly",
      "comments": "",
      "extensionData": {}
    }
  ]
}
Response
{
  "intentionReference": "INTN20355YT56J",
  "status": "Success",
  "message": "Completed Successfully"
}
UPDATE INTENTION DATA
This API is used to update the intention details of a party.

PUT/party/parties/{partyId}/intentions

Sample URL
http://localhost:8004/ms-duediligence-api/api/v1.0.0/party/parties/{partyId}/intentions
Request
{
  "intentions": [
    {
      "intentionsReference": "INTN20355YT56J",
      "purpose": "PaySalaries",
      "intendedTransactionCountry": "UK",
      "estimatedVolumeCurrency": "GBP",
      "estimatedVolume": 50000,
      "estimatedTransactionNumber": 20,
      "frequency": "Monthly",
      "comments": "",
      "extensionData": {}
    }
  ]
Response
{
  "intentionReference": "INTN20355YT56J",
  "status": "Success",
  "message": "Completed Successfully"
}
GET INTENTION DATA
This API is used to retrieve all the recorded intentions of a party.

GET/party/parties/{partyId}/intentions

Sample URL
http://localhost:8004/ms-duediligence-api/api/v1.0.0/party/parties/{partyId}/intentions
Response
{
  "intentions": [
    {
      "partyId": "200722894",
      "intentionsReference": "INTN20355YT56J",
      "productNature": "",
      "transactionType": "InternationalPayments",
      "source": "Onboarding",
      "sourceDate": "",
      "purpose": "PaySalaries",
      "intendedTransactionCountry": "UK",
      "estimatedVolumeCurrency": "GBP",
      "estimatedVolume": 50000,
      "estimatedTransactionNumber": 20,
      "frequency": "Monthly",
      "comments": "",
      "extensionData": {}
    }
  ]
}
CREATE A NEW FINANCIAL INFORMATION
This API creates a new financial information record.

POST/party/parties/{partyId}/financialInformations

Sample URL
http://localhost:8004/ms-duediligence-api/api/v1.0.0/party/parties/{partyId}/financialInformations
Request
{
  "financialInformations": [
    {
      "financialType": "Profit",
      "realisedInYear": 2019,
      "currency": "EUR",
      "estimateForNextYear": 10,
      "realisedAmount": 50,
      "comments": "",
      "realisedCountryDetails": [
        {
          "realisedCountry": "Denmark",
          "realisedCountryPercentage": 15,
          "extensionData": {}
        }
      ],
      "extensionData": {}
    }
  ]
}
Response
{
  "partyId": "2012345678",
  "status": "Success",
  "message": "Completed Successfully"
}
UPDATE FINANCIAL INFORMATION
This API updates a financial information record.

PUT/party/parties/{partyId}/financialInformations

Sample URL
http://localhost:8004/ms-duediligence-api/api/v1.0.0/party/parties/{partyId}/financialInformations
Request
{
  "financialInformations": [
    {
      "financialType": "Profit",
      "realisedInYear": 2019,
      "currency": "EUR",
      "estimateForNextYear": 10,
      "realisedAmount": 50,
      "comments": "",
      "realisedCountryDetails": [
        {
          "realisedCountry": "Denmark",
          "realisedCountryPercentage": 15,
          "extensionData": {}
        }
      ],
      "extensionData": {}
    }
  ]
}
Response
{
  "partyId": "2012345678",
  "status": "Success",
  "message": "Completed Successfully"
}
GET FINANCIAL INFORMATION
This API is used to retrieve financial information based on selection criteria.

GET/party/parties/{partyId}/financialInformations

Sample URL
http://localhost:8004/ms-duediligence-api/api/v1.0.0/party/parties/{partyId}/financialInformations
Response
{
  "financialInformations": [
    {
      "partyId": "200722894",
      "financialType": "Profit",
      "realisedInYear": 2019,
      "currency": "USD",
      "estimateForNextYear": 10,
      "realisedAmount": 50,
      "comments": "",
      "realisedCountryDetails": [
        {
          "realisedCountry": "Denmark",
          "realisedCountryPercentage": 15,
          "extensionData": {}
        }
      ],
      "extensionData": {}
    }
  ]
}
CREATE REFERENCE TYPE
This API is used to create a reference type based on given details.

POST/reference/references/dueDiligence

Sample URL
http://localhost:8004/ms-duediligence-api/api/v1.0.0/reference/references/dueDiligence
Request
{
  "references": {
    "Country": [
      {
        "countryCode": "US",
        "countryName": "United States",
        "numericCountryCode": 1,
        "alpha3CountryCode": "USA",
        "highRiskCountry": true,
        "iddPrefix": 1
      }
    ]
  }
}
Response
{
  "id": "Country",
  "status": "Success",
  "message": "Completed Successfully"
}
GET THE LIST OF DYNAMIC REFERENCE DATA
This API is used to retrieve the list of dynamic reference data for a given reference data type.

GET/reference/references/dueDiligence

Sample URL
http://localhost:8004/ms-duediligence-api/api/v1.0.0/reference/references/dueDiligence?type={type}
Response
{
  "references": {
    "Country": [
      {
        "id": "US",
        "countryCode": "US",
        "countryName": "United States",
        "numericCountryCode": 1,
        "alpha3CountryCode": "USA",
        "highRiskCountry": true,
        "iddPrefix": 1
      }
    ]
  }
}
UPDATE REFERENCE DATA
This API is used to update the reference data's description of the given reference details.

PUT/reference/references/dueDiligence

Sample URL
http://localhost:8004/ms-duediligence-api/api/v1.0.0/reference/references/dueDiligence
Request
{
  "references": {
    "Country": [
      {
        "countryCode": "US",
        "countryName": "United States",
        "numericCountryCode": 1,
        "alpha3CountryCode": "USA",
        "highRiskCountry": true,
        "iddPrefix": 1
      }
    ]
  }
}
Response
{
  "id": "Country",
  "status": "Success",
  "message": "Completed Successfully"
}
CREATE REFERENCE DATA
This API is used to create reference data for the existing reference type provided.

POST/reference/dueDiligence/{referenceType}

Sample URL
http://localhost:8004/ms-duediligence-api/api/v1.0.0/reference/dueDiligence/{referenceType}
Request
{
  "references": {
    "Country": [
      {
        "countryCode": "US",
        "countryName": "United States",
        "numericCountryCode": 1,
        "alpha3CountryCode": "USA",
        "highRiskCountry": true,
        "iddPrefix": 1
      }
    ]
  }
}
Response
{
  "id": "Country",
  "status": "Success",
  "message": "Completed Successfully"
}
DELETE REFERENCE DATA
This API is used to delete the reference data based on given reference data type and value.

DELETE/reference/dueDiligence/{referenceType}

Sample URL
http://localhost:8004/ms-duediligence-api/api/v1.0.0/reference/dueDiligence/{referenceType}?referenceId={referenceId}
Response
{

  "id": "Country",
  "status": "Success",
  "message": "Completed Successfully"
}

Bookmark Name Actions
BACK

In this topic

Feedback
x

Are you sure you want to log-off?