Class DowJonesSDK

The DowJonesSDK class can be used as follows:

Using your service account details Call DowJonesSDK.getAuthNToken(..) -> get the 'id_token'
Use the 'id_token' in 1. to call DowJonesSDK.getAuthZToken(..) -> store this result in your DB use 'access_token' as input to new DowJonesSDK(..);
When the access_token expires, refresh it:

DowJonesSDK.refreshAuthZToken(..) -> Update the db value of token

Example

 import { DowJonesSDK } from "dj-sdk";

 const { id_token } = await DowJonesSDK.getAuthNToken({
   client_id: 'client_id_from_service_account',
   username: 'service_account_username',
   password: 'service_account_password'
 });

 const response = await DowJonesSDK.getAuthZToken({
   client_id: 'client_id_from_service_account',
   id_token,
 });


 // Store so the access_token can be
 // reused for future calls
 // (until it expires)
 await saveToDatabase(response);

 const sdk = new DowJonesSDK({
   access_token: response.access_token,
 });

 const associations = await sdk.listAssociations();

Hierarchy

DowJonesSDK

Constructors

constructor

new DowJonesSDK(options): DowJonesSDK
Parameters
- options: {
  accessToken: string;
  }
  - accessToken: string
Returns DowJonesSDK
- Defined in src/sdk.ts:626

Properties

`Private` client

client: Client

Methods

addAssociation

addAssociation<T>(input): Promise<DowJonesAddAssociationResponse<T["data"]["attributes"]["record_type"]>>
Type Parameters
- T extends {
      data: { attributes: { record_type: "PERSON"; names: { name_type: "PRIMARY" | "MAIDEN" | "SV" | "ELV" | "AKA" | "LQAKA" | "FKA" | "SSN" | "OSN"; first_name?: string | undefined; single_string_name?: string | undefined; middle_name?: string | undefined; last_name?: string | undefined; prefix?: string | undefined; suffix?: s...;
  } | {
      data: { attributes: { record_type: "ENTITY"; names: { name_type: "PRIMARY" | "MAIDEN" | "SV" | "ELV" | "AKA" | "LQAKA" | "FKA" | "SSN" | "OSN"; entity_name?: string | undefined; single_string_name?: string | undefined; prefix?: string | undefined; suffix?: string | undefined; }[]; ... 4 more ...; timestamp?: string | unde...;
  } | {
      data: { attributes: { record_type: "UNKNOWN"; names: { name_type?: "PRIMARY" | "MAIDEN" | "SV" | "ELV" | "AKA" | "LQAKA" | "FKA" | "SSN" | "OSN" | undefined; first_name?: string | undefined; single_string_name?: string | undefined; ... 4 more ...; entity_name?: string | undefined; }[]; external_id?: string | undefined; id...;
  }
Parameters
- input: T
Returns Promise<DowJonesAddAssociationResponse<T["data"]["attributes"]["record_type"]>>
- Defined in src/sdk.ts:781

addAssociationsToCase

addAssociationsToCase(input): Promise<DowJonesAddCaseWithAssociationsResponse>
Creates a batch of associations and correlates them with the given case.

Returns the transaction ID object
Parameters
- input: {
  case_id: string;
  data: { attributes: { associations: ({ record_type: "PERSON"; names: { name_type: "PRIMARY" | "MAIDEN" | "SV" | "ELV" | "AKA" | "LQAKA" | "FKA" | "SSN" | "OSN"; first_name?: string | undefined; ... 4 more ...; suffix?: string | undefined; }[]; ... 6 more ...; timestamp?: string | undefined; } | { ...; } | { ...; })[]; }; ...;
  }
  - case_id: string
  - data: { attributes: { associations: ({ record_type: "PERSON"; names: { name_type: "PRIMARY" | "MAIDEN" | "SV" | "ELV" | "AKA" | "LQAKA" | "FKA" | "SSN" | "OSN"; first_name?: string | undefined; ... 4 more ...; suffix?: string | undefined; }[]; ... 6 more ...; timestamp?: string | undefined; } | { ...; } | { ...; })[]; }; ...
Returns Promise<DowJonesAddCaseWithAssociationsResponse>
- Defined in src/sdk.ts:966

addBulkMatchesFeedback

addBulkMatchesFeedback(input): Promise<DowJonesAddBulkMatchesFeedbackResponse>
Parameters
- input: {
  case_id: string;
  data: ({ attributes: { comment?: string | undefined; current_state?: "OPEN" | "CLEARED" | "PERMANENTLY_CLEARED" | "CONFIRMED" | "CONFIRMED_BLOCKED" | "CONFIRMED_UNDER_REVIEW" | "CONFIRMED_RISK_MITIGATED" | undefined; match_id?: string | undefined; risk_rating?: number | undefined; timestamp?: string | undefined; }; id: str...)[];
  }
  - case_id: string
  - data: ({ attributes: { comment?: string | undefined; current_state?: "OPEN" | "CLEARED" | "PERMANENTLY_CLEARED" | "CONFIRMED" | "CONFIRMED_BLOCKED" | "CONFIRMED_UNDER_REVIEW" | "CONFIRMED_RISK_MITIGATED" | undefined; match_id?: string | undefined; risk_rating?: number | undefined; timestamp?: string | undefined; }; id: str...)[]
Returns Promise<DowJonesAddBulkMatchesFeedbackResponse>
- Defined in src/sdk.ts:1138

addCase

addCase(input): Promise<DowJonesAddCaseResponse>
Parameters
- input: {
  data: { attributes: { options: { search_type: "PRECISE" | "NEAR" | "BROAD"; filter_content_category: ("PEP" | "SL" | "OOL" | "OEL" | "SIP" | "WL" | "SOC" | "AME" | { WL?: { PEP?: string[] | undefined; SL?: string[] | undefined; OOL?: string[] | undefined; OEL?: string[] | undefined; SIP?: string[] | undefined; }[] | undef...;
  }
  - data: { attributes: { options: { search_type: "PRECISE" | "NEAR" | "BROAD"; filter_content_category: ("PEP" | "SL" | "OOL" | "OEL" | "SIP" | "WL" | "SOC" | "AME" | { WL?: { PEP?: string[] | undefined; SL?: string[] | undefined; OOL?: string[] | undefined; OEL?: string[] | undefined; SIP?: string[] | undefined; }[] | undef...
Returns Promise<DowJonesAddCaseResponse>
- Defined in src/sdk.ts:918

addCaseWithAssociations

addCaseWithAssociations(input): Promise<DowJonesAddCaseWithAssociationsResponse>
Adds a new case and bulk creates given associations inline.

Returns the transaction ID object
Parameters
- input: {
  data: { attributes: { case_info: { options: { search_type: "PRECISE" | "NEAR" | "BROAD"; filter_content_category: ("PEP" | "SL" | "OOL" | "OEL" | "SIP" | "WL" | "SOC" | "AME" | { WL?: { PEP?: string[] | undefined; SL?: string[] | undefined; OOL?: string[] | undefined; OEL?: string[] | undefined; SIP?: string[] | undefined...;
  }
  - data: { attributes: { case_info: { options: { search_type: "PRECISE" | "NEAR" | "BROAD"; filter_content_category: ("PEP" | "SL" | "OOL" | "OEL" | "SIP" | "WL" | "SOC" | "AME" | { WL?: { PEP?: string[] | undefined; SL?: string[] | undefined; OOL?: string[] | undefined; OEL?: string[] | undefined; SIP?: string[] | undefined...
Returns Promise<DowJonesAddCaseWithAssociationsResponse>
- Defined in src/sdk.ts:941

addExistingAssociationsToCase

addExistingAssociationsToCase(input): Promise<DowJonesAddExsistingAssociationsToCaseResponse>
Parameters
- input: {
  case_id: string;
  data: ({ id: string; type?: string | undefined; })[];
  }
  - case_id: string
  - data: ({ id: string; type?: string | undefined; })[]
Returns Promise<DowJonesAddExsistingAssociationsToCaseResponse>
- Defined in src/sdk.ts:1184

addMatchFeedback

addMatchFeedback(input): Promise<DowJonesAddMatchFeedbackResponse>
Parameters
- input: {
      case_id: string;
      data: { attributes: { comment?: string | undefined; current_state?: "OPEN" | "CLEARED" | "PERMANENTLY_CLEARED" | "CONFIRMED" | "CONFIRMED_BLOCKED" | "CONFIRMED_UNDER_REVIEW" | "CONFIRMED_RISK_MITIGATED" | undefined; match_id?: string | undefined; risk_rating?: number | undefined; timestamp?: string | undefined; }; type?: ...;
      match_id: string;
  }
  - case_id: string
  - data: { attributes: { comment?: string | undefined; current_state?: "OPEN" | "CLEARED" | "PERMANENTLY_CLEARED" | "CONFIRMED" | "CONFIRMED_BLOCKED" | "CONFIRMED_UNDER_REVIEW" | "CONFIRMED_RISK_MITIGATED" | undefined; match_id?: string | undefined; risk_rating?: number | undefined; timestamp?: string | undefined; }; type?: ...
  - match_id: string
Returns Promise<DowJonesAddMatchFeedbackResponse>
- Defined in src/sdk.ts:1115

decorrelateAssociationFromCase

decorrelateAssociationFromCase(input): Promise<DowJonesAddExsistingAssociationsToCaseResponse>
Parameters
- input: {
  association_id: string;
  case_id: string;
  }
  - association_id: string
  - case_id: string
Returns Promise<DowJonesAddExsistingAssociationsToCaseResponse>
- Defined in src/sdk.ts:1232

decorrelateAssociationsFromCase

decorrelateAssociationsFromCase(input): Promise<DowJonesAddExsistingAssociationsToCaseResponse>
Parameters
- input: {
  case_id: string;
  data: ({ id: string; type?: string | undefined; })[];
  }
  - case_id: string
  - data: ({ id: string; type?: string | undefined; })[]
Returns Promise<DowJonesAddExsistingAssociationsToCaseResponse>
- Defined in src/sdk.ts:1208

deleteAssociationById

deleteAssociationById(input): Promise<void>
Parameters
- input: {
  id: string;
  }
  - id: string
Returns Promise<void>
- Defined in src/sdk.ts:832

deleteCaseById

deleteCaseById(input): Promise<void>
Parameters
- input: {
  case_id: string;
  }
  - case_id: string
Returns Promise<void>
- Defined in src/sdk.ts:1048

getAssociationById

getAssociationById<T>(input): Promise<DowJonesGetAssociationByIdResponse<T>>
Type Parameters
- T extends "PERSON" | "ENTITY" | "UNKNOWN"
Parameters
- input: {
  id: string;
  }
  - id: string
Returns Promise<DowJonesGetAssociationByIdResponse<T>>
- Defined in src/sdk.ts:813

getBulkTransactionStatus

getBulkTransactionStatus(input): Promise<DowJonesGetBulkTransactionStatusResponse>
Gets the status of a bulk transaction. For example:
Parameters
- input: {
      case_id: string;
      limit?: number;
      page?: number;
      transaction_id: string;
  }
  - case_id: string
  - Optional limit?: number
  - Optional page?: number
  - transaction_id: string
Returns Promise<DowJonesGetBulkTransactionStatusResponse>
Example
```
const { data } = await addCaseWithAssociations(input);

const status = await getTransactionStatus({
  transaction_id: data.id,
  case_id: data.attributes.case_id,
})
```
- Defined in src/sdk.ts:1000

getCaseById

getCaseById(input): Promise<DowJonesGetCaseByIdResponse>
Parameters
- input: {
  case_id: string;
  }
  - case_id: string
Returns Promise<DowJonesGetCaseByIdResponse>
- Defined in src/sdk.ts:1029

getMatches

getMatches(input): Promise<DowJonesGetMatchesResponse>
Parameters
- input: {
      associationId?: string;
      case_id: string;
      limit?: number;
      page?: number;
  }
  - Optional associationId?: string
  - case_id: string
  - Optional limit?: number
  - Optional page?: number
Returns Promise<DowJonesGetMatchesResponse>
- Defined in src/sdk.ts:1084

getTransactionStatusByCaseIdAndId

getTransactionStatusByCaseIdAndId(input): Promise<DowJonesGetTransactionStatusByCaseIdAndIdResponse>
Gets the status of a bulk transaction by case ID and transaction ID
Parameters
- input: {
      case_id: string;
      limit?: number;
      page?: number;
      transaction_id: string;
  }
  - case_id: string
  - Optional limit?: number
  - Optional page?: number
  - transaction_id: string
Returns Promise<DowJonesGetTransactionStatusByCaseIdAndIdResponse>
- Defined in src/sdk.ts:1260

getTransactionStatusById

getTransactionStatusById(input): Promise<DowJonesGetTransactionStatusByIdResponse>
Parameters
- input: {
  transaction_id: string;
  }
  - transaction_id: string
Returns Promise<DowJonesGetTransactionStatusByIdResponse>
- Defined in src/sdk.ts:1289

listAssociations

listAssociations(input?): Promise<DowJonesListAssociationsResponse<"PERSON"> | DowJonesListAssociationsResponse<"ENTITY"> | DowJonesListAssociationsResponse<"UNKNOWN">>
Lists all associations related to your service account, accepts optional pagination.
Parameters
- Optional input: {
  limit?: number;
  page?: number;
  }
  The optional pagination options
  - Optional limit?: number
    How many items to return in the response
  - Optional page?: number
    The page number to start at
Returns Promise<DowJonesListAssociationsResponse<"PERSON"> | DowJonesListAssociationsResponse<"ENTITY"> | DowJonesListAssociationsResponse<"UNKNOWN">>
A list of associations for types ENTITY, PERSON, UNKNOWN
- Defined in src/sdk.ts:755

listAssociationsByCaseId

listAssociationsByCaseId(input): Promise<DowJonesListAssociationsByCaseIdResponse>
Parameters
- input: {
      case_id: string;
      limit?: number;
      page?: number;
  }
  - case_id: string
  - Optional limit?: number
  - Optional page?: number
Returns Promise<DowJonesListAssociationsByCaseIdResponse>
- Defined in src/sdk.ts:1157

listCases

listCases(input?): Promise<DowJonesListCasesResponse>
Parameters
- Optional input: {
  limit?: number;
  page?: number;
  }
  - Optional limit?: number
  - Optional page?: number
Returns Promise<DowJonesListCasesResponse>
- Defined in src/sdk.ts:897

updateAssociationById

updateAssociationById<T>(input): Promise<DowJonesUpdateAssociationByIdResponse<T["input"]["record_type"]>>
Type Parameters
- T extends {
      id: string;
      input: {
          country?: "ABKHAZ" | "AFGH" | "ALB" | "ALG" | "AMSAM" | "ANDO" | "ANGOL" | "ANGUIL" | "AARCT" | "ANTA" | "ARG" | "ARMEN" | "ARUBA" | "AUSTR" | "AUST" | "AZERB" | "BAH" | "BAHRN" | "BANDH" | "BARB" | "BYELRS" | "BELG" | "BELZ" | "BENIN" | "BERM" | "BHUTAN" | "BOL" | "BSHZG" | "BOTS" | "BOUV" | "BRAZ" | "BIOT" | "BVI" | "BRUNEI" | "BUL" | "UPVOLA" | "BURUN" | "KAMPA" | "CAMER" | "CANA" | "CVI" | "CAYI" | "CAFR" | "CHAD" | "CHIL" | "CHINA" | "CHR" | "COCOS" | "COL" | "COMOR" | "CONGO" | "COOKIS" | "COSR" | "ICST" | "CRTIA" | "CUBA" | "NANT" | "CYPR" | "CZREP" | "ZAIRE" | "DEN" | "TAI" | "DOMA" | "DOMR" | "ECU" | "EGYPT" | "ELSAL" | "EQGNA" | "ERTRA" | "ESTNIA" | "SWAZD" | "ETHPA" | "FALK" | "FAEROE" | "FIJI" | "FIN" | "FRA" | "FGNA" | "FPOLY" | "GABON" | "GAMB" | "GRGIA" | "GFR" | "GHANA" | "GIB" | "GREECE" | "GREENL" | "GREN" | "GUAD" | "GUAM" | "GUAT" | "GUERN" | "GUREP" | "GUBI" | "GUY" | "HAIT" | "HEARD" | "HON" | "HKONG" | "HUNG" | "ICEL" | "INDIA" | "INDON" | "IRAN" | "IRAQ" | "IRE" | "ISLEOM" | "ISRAEL" | "ITALY" | "JAMA" | "JAP" | "JERSEY" | "JORDAN" | "KAZK" | "KENYA" | "KIRB" | "KOSOVO" | "KUWAIT" | "KIRGH" | "LAOS" | "LATV" | "LEBAN" | "LESOT" | "LIBER" | "LIBYA" | "LIECHT" | "LITH" | "LUX" | "MACAO" | "MALAG" | "MALAW" | "MALAY" | "MALDR" | "MALI" | "MALTA" | "MAH" | "MARQ" | "MAURTN" | "MAURTS" | "MAYOT" | "MEX" | "FESMIC" | "MOLDV" | "MONAC" | "MONGLA" | "MNTNG" | "MONT" | "MOROC" | "MOZAM" | "BURMA" | "NAMIB" | "NAURU" | "NEPAL" | "NETH" | "NEWCAL" | "NZ" | "NICG" | "NIGER" | "NIGEA" | "NIUE" | "NORFIS" | "NKOREA" | "MCDNIA" | "NOMARI" | "NORW" | "NOTK" | "OMAN" | "PAKIS" | "PALAU" | "PALEST" | "PANA" | "PAPNG" | "PARA" | "PERU" | "PHLNS" | "PITCIS" | "POL" | "PORL" | "PURI" | "QATAR" | "REUNI" | "ROM" | "RUSS" | "RWANDA" | "SBRTHY" | "SLUC" | "WSOMOA" | "SMARNO" | "PST" | "SAARAB" | "SENEG" | "YUG" | "SEYCH" | "SILEN" | "SINGP" | "SLVAK" | "SLVNIA" | "SOLIL" | "SOMAL" | "SAFR" | "SGSSI" | "SKOREA" | "SOSSRT" | "SOUSUD" | "SPAIN" | "SRILAN" | "STHEL" | "SKIT" | "SINTMA" | "STMART" | "STPM" | "SVIN" | "SUDAN" | "SURM" | "SVALB" | "SWED" | "SWITZ" | "SYRIA" | "TAIWAN" | "TADZK" | "TANZA" | "THAIL" | "TIMOR" | "TOGO" | "TOKLAU" | "TONGA" | "TRTO" | "TUNIS" | "TURK" | "TURNC" | "TURKM" | "TCAI" | "TVLU" | "VI" | "UGANDA" | "UKRN" | "UAE" | "UK" | "USA" | "URU" | "UZBK" | "VANU" | "VCAN" | "VEN" | "VIETN" | "WALLIS" | "SPSAH" | "YEMAR" | "ZAMBIA" | "ZIMBAB";
          external_id?: string;
          gender?: "MALE" | "FEMALE";
          identification_details?: { type: string; value: string; };
          is_deceased?: boolean;
          names?: ({ name_type: "PRIMARY" | "MAIDEN" | "SV" | "ELV" | "AKA" | "LQAKA" | "FKA" | "SSN" | "OSN"; first_name?: string | undefined; single_string_name?: string | undefined; middle_name?: string | undefined; last_name?: string | undefined; prefix?: string | undefined; suffix?: string | undefined; })[];
          record_type: "PERSON" | "ENTITY" | "UNKNOWN";
          year_of_birth?: number;
      };
      type?: string;
  } | {
      id: string;
      input: {
          country?: "ABKHAZ" | "AFGH" | "ALB" | "ALG" | "AMSAM" | "ANDO" | "ANGOL" | "ANGUIL" | "AARCT" | "ANTA" | "ARG" | "ARMEN" | "ARUBA" | "AUSTR" | "AUST" | "AZERB" | "BAH" | "BAHRN" | "BANDH" | "BARB" | "BYELRS" | "BELG" | "BELZ" | "BENIN" | "BERM" | "BHUTAN" | "BOL" | "BSHZG" | "BOTS" | "BOUV" | "BRAZ" | "BIOT" | "BVI" | "BRUNEI" | "BUL" | "UPVOLA" | "BURUN" | "KAMPA" | "CAMER" | "CANA" | "CVI" | "CAYI" | "CAFR" | "CHAD" | "CHIL" | "CHINA" | "CHR" | "COCOS" | "COL" | "COMOR" | "CONGO" | "COOKIS" | "COSR" | "ICST" | "CRTIA" | "CUBA" | "NANT" | "CYPR" | "CZREP" | "ZAIRE" | "DEN" | "TAI" | "DOMA" | "DOMR" | "ECU" | "EGYPT" | "ELSAL" | "EQGNA" | "ERTRA" | "ESTNIA" | "SWAZD" | "ETHPA" | "FALK" | "FAEROE" | "FIJI" | "FIN" | "FRA" | "FGNA" | "FPOLY" | "GABON" | "GAMB" | "GRGIA" | "GFR" | "GHANA" | "GIB" | "GREECE" | "GREENL" | "GREN" | "GUAD" | "GUAM" | "GUAT" | "GUERN" | "GUREP" | "GUBI" | "GUY" | "HAIT" | "HEARD" | "HON" | "HKONG" | "HUNG" | "ICEL" | "INDIA" | "INDON" | "IRAN" | "IRAQ" | "IRE" | "ISLEOM" | "ISRAEL" | "ITALY" | "JAMA" | "JAP" | "JERSEY" | "JORDAN" | "KAZK" | "KENYA" | "KIRB" | "KOSOVO" | "KUWAIT" | "KIRGH" | "LAOS" | "LATV" | "LEBAN" | "LESOT" | "LIBER" | "LIBYA" | "LIECHT" | "LITH" | "LUX" | "MACAO" | "MALAG" | "MALAW" | "MALAY" | "MALDR" | "MALI" | "MALTA" | "MAH" | "MARQ" | "MAURTN" | "MAURTS" | "MAYOT" | "MEX" | "FESMIC" | "MOLDV" | "MONAC" | "MONGLA" | "MNTNG" | "MONT" | "MOROC" | "MOZAM" | "BURMA" | "NAMIB" | "NAURU" | "NEPAL" | "NETH" | "NEWCAL" | "NZ" | "NICG" | "NIGER" | "NIGEA" | "NIUE" | "NORFIS" | "NKOREA" | "MCDNIA" | "NOMARI" | "NORW" | "NOTK" | "OMAN" | "PAKIS" | "PALAU" | "PALEST" | "PANA" | "PAPNG" | "PARA" | "PERU" | "PHLNS" | "PITCIS" | "POL" | "PORL" | "PURI" | "QATAR" | "REUNI" | "ROM" | "RUSS" | "RWANDA" | "SBRTHY" | "SLUC" | "WSOMOA" | "SMARNO" | "PST" | "SAARAB" | "SENEG" | "YUG" | "SEYCH" | "SILEN" | "SINGP" | "SLVAK" | "SLVNIA" | "SOLIL" | "SOMAL" | "SAFR" | "SGSSI" | "SKOREA" | "SOSSRT" | "SOUSUD" | "SPAIN" | "SRILAN" | "STHEL" | "SKIT" | "SINTMA" | "STMART" | "STPM" | "SVIN" | "SUDAN" | "SURM" | "SVALB" | "SWED" | "SWITZ" | "SYRIA" | "TAIWAN" | "TADZK" | "TANZA" | "THAIL" | "TIMOR" | "TOGO" | "TOKLAU" | "TONGA" | "TRTO" | "TUNIS" | "TURK" | "TURNC" | "TURKM" | "TCAI" | "TVLU" | "VI" | "UGANDA" | "UKRN" | "UAE" | "UK" | "USA" | "URU" | "UZBK" | "VANU" | "VCAN" | "VEN" | "VIETN" | "WALLIS" | "SPSAH" | "YEMAR" | "ZAMBIA" | "ZIMBAB";
          external_id?: string;
          identification_details?: { type: string; value: string; };
          industry_sector?: string;
          names?: ({ name_type: "PRIMARY" | "MAIDEN" | "SV" | "ELV" | "AKA" | "LQAKA" | "FKA" | "SSN" | "OSN"; entity_name?: string | undefined; single_string_name?: string | undefined; prefix?: string | undefined; suffix?: string | undefined; })[];
          record_type: "PERSON" | "ENTITY" | "UNKNOWN";
      };
      type?: string;
  } | {
      id: string;
      input: {
          country?: "ABKHAZ" | "AFGH" | "ALB" | "ALG" | "AMSAM" | "ANDO" | "ANGOL" | "ANGUIL" | "AARCT" | "ANTA" | "ARG" | "ARMEN" | "ARUBA" | "AUSTR" | "AUST" | "AZERB" | "BAH" | "BAHRN" | "BANDH" | "BARB" | "BYELRS" | "BELG" | "BELZ" | "BENIN" | "BERM" | "BHUTAN" | "BOL" | "BSHZG" | "BOTS" | "BOUV" | "BRAZ" | "BIOT" | "BVI" | "BRUNEI" | "BUL" | "UPVOLA" | "BURUN" | "KAMPA" | "CAMER" | "CANA" | "CVI" | "CAYI" | "CAFR" | "CHAD" | "CHIL" | "CHINA" | "CHR" | "COCOS" | "COL" | "COMOR" | "CONGO" | "COOKIS" | "COSR" | "ICST" | "CRTIA" | "CUBA" | "NANT" | "CYPR" | "CZREP" | "ZAIRE" | "DEN" | "TAI" | "DOMA" | "DOMR" | "ECU" | "EGYPT" | "ELSAL" | "EQGNA" | "ERTRA" | "ESTNIA" | "SWAZD" | "ETHPA" | "FALK" | "FAEROE" | "FIJI" | "FIN" | "FRA" | "FGNA" | "FPOLY" | "GABON" | "GAMB" | "GRGIA" | "GFR" | "GHANA" | "GIB" | "GREECE" | "GREENL" | "GREN" | "GUAD" | "GUAM" | "GUAT" | "GUERN" | "GUREP" | "GUBI" | "GUY" | "HAIT" | "HEARD" | "HON" | "HKONG" | "HUNG" | "ICEL" | "INDIA" | "INDON" | "IRAN" | "IRAQ" | "IRE" | "ISLEOM" | "ISRAEL" | "ITALY" | "JAMA" | "JAP" | "JERSEY" | "JORDAN" | "KAZK" | "KENYA" | "KIRB" | "KOSOVO" | "KUWAIT" | "KIRGH" | "LAOS" | "LATV" | "LEBAN" | "LESOT" | "LIBER" | "LIBYA" | "LIECHT" | "LITH" | "LUX" | "MACAO" | "MALAG" | "MALAW" | "MALAY" | "MALDR" | "MALI" | "MALTA" | "MAH" | "MARQ" | "MAURTN" | "MAURTS" | "MAYOT" | "MEX" | "FESMIC" | "MOLDV" | "MONAC" | "MONGLA" | "MNTNG" | "MONT" | "MOROC" | "MOZAM" | "BURMA" | "NAMIB" | "NAURU" | "NEPAL" | "NETH" | "NEWCAL" | "NZ" | "NICG" | "NIGER" | "NIGEA" | "NIUE" | "NORFIS" | "NKOREA" | "MCDNIA" | "NOMARI" | "NORW" | "NOTK" | "OMAN" | "PAKIS" | "PALAU" | "PALEST" | "PANA" | "PAPNG" | "PARA" | "PERU" | "PHLNS" | "PITCIS" | "POL" | "PORL" | "PURI" | "QATAR" | "REUNI" | "ROM" | "RUSS" | "RWANDA" | "SBRTHY" | "SLUC" | "WSOMOA" | "SMARNO" | "PST" | "SAARAB" | "SENEG" | "YUG" | "SEYCH" | "SILEN" | "SINGP" | "SLVAK" | "SLVNIA" | "SOLIL" | "SOMAL" | "SAFR" | "SGSSI" | "SKOREA" | "SOSSRT" | "SOUSUD" | "SPAIN" | "SRILAN" | "STHEL" | "SKIT" | "SINTMA" | "STMART" | "STPM" | "SVIN" | "SUDAN" | "SURM" | "SVALB" | "SWED" | "SWITZ" | "SYRIA" | "TAIWAN" | "TADZK" | "TANZA" | "THAIL" | "TIMOR" | "TOGO" | "TOKLAU" | "TONGA" | "TRTO" | "TUNIS" | "TURK" | "TURNC" | "TURKM" | "TCAI" | "TVLU" | "VI" | "UGANDA" | "UKRN" | "UAE" | "UK" | "USA" | "URU" | "UZBK" | "VANU" | "VCAN" | "VEN" | "VIETN" | "WALLIS" | "SPSAH" | "YEMAR" | "ZAMBIA" | "ZIMBAB";
          external_id?: string;
          identification_details?: { type: string; value: string; };
          names?: ({ name_type?: "PRIMARY" | "MAIDEN" | "SV" | "ELV" | "AKA" | "LQAKA" | "FKA" | "SSN" | "OSN" | undefined; first_name?: string | undefined; single_string_name?: string | undefined; middle_name?: string | undefined; last_name?: string | undefined; prefix?: string | undefined; suffix?: string | undefined; entity_name?: ...)[];
          record_type: "PERSON" | "ENTITY" | "UNKNOWN";
      };
      type?: string;
  }
Parameters
- input: T
Returns Promise<DowJonesUpdateAssociationByIdResponse<T["input"]["record_type"]>>
- Defined in src/sdk.ts:851

updateCaseById

updateCaseById(input): Promise<DowJonesUpdateCaseByIdResponse>
Parameters
- input: {
  case_id: string;
  data: { attributes: { options?: { search_type: "PRECISE" | "NEAR" | "BROAD"; filter_content_category: ("PEP" | "SL" | "OOL" | "OEL" | "SIP" | "WL" | "SOC" | "AME" | { WL?: { PEP?: string[] | undefined; SL?: string[] | undefined; OOL?: string[] | undefined; OEL?: string[] | undefined; SIP?: string[] | undefined; }[] | unde...;
  }
  - case_id: string
  - data: { attributes: { options?: { search_type: "PRECISE" | "NEAR" | "BROAD"; filter_content_category: ("PEP" | "SL" | "OOL" | "OEL" | "SIP" | "WL" | "SOC" | "AME" | { WL?: { PEP?: string[] | undefined; SL?: string[] | undefined; OOL?: string[] | undefined; OEL?: string[] | undefined; SIP?: string[] | undefined; }[] | unde...
Returns Promise<DowJonesUpdateCaseByIdResponse>
- Defined in src/sdk.ts:1065

validateBulkAssociations

validateBulkAssociations(input): Promise<DowJonesValidateBulkAssociationsResponse>
Validates that a Shortcut Case payload does not have validation errors. Returns a valid "status" and information about any errors that might be in the request
Parameters
- input: {
  data: { attributes: { case_info: { options: { search_type: "PRECISE" | "NEAR" | "BROAD"; filter_content_category: ("PEP" | "SL" | "OOL" | "OEL" | "SIP" | "WL" | "SOC" | "AME" | { WL?: { PEP?: string[] | undefined; SL?: string[] | undefined; OOL?: string[] | undefined; OEL?: string[] | undefined; SIP?: string[] | undefined...;
  }
  - data: { attributes: { case_info: { options: { search_type: "PRECISE" | "NEAR" | "BROAD"; filter_content_category: ("PEP" | "SL" | "OOL" | "OEL" | "SIP" | "WL" | "SOC" | "AME" | { WL?: { PEP?: string[] | undefined; SL?: string[] | undefined; OOL?: string[] | undefined; OEL?: string[] | undefined; SIP?: string[] | undefined...
Returns Promise<DowJonesValidateBulkAssociationsResponse>
- Defined in src/sdk.ts:1312

validateBulkAssociationsByCaseId

validateBulkAssociationsByCaseId(input): Promise<DowJonesValidateBulkAssociationsByCaseIdResponse>
Validates that a Shortcut Associations payload does not have validation errors. Returns a valid "status" and information about any errors that might be in the request
Parameters
- input: {
  case_id: string;
  data: { attributes: { associations: ({ record_type: "PERSON"; names: { name_type: "PRIMARY" | "MAIDEN" | "SV" | "ELV" | "AKA" | "LQAKA" | "FKA" | "SSN" | "OSN"; first_name?: string | undefined; ... 4 more ...; suffix?: string | undefined; }[]; ... 6 more ...; timestamp?: string | undefined; } | { ...; } | { ...; })[]; }; ...;
  }
  - case_id: string
  - data: { attributes: { associations: ({ record_type: "PERSON"; names: { name_type: "PRIMARY" | "MAIDEN" | "SV" | "ELV" | "AKA" | "LQAKA" | "FKA" | "SSN" | "OSN"; first_name?: string | undefined; ... 4 more ...; suffix?: string | undefined; }[]; ... 6 more ...; timestamp?: string | undefined; } | { ...; } | { ...; })[]; }; ...
Returns Promise<DowJonesValidateBulkAssociationsByCaseIdResponse>
- Defined in src/sdk.ts:1336

`Static` getAuthNToken

getAuthNToken(input): Promise<DowJonesGetAuthNTokenResponse>
Retrieve an id_token to use in getAuthZToken.

This method should not be called with every interaction of the API, instead obtain the AuthZ token, store it and use it until the 'expires_in' time has elapsed.

Once the AuthZ token expires, get a new AuthN token to request a new id_token to get a new AuthZ token to store.

These auth endpoints are rate limited.
Parameters
- input: {
      auth_url?: "https://accounts.dowjones.com/oauth2/v1/token" | "https://eu.accounts.dowjones.com/oauth2/v1/token";
      client_id: string;
      device: string;
      password: string;
      username: string;
  }
  The service account details
  - Optional auth_url?: "https://accounts.dowjones.com/oauth2/v1/token" | "https://eu.accounts.dowjones.com/oauth2/v1/token"
  - client_id: string
  - device: string
  - password: string
  - username: string
Returns Promise<DowJonesGetAuthNTokenResponse>
Contains the id_token that should be used for getAuthZToken
- Defined in src/sdk.ts:653

`Static` getAuthZToken

getAuthZToken(input): Promise<DowJonesGetAuthZTokenResponse>
Gets the access_token that can be used to call new DowJonesSDK()
Parameters
- input: {
      auth_url?: "https://accounts.dowjones.com/oauth2/v1/token" | "https://eu.accounts.dowjones.com/oauth2/v1/token";
      client_id: string;
      id_token: string;
  }
  The credentials received from getAuthNToken
  - Optional auth_url?: "https://accounts.dowjones.com/oauth2/v1/token" | "https://eu.accounts.dowjones.com/oauth2/v1/token"
  - client_id: string
  - id_token: string
Returns Promise<DowJonesGetAuthZTokenResponse>
The access_token to use in new DowJonesSDK()
- Defined in src/sdk.ts:694

`Static` refreshAuthZToken

refreshAuthZToken(input): Promise<DowJonesRefreshAuthZTokenResponse>
Parameters
- input: {
      auth_url?: "https://accounts.dowjones.com/oauth2/v1/token" | "https://eu.accounts.dowjones.com/oauth2/v1/token";
      client_id: string;
      refresh_token: string;
  }
  - Optional auth_url?: "https://accounts.dowjones.com/oauth2/v1/token" | "https://eu.accounts.dowjones.com/oauth2/v1/token"
  - client_id: string
  - refresh_token: string
Returns Promise<DowJonesRefreshAuthZTokenResponse>
Deprecated
Use the getAuthNToken and getAuthZToken flow
- Defined in src/sdk.ts:725

Class DowJonesSDK

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: { accessToken: string; }

accessToken: string

Returns DowJonesSDK

Properties

Private client

Methods

addAssociation

Type Parameters

Parameters

input: T

Returns Promise<DowJonesAddAssociationResponse<T["data"]["attributes"]["record_type"]>>

addAssociationsToCase

Parameters

case_id: string

Returns Promise<DowJonesAddCaseWithAssociationsResponse>

addBulkMatchesFeedback

Parameters

case_id: string

Returns Promise<DowJonesAddBulkMatchesFeedbackResponse>

addCase

Parameters

Returns Promise<DowJonesAddCaseResponse>

addCaseWithAssociations

Parameters

Returns Promise<DowJonesAddCaseWithAssociationsResponse>

addExistingAssociationsToCase

Parameters

input: { case_id: string; data: ({ id: string; type?: string | undefined; })[]; }

case_id: string

data: ({ id: string; type?: string | undefined; })[]

Returns Promise<DowJonesAddExsistingAssociationsToCaseResponse>

addMatchFeedback

Parameters

case_id: string

match_id: string

Returns Promise<DowJonesAddMatchFeedbackResponse>

decorrelateAssociationFromCase

Parameters

input: { association_id: string; case_id: string; }

association_id: string

case_id: string

Returns Promise<DowJonesAddExsistingAssociationsToCaseResponse>

decorrelateAssociationsFromCase

Parameters

input: { case_id: string; data: ({ id: string; type?: string | undefined; })[]; }

case_id: string

data: ({ id: string; type?: string | undefined; })[]

Returns Promise<DowJonesAddExsistingAssociationsToCaseResponse>

deleteAssociationById

Parameters

input: { id: string; }

id: string

Returns Promise<void>

deleteCaseById

Parameters

input: { case_id: string; }

case_id: string

Returns Promise<void>

getAssociationById

Type Parameters

T extends "PERSON" | "ENTITY" | "UNKNOWN"

Parameters

input: { id: string; }

id: string

Returns Promise<DowJonesGetAssociationByIdResponse<T>>

getBulkTransactionStatus

Parameters

input: { case_id: string; limit?: number; page?: number; transaction_id: string; }

case_id: string

Optional limit?: number

options: {
accessToken: string;
}

`Private` client

input: {
case_id: string;
data: ({ id: string; type?: string | undefined; })[];
}

input: {
association_id: string;
case_id: string;
}

input: {
case_id: string;
data: ({ id: string; type?: string | undefined; })[];
}

input: {
id: string;
}

input: {
case_id: string;
}

input: {
id: string;
}

input: {
case_id: string;
limit?: number;
page?: number;
transaction_id: string;
}

`Optional` limit?: number

`Optional` page?: number

input: {
case_id: string;
}

input: {
associationId?: string;
case_id: string;
limit?: number;
page?: number;
}

`Optional` associationId?: string

`Optional` limit?: number

`Optional` page?: number

input: {
case_id: string;
limit?: number;
page?: number;
transaction_id: string;
}

`Optional` limit?: number

`Optional` page?: number

input: {
transaction_id: string;
}

`Optional` input: {
limit?: number;
page?: number;
}

`Optional` limit?: number

`Optional` page?: number

input: {
case_id: string;
limit?: number;
page?: number;
}

`Optional` limit?: number

`Optional` page?: number

`Optional` input: {
limit?: number;
page?: number;
}

`Optional` limit?: number

`Optional` page?: number