Skip to content

[NEB-4779] Add KYC, geo, and bot-detection structured fields #122

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rkumar-sift wants to merge 2 commits into
base: master
Choose a base branch
from
Open

[NEB-4779] Add KYC, geo, and bot-detection structured fields #122

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0399735
[NEB-4779] Add KYC, geo, and bot-detection structured fields
rkumar-sift Aug 27, 2026
14ddbc3
Address review: add integration test fixtures, refine CHANGES.md
rkumar-sift Sep 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions CHANGES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
6.1.0 2026-08-27
================

- Added support for `$nationality`, `$year_of_birth` fields on `$create_account`, `$update_account` events
- Added support for `$kyc` field on `$create_account`, `$update_account`, `$transaction`, `$create_order`, `$update_order`, `$verification` events
- Added support for `$geo`, `$bot_identification` fields on `$create_account`, `$update_account`, `$login`, `$transaction`, `$create_order`, `$update_order` events

6.0.0 2025-05-05
================

Expand Down
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,23 @@ properties = {
},
"$currency_code": "USD",
"$amount": 15230000,
# Identity / KYC signals
"$kyc": {
"$names_match": True,
"$kyc_level": "$basic", # "$basic" or "$full"
"$bin_nationality_match": True,
"$provider": "lexisnexis",
},
# Geo/compliance signals
"$geo": {
"$uuid": "gc-abc-123",
"$provider": "geocomply",
},
# Bot detection signals
"$bot_identification": {
"$result": "$human", # "$bot", "$human", or "$suspected"
"$provider": "datadome",
},
}

try:
Expand Down
2 changes: 1 addition & 1 deletion sift/version.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
VERSION = "6.0.0"
VERSION = "6.1.0"
API_VERSION = "205"
92 changes: 92 additions & 0 deletions test_integration_app/events_api/test_events_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,23 @@ def create_account(self) -> sift.client.Response:
],
"$social_sign_on_type": "$twitter",
"$account_types": ["merchant", "premium"],
# Structured fields (KYC / geo / bot detection)
"$nationality": "US",
"$year_of_birth": 1985,
"$kyc": {
"$names_match": True,
"$kyc_level": "$basic",
"$bin_nationality_match": True,
"$provider": "lexisnexis",
},
"$geo": {
"$uuid": "gc-abc-123",
"$provider": "geocomply",
},
"$bot_identification": {
"$result": "$human",
"$provider": "datadome",
},
# Suggested Custom Fields
"twitter_handle": "billyjones",
"work_phone": "1-347-555-5921",
Expand Down Expand Up @@ -541,6 +558,20 @@ def build_create_order_event(self) -> dict[str, t.Any]:
},
}
],
# Structured fields (KYC / geo / bot detection)
"$kyc": {
"$names_match": True,
"$kyc_level": "$basic",
"$provider": "lexisnexis",
},
"$geo": {
"$uuid": "gc-abc-123",
"$provider": "geocomply",
},
"$bot_identification": {
"$result": "$human",
"$provider": "datadome",
},
# Sample Custom Fields
"digital_wallet": "apple_pay", # "google_wallet", etc.
"coupon_code": "dollarMadness",
Expand Down Expand Up @@ -595,6 +626,15 @@ def login(self) -> sift.client.Response:
"$brand_name": "sift",
"$site_domain": "sift.com",
"$site_country": "US",
# Structured fields (geo / bot detection)
"$geo": {
"$uuid": "gc-abc-123",
"$provider": "geocomply",
},
"$bot_identification": {
"$result": "$human",
"$provider": "datadome",
},
# Send this information with a login from a BROWSER client.
"$browser": {
"$user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.36",
Expand Down Expand Up @@ -761,6 +801,20 @@ def transaction(self) -> sift.client.Response:
"$session_id": "gigtleqddo84l8cm15qe4il",
# For marketplaces, use $seller_user_id to identify the seller
"$seller_user_id": "slinkys_emporium",
# Structured fields (KYC / geo / bot detection)
"$kyc": {
"$names_match": True,
"$bin_nationality_match": False,
"$provider": "prove",
},
"$geo": {
"$uuid": "gc-abc-123",
"$provider": "geocomply",
},
"$bot_identification": {
"$result": "$human",
"$provider": "human_security",
},
# Sample Custom Fields
"digital_wallet": "apple_pay", # "google_wallet", etc.
"coupon_code": "dollarMadness",
Expand Down Expand Up @@ -816,6 +870,23 @@ def update_account(self) -> sift.client.Response:
},
"$social_sign_on_type": "$twitter",
"$account_types": ["merchant", "premium"],
# Structured fields (KYC / geo / bot detection)
"$nationality": "US",
"$year_of_birth": 1985,
"$kyc": {
"$names_match": True,
"$kyc_level": "$full",
"$bin_nationality_match": True,
"$provider": "prove",
},
"$geo": {
"$uuid": "gc-abc-123",
"$provider": "geocomply",
},
"$bot_identification": {
"$result": "$human",
"$provider": "datadome",
},
# Send this information from a BROWSER client.
"$browser": {
"$user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.36",
Expand Down Expand Up @@ -1226,6 +1297,20 @@ def update_order(self) -> sift.client.Response:
},
}
],
# Structured fields (KYC / geo / bot detection)
"$kyc": {
"$names_match": True,
"$kyc_level": "$basic",
"$provider": "lexisnexis",
},
"$geo": {
"$uuid": "gc-abc-123",
"$provider": "geocomply",
},
"$bot_identification": {
"$result": "$human",
"$provider": "datadome",
},
# Sample Custom Fields
"digital_wallet": "apple_pay", # "google_wallet", etc.
"coupon_code": "dollarMadness",
Expand Down Expand Up @@ -1284,5 +1369,12 @@ def verification(self) -> sift.client.Response:
"$reason": "$automated_rule",
"$verification_type": "$sms",
"$verified_value": "14155551212",
# Structured fields (KYC)
"$kyc": {
"$names_match": True,
"$kyc_level": "$basic",
"$bin_nationality_match": False,
"$provider": "lexisnexis",
},
}
return self.client.track("$verification", verification_properties)
Loading