Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.newton.xyz/llms.txt

Use this file to discover all available pages before exploring further.

Newton provides Rego built-in functions for checking user identity data within policy evaluation. These functions let you enforce KYC requirements — like age, country, and document status — directly in your Rego policies. Identity built-ins are domain-namespaced under newton.identity.<domain>.*. The KYC domain is the first implemented domain. A generic newton.identity.get(field_name) accessor works across any domain for ad-hoc field access.
For the full Rego syntax reference including all Newton extensions, see the Rego Syntax Guide.

​
KYC Data Fields

The following fields are available from the KYC identity data passed into the policy engine:
FieldTypeDescription
statusstringOne of: created, pending, completed, approved, failed, expired, declined, needs review
selected_country_codestringThe country code selected by the user during the KYC process
address_subdivisionstringThe state/subdivision from the document address
address_country_codestringThe country from the document address
birthdatestringThe user’s birthdate as a YYYY-MM-DD string
expiration_datestringThe expiration date of the identity document
issue_datestringThe issuance date of the identity document
issuing_authoritystringThe country or state that issued the document

​
KYC Built-in Functions

FunctionDescription
newton.identity.kyc.check_approvedCheck that the identity data has been approved
newton.identity.kyc.address_in_countriesCheck that the document country is in an allowed list
newton.identity.kyc.address_in_subdivisionCheck that the document address is in an allowed list of subdivisions
newton.identity.kyc.address_not_in_subdivisionCheck that the document address is not in an excluded list of subdivisions
newton.identity.kyc.age_gteCheck that the user is at least a minimum age
newton.identity.kyc.not_expiredCheck that the identity document has not expired
newton.identity.kyc.valid_forCheck that the document remains valid for a minimum number of days
newton.identity.kyc.issued_sinceCheck that the document was issued at least a minimum number of days ago

​
newton.identity.kyc.check_approved

Requires identity_data.status to equal "approved". Signature: 
result := newton.identity.kyc.check_approved()
Returns:
TypeDescription
booltrue if identity_data.status is "approved", otherwise false
Example: 
package example

import future.keywords.if

# Verify the identity data is approved
authorized if {
    newton.identity.kyc.check_approved()
}

​
newton.identity.kyc.address_in_countries

Requires identity_data.address_country_code to be found within the provided list of country codes. Signature: 
result := newton.identity.kyc.address_in_countries(country_code_array)
Arguments:
ArgumentTypeDescription
country_code_arraystring[]Array of 2-letter ISO country codes to check against
Returns:
TypeDescription
booltrue if the address country is within the list, otherwise false
Example: 
package example

import future.keywords.if

# Verify the identity data matches address requirements
authorized if {
    newton.identity.kyc.address_in_countries(["US","DE","CA"])
}

​
newton.identity.kyc.address_in_subdivision

Requires the ISO subdivision location code (combining address_country_code and address_subdivision) to be found within the provided list. Signature: 
result := newton.identity.kyc.address_in_subdivision(iso_code_array)
Arguments:
ArgumentTypeDescription
iso_code_arraystring[]Array of XX-XX or XX-XXX ISO subdivision codes to match against
Returns:
TypeDescription
booltrue if the address is within the list, otherwise false
Example: 
package example

import future.keywords.if

# Verify the identity data matches address requirements
authorized if {
    newton.identity.kyc.address_in_subdivision(["US-CA","US-OR","US-WA"])
}

​
newton.identity.kyc.address_not_in_subdivision

Requires the ISO subdivision location code to not be found within the provided list. Useful for excluding specific subdivisions while allowing all others in a country (avoids submitting a long allowlist). Signature: 
result := newton.identity.kyc.address_not_in_subdivision(iso_code_array)
Arguments:
ArgumentTypeDescription
iso_code_arraystring[]Array of XX-XX or XX-XXX ISO subdivision codes to exclude
Returns:
TypeDescription
booltrue if the address is not in the list, otherwise false
Example: 
package example

import future.keywords.if

# Allow all US users except specific states
authorized if {
    newton.identity.kyc.address_in_countries(["US"])
    newton.identity.kyc.address_not_in_subdivision(["US-NY","US-NC","US-HI"])
}

​
newton.identity.kyc.age_gte

Requires identity_data.birthdate to be at least the required number of years ago, relative to reference_date. Signature: 
result := newton.identity.kyc.age_gte(min_age)
Arguments:
ArgumentTypeDescription
min_agenumberMinimum age in years (must be positive)
Returns:
TypeDescription
booltrue if the user’s age meets the minimum, otherwise false
Example: 
package example

import future.keywords.if

# Verify the user meets age requirements
authorized if {
    newton.identity.kyc.age_gte(21)
}

​
newton.identity.kyc.not_expired

Requires identity_data.expiration_date to be after the current date (reference_date). Signature: 
result := newton.identity.kyc.not_expired()
Returns:
TypeDescription
booltrue if the document expiration date is in the future, otherwise false
Example: 
package example

import future.keywords.if

# Verify the identity document isn't expired
authorized if {
    newton.identity.kyc.not_expired()
}

​
newton.identity.kyc.valid_for

Requires identity_data.expiration_date to be at least the required number of days in the future, relative to reference_date. Signature: 
result := newton.identity.kyc.valid_for(min_days)
Arguments:
ArgumentTypeDescription
min_daysnumberMinimum number of days the document must still be valid (must be positive)
Returns:
TypeDescription
booltrue if the document will be valid for at least min_days, otherwise false
Example: 
package example

import future.keywords.if

# Verify the document is valid for at least one more year
authorized if {
    newton.identity.kyc.valid_for(365)
}

​
newton.identity.kyc.issued_since

Requires identity_data.issue_date to be at least the required number of days in the past, relative to reference_date. Signature: 
result := newton.identity.kyc.issued_since(min_days)
Arguments:
ArgumentTypeDescription
min_daysnumberMinimum number of days since the document was issued (must be positive)
Returns:
TypeDescription
booltrue if the document was issued at least min_days ago, otherwise false
Example: 
package example

import future.keywords.if

# Verify the document was issued at least 90 days ago
authorized if {
    newton.identity.kyc.issued_since(90)
}

​
Generic Field Accessor

​
newton.identity.get

Works across any identity domain. Returns the raw field value by name. Returns undefined if the field does not exist. Signature: 
result := newton.identity.get(field_name)
Arguments:
ArgumentTypeDescription
field_namestringThe field name to look up
Returns:
TypeDescription
any / undefinedThe field value, or undefined if the field does not exist
Example: 
package example

import future.keywords.if

# Use generic accessor for ad-hoc field checks
authorized if {
    newton.identity.get("status") == "approved"
    newton.identity.get("address_country_code") == "US"
}

​
Error Handling

  • Address functions (address_in_countries, address_in_subdivision, address_not_in_subdivision) return an error (and the rule evaluates to undefined) when:
    • Provided an empty array
    • Provided full country/state names instead of ISO codes
    • The stored country code or subdivision is empty
  • Date functions (age_gte, valid_for, issued_since) return an error if given negative numbers or if dates cannot be parsed.
When a built-in function errors, the policy rule containing it evaluates to undefined, which Newton treats as a denial.

​
Next Steps

Integration Guide

Step-by-step walkthrough for integrating Newton VC

SDK & Contract Reference

SDK methods and contract function signatures