> ## Documentation Index > Fetch the complete documentation index at: https://www.dynamic.xyz/docs/llms.txt > Use this file to discover all available pages before exploring further. # Get the screening policy for a vendor > Returns the environment's stored screening policy for the specified vendor, including the `revision` an edit must echo back. The sanctions floor is not part of the response: it is generated from code on every screen. ## OpenAPI ````yaml https://app.dynamic.xyz/api-docs/public-api.yaml get /environments/{environmentId}/screeningPolicies/{providerType}/{scope} openapi: 3.0.1 info: title: Dashboard API description: Dashboard API documentation version: 1.0.0 servers: - url: https://app.dynamicauth.com/api/v0 - url: https://app.dynamic.xyz/api/v0 - url: http://localhost:3333/api/v0 security: [] tags: - name: Analytics description: Query usage analytics and event counts for your environment. - name: SDK description: SDK-facing endpoints consumed by embedded Dynamic clients. - name: Server description: Server-side SDK endpoints authenticated by environment API tokens. - name: Organizations description: >- Manage organizations — the top-level container for all environments and projects. - name: Projects description: Manage projects that group related environments under an organization. - name: Environments description: >- Manage environments (live and sandbox) where your authentication configuration lives. - name: Users description: List, search, and manage authenticated users within an environment. - name: Invites description: >- Manage invitation links that grant specific external users access to your environment. - name: Tokens description: >- Create and manage API tokens used to authenticate requests to the Dynamic API. - name: Origins description: >- Configure allowed origins (CORS) for SDK and API access to your environment. - name: Allowlists description: >- Manage allowlists to control which wallet addresses or email addresses can access your environment. - name: Wallets description: View and manage wallets linked to users in your environment. - name: Members description: Manage team members and their roles within an organization. - name: Sessions description: View and revoke active user sessions within an environment. - name: Settings description: Read and update environment-level configuration settings. - name: Exchanges description: >- Configure exchange integrations (Coinbase, Binance, etc.) for fiat on-ramp within your environment. - name: Yield description: List yield vaults registered for your environment. - name: Providers description: >- List, enable, disable, and configure authentication providers (OAuth, email, wallet, SMS, etc.) for your environment. - name: Captcha description: >- Configure captcha verification (provider, site key, secret key) for your environment. - name: Gates description: >- Define access gates that restrict environment entry to users who meet specific criteria. - name: Chains description: >- Manage the blockchain networks available for wallet connection in your environment. - name: Exports description: Export user and wallet data from your environment as downloadable files. - name: Events description: Browse the event log of actions performed within your environment. - name: Webhooks description: >- Create and manage webhooks to receive real-time events (user.created, wallet.linked, etc.) at your endpoint. - name: Custom Fields description: >- Define and manage custom metadata fields collected from users at sign-up or login. - name: MfaSettings description: >- Configure multi-factor authentication (MFA) policies for your organization. - name: Mfa description: Manage MFA enrollment and verification for individual users. - name: CustomHostnames description: >- Configure custom hostnames for white-labeling the Dynamic authentication experience. - name: TestAccount description: >- Manage test accounts used for automated testing and QA within an environment. - name: NameServices description: >- Configure name service integrations (ENS, Unstoppable Domains, etc.) for human-readable wallet addresses. - name: GlobalWallets description: >- Manage global wallets shared across multiple environments in an organization. - name: GlobalWalletConnections description: Configure which environments can access and use global wallets. - name: GlobalWalletAccessControl description: Control which users and roles can access and operate global wallets. - name: UserApiTokens description: >- Create and manage user-scoped API tokens for programmatic access on behalf of a user. - name: Waas description: Wallet-as-a-Service endpoints for creating and managing embedded wallets. - name: WalletConnect description: Configure WalletConnect integration settings for your environment. - name: Checkout description: >- Accept crypto payments and deposits from any wallet. Settle in any token you choose. - name: Flow description: >- Accept crypto payments, deposits, and withdrawals. Amount and destination are fixed server-side at create; the post-create lifecycle is driven with a capability session token. - name: FlowAnalytics description: >- Query aggregated analytics and paginated transaction lists for the Flow product. - name: Gasless description: >- Query billing summaries and paginated transaction lists for sponsored (gasless) transactions. - name: Custom Networks description: >- Add and manage custom EVM-compatible networks beyond the built-in chain list. - name: Chainalysis description: >- Configure Chainalysis integration for blockchain address screening and risk assessment. - name: Visits description: Track and query user visit activity within your environment. - name: ExternalJwt description: >- Configure external JWT providers so existing auth tokens can be used with Dynamic. - name: SDK Views description: >- Manage SDK view configurations that customize the appearance of Dynamic modals and flows. - name: DeeplinkUrls description: Configure deep link URLs for mobile app integration with the Dynamic SDK. - name: OrganizationSettings description: >- Read and update organization-level settings such as approval workflow configuration. - name: AdminActions description: >- Manage admin action requests that require approval from another administrator. - name: ClientGrant description: | OAuth 2.0 Device Authorization Grant flow (RFC 8628) used by first-party Dynamic clients (CLI, MCP server, demo apps, IDE plugins) to obtain a revocable, 30-day client JWT without ever seeing the user's dashboard session token. - name: AuthorizedClients description: | Manage first-party clients (CLI / MCP / demo / IDE plugins) authorized to act as a dashboard user. Surfaced under Profile → Authorized Clients. - name: Kyb description: >- Verify a business's identity via AI Prise passthrough and check KYB tier status. - name: BusinessAccounts description: >- Administer the business accounts (multi-operator wallet containers) that end users create in an environment. - name: ScreeningPolicies description: | Author per-vendor address screening policies that map TRM and Chainalysis signals to block, alert, or allow, plus per-address exceptions. The sanctions floor sits underneath every policy and is not configurable. paths: /environments/{environmentId}/screeningPolicies/{providerType}/{scope}: get: tags: - ScreeningPolicies summary: Get the screening policy for a vendor description: >- Returns the environment's stored screening policy for the specified vendor, including the `revision` an edit must echo back. The sanctions floor is not part of the response: it is generated from code on every screen. operationId: getScreeningPolicy parameters: - $ref: '#/components/parameters/environmentId' - in: path name: providerType required: true description: Screening vendor the policy belongs to schema: $ref: '#/components/schemas/ScreeningPolicyProviderEnum' - in: path name: scope required: true description: >- Which screening moment this policy governs. An environment holds one policy per vendor per scope, authored independently. schema: $ref: '#/components/schemas/ScreeningPolicyScopeEnum' responses: '200': description: The screening policy for this environment and vendor content: application/json: schema: $ref: '#/components/schemas/ScreeningPolicy' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' security: - bearerAuth: [] components: parameters: environmentId: in: path name: environmentId required: true description: ID of the environment schema: $ref: '#/components/schemas/uuid' schemas: ScreeningPolicyProviderEnum: description: > Screening vendor a policy belongs to. Deliberately not `ProviderEnum`, which is a 44-value auth/social/onramp list of which only these two are screening vendors. The Dynamic sanctions provider is absent because the sanctions floor is generated from code and is not configurable. type: string enum: - trmWalletScreening - chainalysisAddressScreening ScreeningPolicyScopeEnum: description: > Which screening moment a policy governs. An environment holds one policy per vendor per scope, authored independently — a customer may alert at sign-in and block on transactions, or skip the paid vendor 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. type: string enum: - SIGN_IN - TRANSACTION ScreeningPolicy: description: One vendor's screening policy in one environment, for one scope. type: object required: - providerType - scope - revision - schemaVersion - rules - addressEntryCount - enabled properties: providerType: $ref: '#/components/schemas/ScreeningPolicyProviderEnum' scope: $ref: '#/components/schemas/ScreeningPolicyScopeEnum' revision: description: >- Generation counter. Echo it back on update as the concurrency precondition. type: integer schemaVersion: description: Rule-language version that governs how `rules` is parsed. type: integer rules: $ref: '#/components/schemas/ScreeningPolicyRules' addressEntryCount: description: >- Number of live address entries applying to THIS scope — those marked `ALL` plus those narrowed to it. Entries themselves belong to the (environment, vendor) pair, not to this policy. type: integer enabled: description: Whether the policy is live. type: boolean updatedAt: description: ISO 8601 timestamp of the last mutation. type: string format: date-time uuid: type: string pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ minLength: 36 maxLength: 36 example: 95b11417-f18f-457f-8804-68e361f9164f ScreeningPolicyRules: description: > Customer rules, `{ preScreen, postScreen }`, per the vendor's own rule schema (`TrmPolicyRules` or `ChainalysisPolicyRules`). Typed as a free-form object rather than a `oneOf` over the two: the vendor 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 vendor'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. type: object BadRequest: type: object properties: error: description: Human-readable error message type: string Unauthorized: type: object properties: error: description: Human-readable error message describing the authentication failure type: string example: No jwt provided! Forbidden: type: object properties: error: description: Human-readable error message type: string example: Access Forbidden NotFound: type: object required: - error - code properties: error: description: Human-readable error message type: string example: Not Found code: description: Machine-readable error code type: string example: not_found InternalServerError: type: object properties: error: description: Human-readable error message type: string example: Internal Server Error responses: BadRequest: description: Bad Request content: application/json: schema: $ref: '#/components/schemas/BadRequest' Unauthorized: description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Unauthorized' Forbidden: description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Forbidden' NotFound: description: Not Found content: application/json: schema: $ref: '#/components/schemas/NotFound' InternalServerError: description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/InternalServerError' securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT ````