Skip to content

Commit

Permalink
[CAT-1376] Add record item object definition for watchlist enhanced p…
Browse files Browse the repository at this point in the history
…roperties field (#119)

* Add record item object definition for watchlist enhanced properties field
* fix fullname
* Add two missing fields
* Use country codes
* Partially revert "Fix records item type in watchlist reports properties"
  • Loading branch information
dvacca-onfido authored Sep 19, 2024
1 parent 807905e commit 08508b9
Show file tree
Hide file tree
Showing 3 changed files with 109 additions and 2 deletions.
2 changes: 1 addition & 1 deletion schemas/reports/watchlist_aml_properties.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ properties:
description: Returns any matches including, but not limited to, name and date of birth of match, aliases and associates, and relevant events and sources.
type: array
items:
type: object
type: string
107 changes: 107 additions & 0 deletions schemas/reports/watchlist_enhanced_properties.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,110 @@ properties:
type: array
items:
type: object
properties:
address:
type: array
description: All addresses on file.
items:
type: object
properties:
address_line1:
type: string
country:
type: string
allOf:
- $ref: ../countries/country_codes.yaml
postal_code:
type: string
state_province:
type: string
town:
type: string
locator_type:
type: string
alias:
type: array
description: Any names that the person is also known as.
items:
type: object
properties:
alias_name:
type: string
alias_type:
type: string
associate:
type: array
description: Any linked persons, for example family relatives or business partners.
items:
type: object
properties:
entity_name:
type: string
relationship_direction:
type: string
relationship_type:
type: string
attribute:
type: array
description: Information about the person, for example hair color or nationality.
items:
type: object
properties:
attribute_type:
type: string
attribute_value:
type: string
date_of_birth:
type: array
description: All the date of births on file.
items:
type: string
event:
type: array
description: Information about events that have occurred to the person, for example deportation or arrest.
items:
type: object
properties:
category:
type: string
event_date:
type: string
format: date
event_description:
type: string
source:
type: object
properties:
source_date:
type: string
format: date
source_format:
type: string
source_name:
type: string
source_url:
type: string
sub_category:
type: string
full_name:
type: string
description: The name on file
position:
type: array
description: The role, country and date of each position.
items:
type: string
source:
type: array
description: Details about where the information was obtained.
items:
type: object
properties:
source_headline:
type: string
source_name:
type: string
source_url:
type: string
source_format:
type: string
2 changes: 1 addition & 1 deletion schemas/reports/watchlist_standard_properties.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ properties:
description: Returns any matches including, but not limited to, name and date of birth of match, aliases and associates, and relevant events and sources.
type: array
items:
type: object
type: string

0 comments on commit 08508b9

Please sign in to comment.