Skip to content

[NEB-4778] Add KYC, geo, and bot-detection structured fields #87

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

Merged
rkumar-sift merged 2 commits into from
Sep 30, 2026
Merged

[NEB-4778] Add KYC, geo, and bot-detection structured fields #87

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
61d3ad8
[NEB-4778] Add KYC, geo, and bot-detection structured fields
rkumar-sift Aug 26, 2026
0f5f5dd
Add structured fields to integration test suites
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,5 +1,12 @@
# CHANGES

## 1.8.0 (2026-08-25)

### Added
- **`$nationality`**, **`$year_of_birth`** fields in `$create_account`, `$update_account` events
- **`$kyc`** complex type in `$create_account`, `$update_account`, `$transaction`, `$create_order`, `$update_order`, `$verification` events
- **`$geo`**, **`$bot_identification`** complex types in `$create_account`, `$update_account`, `$login`, `$transaction`, `$create_order`, `$update_order` events

## 1.7.0 (2025-12-03)

### Added
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

The official Sift .NET client, supporting .NET Standard 2.0+

## Latest Release (v1.7.0)
## Latest Release (v1.8.0)

See [CHANGES.MD](CHANGES.MD) for full release history.

Expand Down
17 changes: 17 additions & 0 deletions Sift/Schema/ComplexTypes/bot_identification.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"$schema": "http://json-schema.org/draft-04/schema",
"title": "BotIdentification",
"type": "object",
"required": [
"$result",
"$provider"
],
"properties": {
"$result": {
"type": [ "string", "null" ]
},
"$provider": {
"type": [ "string", "null" ]
}
}
}
17 changes: 17 additions & 0 deletions Sift/Schema/ComplexTypes/geo.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"$schema": "http://json-schema.org/draft-04/schema",
"title": "Geo",
"type": "object",
"required": [
"$uuid",
"$provider"
],
"properties": {
"$uuid": {
"type": [ "string", "null" ]
},
"$provider": {
"type": [ "string", "null" ]
}
}
}
19 changes: 19 additions & 0 deletions Sift/Schema/ComplexTypes/kyc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"$schema": "http://json-schema.org/draft-04/schema",
"title": "Kyc",
"type": "object",
"properties": {
"$names_match": {
"type": [ "boolean", "null" ]
},
"$kyc_level": {
"type": [ "string", "null" ]
},
"$bin_nationality_match": {
"type": [ "boolean", "null" ]
},
"$provider": {
"type": [ "string", "null" ]
}
}
}
24 changes: 24 additions & 0 deletions Sift/Schema/create_account.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,30 @@
},
"$ip": {
"type": [ "string", "null" ]
},
"$nationality": {
"type": [ "string", "null" ]
},
"$year_of_birth": {
"type": [ "integer", "null" ]
},
"$kyc": {
"oneOf": [
{ "$ref": "ComplexTypes/kyc.json" },
{ "type": "null" }
]
},
"$geo": {
"oneOf": [
{ "$ref": "ComplexTypes/geo.json" },
{ "type": "null" }
]
},
"$bot_identification": {
"oneOf": [
{ "$ref": "ComplexTypes/bot_identification.json" },
{ "type": "null" }
]
}
}
}
18 changes: 18 additions & 0 deletions Sift/Schema/create_order.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,24 @@
},
"$ip": {
"type": [ "string", "null" ]
},
"$kyc": {
"oneOf": [
{ "$ref": "ComplexTypes/kyc.json" },
{ "type": "null" }
]
},
"$geo": {
"oneOf": [
{ "$ref": "ComplexTypes/geo.json" },
{ "type": "null" }
]
},
"$bot_identification": {
"oneOf": [
{ "$ref": "ComplexTypes/bot_identification.json" },
{ "type": "null" }
]
}
}
}
12 changes: 12 additions & 0 deletions Sift/Schema/login.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,18 @@
},
"$verification_phone_number": {
"type": [ "string", "null" ]
},
"$geo": {
"oneOf": [
{ "$ref": "ComplexTypes/geo.json" },
{ "type": "null" }
]
},
"$bot_identification": {
"oneOf": [
{ "$ref": "ComplexTypes/bot_identification.json" },
{ "type": "null" }
]
}
}
}
18 changes: 18 additions & 0 deletions Sift/Schema/transaction.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,24 @@
"$new_balance": {
"type": [ "integer", "null" ],
"format": "long"
},
"$kyc": {
"oneOf": [
{ "$ref": "ComplexTypes/kyc.json" },
{ "type": "null" }
]
},
"$geo": {
"oneOf": [
{ "$ref": "ComplexTypes/geo.json" },
{ "type": "null" }
]
},
"$bot_identification": {
"oneOf": [
{ "$ref": "ComplexTypes/bot_identification.json" },
{ "type": "null" }
]
}
}
}
24 changes: 24 additions & 0 deletions Sift/Schema/update_account.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,30 @@
},
"$ip": {
"type": [ "string", "null" ]
},
"$nationality": {
"type": [ "string", "null" ]
},
"$year_of_birth": {
"type": [ "integer", "null" ]
},
"$kyc": {
"oneOf": [
{ "$ref": "ComplexTypes/kyc.json" },
{ "type": "null" }
]
},
"$geo": {
"oneOf": [
{ "$ref": "ComplexTypes/geo.json" },
{ "type": "null" }
]
},
"$bot_identification": {
"oneOf": [
{ "$ref": "ComplexTypes/bot_identification.json" },
{ "type": "null" }
]
}
}
}
18 changes: 18 additions & 0 deletions Sift/Schema/update_order.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,24 @@
},
"$ip": {
"type": [ "string", "null" ]
},
"$kyc": {
"oneOf": [
{ "$ref": "ComplexTypes/kyc.json" },
{ "type": "null" }
]
},
"$geo": {
"oneOf": [
{ "$ref": "ComplexTypes/geo.json" },
{ "type": "null" }
]
},
"$bot_identification": {
"oneOf": [
{ "$ref": "ComplexTypes/bot_identification.json" },
{ "type": "null" }
]
}
}

Expand Down
6 changes: 6 additions & 0 deletions Sift/Schema/verification.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,12 @@
},
"$ip": {
"type": [ "string", "null" ]
},
"$kyc": {
"oneOf": [
{ "$ref": "ComplexTypes/kyc.json" },
{ "type": "null" }
]
}
}
}
4 changes: 2 additions & 2 deletions Sift/Sift.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
<Authors>Sift</Authors>
<AssemblyTitle>Sift</AssemblyTitle>
<AssemblyName>Sift</AssemblyName>
<VersionPrefix>1.7.0</VersionPrefix>
<PackageReleaseNotes>Release 1.7.0</PackageReleaseNotes>
<VersionPrefix>1.8.0</VersionPrefix>
<PackageReleaseNotes>Release 1.8.0</PackageReleaseNotes>
<TargetFramework>netstandard2.0</TargetFramework>
<PackageId>Sift</PackageId>
<PackageTags>sift;siftscience;client;api;client;async</PackageTags>
Expand Down
19 changes: 19 additions & 0 deletions Test.Integration.Net/EventsAPI/Account.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,25 @@ public void CreateAccount()

}
},
nationality = "US",
year_of_birth = 1985,
kyc = new Kyc
{
names_match = true,
kyc_level = "$basic",
bin_nationality_match = true,
provider = "lexisnexis"
},
geo = new Geo
{
uuid = "gc-abc-123",
provider = "geocomply"
},
bot_identification = new BotIdentification
{
result = "$human",
provider = "datadome"
},
ip = "1.2.3.4"
};
EventRequest eventRequest = new EventRequest()
Expand Down
12 changes: 11 additions & 1 deletion Test.Integration.Net/EventsAPI/LoginLogout.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,17 @@ public void Login()
account_types = new ObservableCollection<string>() { "merchant", "premium" },
brand_name = "sift",
site_domain = "sift.com",
site_country = "US"
site_country = "US",
geo = new Geo
{
uuid = "gc-abc-123",
provider = "geocomply"
},
bot_identification = new BotIdentification
{
result = "$human",
provider = "datadome"
}
};
EventRequest eventRequest = new EventRequest()
{
Expand Down
32 changes: 32 additions & 0 deletions Test.Integration.Net/EventsAPI/Order.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,22 @@ private EventResponse CreateOrder(Client sift)
accept_language = "en-US",
content_language = "en-GB"
},
kyc = new Kyc
{
names_match = true,
kyc_level = "$basic",
provider = "lexisnexis"
},
geo = new Geo
{
uuid = "gc-abc-123",
provider = "geocomply"
},
bot_identification = new BotIdentification
{
result = "$human",
provider = "datadome"
},
ip = "1.2.3.4"
};
EventRequest eventRequest = new EventRequest()
Expand Down Expand Up @@ -299,6 +315,22 @@ private EventResponse UpdateOrder(Client sift)
accept_language = "en-US",
content_language = "en-GB"
},
kyc = new Kyc
{
names_match = true,
kyc_level = "$basic",
provider = "lexisnexis"
},
geo = new Geo
{
uuid = "gc-abc-123",
provider = "geocomply"
},
bot_identification = new BotIdentification
{
result = "$human",
provider = "datadome"
},
ip = "1.2.3.4"
};
EventRequest eventRequest = new EventRequest()
Expand Down
16 changes: 16 additions & 0 deletions Test.Integration.Net/EventsAPI/Transactions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,22 @@ public void TransactionTest()
}
},
receiver_external_address = true,
kyc = new Kyc
{
names_match = true,
bin_nationality_match = true,
provider = "lexisnexis"
},
geo = new Geo
{
uuid = "gc-abc-123",
provider = "geocomply"
},
bot_identification = new BotIdentification
{
result = "$suspected",
provider = "human_security"
},
ip = "1.2.3.4"
};
EventRequest eventRequest = new EventRequest()
Expand Down
7 changes: 7 additions & 0 deletions Test.Integration.Net/EventsAPI/Verifications.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,13 @@ public void VerificationTest()
brand_name = "sift",
site_domain = "sift.com",
site_country = "US",
kyc = new Kyc
{
names_match = true,
kyc_level = "$basic",
bin_nationality_match = false,
provider = "lexisnexis"
},
ip = "1.2.3.4"
};
EventRequest eventRequest = new EventRequest()
Expand Down
Loading
Loading