# WatchlistMatch

Matched profile details

## Example Usage

```typescript
import { WatchlistMatch } from "@apexfintechsolutions/ascend-sdk/models/components";

let value: WatchlistMatch = {};
```

## Fields

| Field                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | Required                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | Example                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `active`                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | *boolean*                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                           | Identifies if the entry is active or not                                                                                                                                                                                                                                                                                                                                                                                                                                     | true                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| `createdAt`                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                                                                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                           | The time the watchlist match was created                                                                                                                                                                                                                                                                                                                                                                                                                                     | 2023-06-13T23:48:58.343Z                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| `excludeFromScreening`                                                                                                                                                                                                                                                                                                                                                                                                                                                       | *boolean*                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                           | Identifies that a confirmed watchlist match can be excluded when calculating the related screen state                                                                                                                                                                                                                                                                                                                                                                        | false                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| `matchAttributes`                                                                                                                                                                                                                                                                                                                                                                                                                                                            | [components.MatchAttributes](../../models/components/matchattributes.md)[]                                                                                                                                                                                                                                                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                           | The attributes used in watchlist screening, one of:<br/>- `MATCH_ATTRIBUTE_UNSPECIFIED` - Default/Null value.<br/>- `NAME` - Matched on name.<br/>- `PHONE_NUMBER` - Matched on phone number.<br/>- `BIRTH_DATE` - Matched on birth date.<br/>- `IDENTIFICATION` - Matched on identification.<br/>- `EMAIL` - Matched on email.<br/>- `ADDRESS` - Matched on address.                                                                                                        | PHONE_NUMBER, EMAIL                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| `matchState`                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [components.MatchState](../../models/components/matchstate.md)                                                                                                                                                                                                                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                           | The match state for a profile, one of:<br/>- `MATCH_UNSPECIFIED` - Default/Null value.<br/>- `CONFIRMED_MATCH` - Match is confirmed.<br/>- `POTENTIAL_MATCH` - Match is a potential.<br/>- `NO_MATCH` - Match is confirmed not to be a match.<br/>- `INCONCLUSIVE` - Match is deemed to be inconclusive.                                                                                                                                                                     | CONFIRMED_MATCH                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| `matchTypes`                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [components.MatchTypes](../../models/components/matchtypes.md)[]                                                                                                                                                                                                                                                                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                           | The type of watchlist match, one of:<br/>- `MATCH_TYPE_UNSPECIFIED` - Default/Null value.<br/>- `NON_OFAC_SANCTIONS` - Matched on a non OFAC sanctions list.<br/>- `RELATIVE_OR_CLOSE_ASSOCIATE` - Matched on a relative or close associate.<br/>- `OFAC_SANCTIONS` - Matched on a OFAC sanctions list.<br/>- `POLITICALLY_EXPOSED_PERSON` - Matched on a politically exposed person list.<br/>- `DNDB` - Matched on a do not do business list.<br/>- `NEGATIVE_NEWS` - Matched on a negative news list. | NEGATIVE_NEWS, OFAC_SANCTIONS                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| `updatedAt`                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                                                                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                           | The time the watchlist match was last updated                                                                                                                                                                                                                                                                                                                                                                                                                                | 2023-06-13T23:48:58.343Z                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| `watchlistId`                                                                                                                                                                                                                                                                                                                                                                                                                                                                | *string*                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                           | Indicates the watchlist source for a given match                                                                                                                                                                                                                                                                                                                                                                                                                             | DOWJONES                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| `watchlistItemId`                                                                                                                                                                                                                                                                                                                                                                                                                                                            | *number*                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                           | Identification number for the watchlist item that was matched                                                                                                                                                                                                                                                                                                                                                                                                                | 123456                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |