ScreeningPolicy

One provider's screening policy in one environment, for one scope.

providerType · enum<string> · required

Screening provider a policy belongs to. Deliberately not ProviderEnum, which is a 44-value auth/social/onramp list of which only these two are screening providers. The Dynamic sanctions provider is absent because the sanctions floor is generated from code and is not configurable.

Available options: trmWalletScreening, chainalysisAddressScreening

scope · enum<string> · required

Whether a policy is the sign-in policy or the transaction policy. An environment holds one policy per provider per scope, authored independently — a customer may alert at sign-in and block on transactions, or skip the paid provider call at one and not the other. Two values, not three: an "applies to both" policy would make the overlap with a single-scope row unrepresentable as a unique constraint.

Available options: SIGN_IN, TRANSACTION

revision · integer · required

Generation counter. Echo it back on update as the concurrency precondition.

schemaVersion · integer · required

Rule-language version that governs how rules is parsed.

rules · object · required

Customer rules, { preScreen, postScreen }, per the provider's own rule schema (TrmPolicyRules or ChainalysisPolicyRules). Typed as a free-form object rather than a oneOf over the two: the provider is a path parameter, no OpenAPI construct selects a body schema from one, and oneOf generates SDK models that do not compile. The server validates the blob against the provider's schema before writing, so a TRM policy naming a chainalysis.* field is a 400. Clients should validate against those two schemas before submitting.

Neither the sanctions floor nor the terminal ALLOW appears here. Both are generated from code on every screen, so there is nothing to author, edit, or read back, and no request body can weaken them.

addressEntryCount · integer · required

Number of live address entries applying to THIS scope — those marked ALL plus those narrowed to it. Entries themselves belong to the (environment, provider) pair, not to this policy.

enabled · boolean · required

Whether the policy is live.

updatedAt · string<date-time>

ISO 8601 timestamp of the last mutation.