4.4 Trusted Pairs
This service allows Behavior Detection Framework (BDF) to consume trusted pair information present within ECM.
This API will have non-mandatory inputs. If these inputs are provided, they will be used to filter data. If these inputs are not provided full data will be loaded as JSON output.
The following topics explain how to configure and use the Trusted Pair information:
- HTTP Link
- Service Type
- Request Parameters/Non-Mandatory Inputs
- Request JSON Sample
- Response Parameters
- Response JSON Sample
HTTP Link
http://<ApplicationURL>/rest-api/CMRestService/TrustedPairsListRestService/getTrustedPairsList
Service Type
The service type is POST.
Request Parameters and Non-Mandatory Inputs
The following table describes the details of the parameters.
Table 4-7 Trusted Pairs - Request Parameters/Non-Mandatory Inputs
| First Level | Details |
|---|---|
| From and To Date | DD/MM/YYYY is the Expected Date format. This will be filtered against the Created date of the Trusted pair. |
| Jurisdiction | This is filtered against the party Jurisdiction. A Trusted Pair Record will be retrieved if it matches the Jurisdiction of any one of the parties present in a Trusted pair record. |
| Business Domain | This is filtered against the party Business domain. A Trusted Pair Record will be retrieved if it matches the Business Domain of any one of the parties present in a Trusted pair record. |
Request JSON Sample
This section contains a request JSON sample to get Trusted Pair information. The entries in this sample are only for reference purposes..
{
"domain" :"adc",
"jurisdiction" : "AMEA,IND",
"fromDate": "08/02/2022",
"toDate":"17/02/2022"
}Response Parameters
The following table describes the details of the response
parameters.
Note:
The API response is in a String format.Table 4-8 Trusted Pairs - Response Parameters
| Business Name | API Response Data Element | Description | Data Type and Length |
|---|---|---|---|
| Trusted pair Code | tpCode | For ECM created Trusted Pairs, this is the same as Trusted pair Seq(running seq). This column is added to support the Third party Trusted pairs in the future. | String (100) |
| Trusted pair Sequence ID | tpSeqId | Displays Running Sequence | Number (10) |
| Trusted Pair Created ID | tpCreateId | Displays ID of the user who requested the Trust. It is a number. | Number (10) |
| Trusted Pair Created Date | tpCreateDate | Displays Date on which Trust request happened | Date |
| Expiration Date | tpExprnDate | Displays the Expiration date of the Trust record | Date |
| Status Code | tpStatusCode | Displays out-of-box statuses present in FCC_TP_STATUS table in ECM. But the client can configure their own statuses. F_ACTIVE_FL denotes the Statuses in which a Trust record is Active. F_SHARED_FL denotes the statuses of Trust Records, which will be moved to BD. | - |
| Event Code | tpEventCode | Displays the Event Code for which they identified the parties from transactions | Number (22) |
| Case ID | tpCaseId | Displays the case id which was used to create the trusted pair | String (15) |
| Trusted pair Member Sequence ID | tpMbrSeqId | Displays Running Sequence | Number (10) |
| Party1 Sequence | tpMbrParty1Se q | In case of External Entity External Entity Sequence will be passed. Else “” will be passed. | String (30) |
| Party1 ID | tpMbrParty1Id | Displays External Entity ID/Account ID | String (50) |
| Party1 ID type | tpMbrParty1Ty peCd | Displays Internal Account (one of IA, GL) and External Entity(one of XA, CC, CO, DL, GM, GP, LE, MC, ND, NR, PP, SS, TX, AR, OT, IBAN) | String (20) |
| Party1 Name | tpMbrParty1N m | Displays External Entity/Account Name | String (350) |
| Party1 Risk | tpMbrParty1Ri skNb | Displays External Entity/Account Risk | Number (3) |
| Party1 Jurisdiction | tpMbrParty1Jr sdcnCd | Displays Jurisdiction of External Entity /Account | String (5) |
| Party1 Business domain | tpMbrParty1B usDmn | Displays Business domain of External Entity /Account | String (65) |
| Party2 Sequence | tpMbrParty2S eq | In case of External Entity External Entity Sequence will be passed. Else “” will be passed. | String (30) |
| Party2 ID | tpMbrParty2Id | Displays External Entity ID/Account ID | String (50) |
| Party2 ID type | tpMbrParty2T ypeCd | Displays Internal Account (one of IA,GL) and External Entity (one of XA,CC,CO,DL,GM,GP,LE,MC,ND,NR,PP,SS,TX,AR,OT,IB AN) | String (20) |
| Party2 Name | tpMbrParty2N m | Displays External Entity/Account Name | String (350) |
| Party2 Risk | tpMbrParty2Ri skNb | Displays External Entity /Account Risk | Number (3) |
| Party2 Jurisdiction | tpMbrParty2Jr sdcnCd | Displays Jurisdiction of External Entity /Account | String (5) |
| Party2 Business domain | tpMbrParty2B usDmn | Displays Business domain of External Entity /Account | String (65) |
| Direction | tpDirnCd | Out of box displays values SEND, RECEIVE, BOTH | String (7) |
| Last Modified by | tpReviewerId | Displays Reviewer ID. It is a number. | Number (10) |
| Last Modified date | tpReviewDate | Displays Review Date | Date |
| Last Comment | tpReviewComment | Displays Review Reason | String (2500) |
Response JSON Sample
This section contains a response JSON sample to get Trusted Pair
information. The entries in this sample are only for reference
purposes.
{
"tpCode": "101",
"tpSeqId": "101",
"tpCreateId": "10008",
"tpCreateDate": "2022-02-17 15:11:20",
"tpExprnDate": "2022-08-18 18:29:59",
"tpStatusCode": "TPAPP",
"tpEventCode": "4450,4468",
"tpCaseId": "CA125",
"tpMbrSeqId": "101",
"tpMbrParty1Seq": " ",
"tpMbrParty1Id": "ACRMLACACTRSTAC-01",
"tpMbrParty1Nm": "SAPNA GOBA",
"tpMbrParty1TypeCd": "IA",
"tpMbrParty1RiskNb": "9",
"tpMbrParty1JrsdcnCd": "AMEA",
"tpMbrParty1BusDmn": "d",
"tpMbrParty2Seq": "100157",
"tpMbrParty2Id": "ACRMFALACTRSTAC-01X",
"tpMbrParty2Nm": " ",
"tpMbrParty2TypeCd": "XA",
"tpMbrParty2RiskNb": "0",
"tpMbrParty2JrsdcnCd": "AMEA",
"tpMbrParty2BusDmn": "a",
"tpDirnCd": "SEND",
"tpReviewerId": "10004",
"tpReviewDate": "2022-02-18 07:40:54",
"tpReviewComment": "Test Comments"
}