> ## Documentation Index
> Fetch the complete documentation index at: https://docs.range.org/llms.txt
> Use this file to discover all available pages before exploring further.

# [Beta] a client's approved counterparties



## OpenAPI

````yaml /api-reference/platform-api.json get /v2/screening/clients/{client_entity_id}/counterparties
openapi: 3.0.0
info:
  title: Range Platform API
  description: >-
    The Range Platform API for workspace management, counterparties, and
    operational tooling.
  version: 1.7.32
  contact: {}
servers:
  - url: https://api.range.org
    description: Range API Server
security:
  - Authorization: []
  - Authorization: []
tags:
  - name: Address Information
    description: Get information about a crypto address.
  - name: Transfer Enrichments
    description: Attach workspace-scoped notes and categories to transfers.
  - name: Counterparties
    description: Manage external entities, their addresses, bank accounts, and documents.
  - name: Parties
    description: >-
      The workspace entity register: the firm itself, its clients, and its
      counterparties.
paths:
  /v2/screening/clients/{client_entity_id}/counterparties:
    get:
      tags:
        - Screening
      summary: '[Beta] a client''s approved counterparties'
      operationId: list
      parameters:
        - name: client_entity_id
          required: true
          in: path
          schema:
            type: string
        - name: status
          required: false
          in: query
          schema:
            $ref: '#/components/schemas/Object'
        - name: q
          required: false
          in: query
          schema:
            type: string
            maxLength: 128
        - name: limit
          required: false
          in: query
          schema:
            minimum: 1
            maximum: 200
            type: number
        - name: cursor
          required: false
          in: query
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CounterpartyEntryListDto'
components:
  schemas:
    Object:
      type: object
      properties: {}
    CounterpartyEntryListDto:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/CounterpartyEntryDto'
        meta:
          $ref: '#/components/schemas/CursorMetaDto'
      required:
        - items
        - meta
    CounterpartyEntryDto:
      type: object
      properties:
        counterparty_id:
          type: string
          example: 3f0a3c1e-6b1d-5f2a-8e44-9a0b1c2d3e4f
          description: The approval link (client, network, address).
        client_entity_id:
          type: string
          example: 6859927c-292e-4077-8d6a-70542c00a267
        counterparty_entity_id:
          type: string
          nullable: true
        address:
          type: string
          example: '0x8589427373d6d84e98730d7795d8f6f8731fda16'
        network:
          type: string
          example: eth
        beneficiary_name:
          type: string
          example: Halvard Capital AG
        status:
          type: string
          enum:
            - clear
            - flagged
            - removed
            - pending
            - error
          example: clear
          description: >-
            pending: not screened yet (screened about a minute after it was
            added, or by the next run when screening on add is off).
        checks:
          type: array
          items:
            $ref: '#/components/schemas/PublicCheckResultDto'
        reasons:
          type: array
          items:
            $ref: '#/components/schemas/ScreeningReasonDto'
        last_screened_at:
          type: string
          nullable: true
        case_id:
          type: string
          nullable: true
          description: >-
            The `/v2/cases` id of the open case its flag opened (source_type
            `counterparty_screening`).
      required:
        - counterparty_id
        - client_entity_id
        - counterparty_entity_id
        - address
        - network
        - beneficiary_name
        - status
        - checks
        - reasons
        - last_screened_at
        - case_id
    CursorMetaDto:
      type: object
      properties:
        next_cursor:
          type: string
          nullable: true
          description: >-
            Opaque string cursor pointing to the next page of results. null if
            there is no next page.
          example: eyJpZCI6IjkxeFFlV3Z...
        previous_cursor:
          type: string
          nullable: true
          description: >-
            Opaque string cursor pointing to the previous page of results. null
            if there is no previous page.
          example: eyJpZCI6IjkxeFFlV3Z...
        first_page_cursor:
          type: string
          description: >-
            Opaque string cursor pointing to the very first page in the entire
            dataset with respect to the current filter.
          example: eyJpZCI6IjkxeFFlV3Z...
        last_page_cursor:
          type: string
          nullable: true
          description: >-
            Opaque string cursor pointing to the very last page in the entire
            dataset with respect to the current filter.
          example: eyJpZCI6IjkxeFFlV3Z...
        total_count:
          type: number
          nullable: true
          description: Total number of results.
          example: 100
        page_number:
          type: number
          description: >-
            Current page number (1-based). Omitted by list endpoints that do not
            compute a page index.
          example: 1
    PublicCheckResultDto:
      type: object
      properties:
        kind:
          type: string
          enum:
            - approved_counterparty
            - address_risk
            - name_screening
            - travel_rule
          example: address_risk
        check_type:
          type: string
          enum:
            - approved_counterparties
            - range_address_risk
            - chainalysis_address_risk
            - merkle_address_risk
            - temenos_fcm_watchlist
            - notabene_travel_rule
          example: range_address_risk
        label:
          type: string
          example: Range address risk
        provider:
          type: string
          enum:
            - range
            - chainalysis
            - merkle_science
            - temenos_fcm
            - notabene
          example: range
        provider_used:
          type: string
          nullable: true
          example: null
          description: >-
            Who actually answered when it was not `provider` (Range, for a chain
            the vendor does not cover).
        status:
          type: string
          enum:
            - pass
            - fail
            - not_applicable
            - pending
            - error
            - awaiting
            - skipped
          example: pass
          description: >-
            pass | fail | error (the provider could not answer: fails closed) |
            awaiting (checked after execution) | pending | not_applicable |
            skipped.
        screened_at:
          type: string
          nullable: true
          example: '2026-10-07T09:12:03.120Z'
        risk_tier:
          type: string
          enum:
            - none
            - low
            - medium
            - high
            - severe
          example: low
        travel_rule_status:
          type: string
          enum:
            - complete
            - pending
            - incomplete
            - not_found
            - not_applicable
            - error
          example: complete
        provider_detail:
          $ref: '#/components/schemas/ProviderDetailDto'
        evidence:
          nullable: true
          description: >-
            address_risk only: what the screen found, kept with the decision.
            Null when no provider answered.
          type: object
          allOf:
            - $ref: '#/components/schemas/AddressRiskEvidenceDto'
        note:
          type: string
          nullable: true
          example: null
        reason:
          nullable: true
          type: object
          allOf:
            - $ref: '#/components/schemas/ScreeningReasonDto'
      required:
        - kind
        - check_type
        - label
        - provider
        - provider_used
        - status
        - screened_at
        - note
        - reason
    ScreeningReasonDto:
      type: object
      properties:
        code:
          type: string
          enum:
            - not_approved_counterparty
            - address_risk_high
            - address_risk_severe
            - address_risk_flagged
            - sanctions_name_match
            - sanctions_state_unknown
            - travel_rule_missing
            - travel_rule_incomplete
            - address_risk_pending
            - name_screening_pending
            - travel_rule_pending
            - provider_unavailable
            - provider_not_connected
            - address_network_mismatch
            - sender_unknown
            - travel_rule_no_hash
          example: not_approved_counterparty
          description: 'Stable: branch on this. The list may grow.'
        check_type:
          type: string
          enum:
            - approved_counterparties
            - range_address_risk
            - chainalysis_address_risk
            - merkle_address_risk
            - temenos_fcm_watchlist
            - notabene_travel_rule
          example: approved_counterparties
        policy_key:
          type: string
          example: client.whitelist
        message:
          type: string
          example: Not one of the client's approved counterparties
          description: For people; may be reworded.
      required:
        - code
        - check_type
        - policy_key
        - message
    ProviderDetailDto:
      type: object
      properties:
        provider_status:
          type: string
          nullable: true
          example: SETTLED
          description: The provider's own status, for display and audit only.
      required:
        - provider_status
    AddressRiskEvidenceDto:
      type: object
      properties:
        screen_id:
          type: string
          example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
          description: >-
            The risk v3 screen it came from: GET /v3/risk/screens/:screen_id
            returns the full response as it was served (caller’s workspace
            only).
        score:
          type: number
          nullable: true
          example: 100
          minimum: 0
          maximum: 100
        sanctioned:
          type: boolean
          nullable: true
          example: true
        signals:
          description: Risk signals, worst first; at most 20.
          type: array
          items:
            $ref: '#/components/schemas/EvidenceSignalDto'
        listings:
          description: At most 10.
          type: array
          items:
            $ref: '#/components/schemas/EvidenceListingDto'
        attribution:
          description: At most 5.
          type: array
          items:
            $ref: '#/components/schemas/EvidenceAttributionDto'
        exposures:
          description: 'Risk exposures only: the 5 largest by share, then USD.'
          type: array
          items:
            $ref: '#/components/schemas/EvidenceExposureDto'
        totals:
          nullable: true
          type: object
          allOf:
            - $ref: '#/components/schemas/EvidenceTotalsDto'
        data_as_of:
          type: string
          nullable: true
          example: '2026-10-08T09:00:00Z'
        provider_used:
          type: string
          example: chainalysis
      required:
        - screen_id
        - score
        - sanctioned
        - signals
        - listings
        - attribution
        - exposures
        - totals
        - data_as_of
        - provider_used
    EvidenceSignalDto:
      type: object
      properties:
        signal:
          type: string
          example: eu-sanctioned
          description: Range signal id (GET /v2/risk/signals).
        name:
          type: string
          nullable: true
          example: EU Sanctioned
          description: Catalogue name; null for a behaviour or an unknown id.
        pillar:
          type: string
          enum:
            - attribution
            - exposure
            - behaviour
          example: exposure
        severity:
          type: string
          enum:
            - none
            - low
            - medium
            - high
            - severe
          example: severe
        summary:
          type: string
          example: >-
            1.24% of counterparty volume is eu-sanctioned, crossing the 1%
            (severe) threshold.
        confidence:
          type: number
          nullable: true
          example: null
          minimum: 0
          maximum: 100
        rule:
          nullable: true
          type: object
          allOf:
            - $ref: '#/components/schemas/EvidenceSignalRuleDto'
      required:
        - signal
        - name
        - pillar
        - severity
        - summary
        - confidence
        - rule
    EvidenceListingDto:
      type: object
      properties:
        authority:
          type: string
          nullable: true
          example: OFAC
        program:
          type: string
          nullable: true
          example: SDN
        list_key:
          type: string
          nullable: true
          example: us_ofac_sdn
        listed_at:
          type: string
          nullable: true
          example: '2022-04-14'
        delisted_at:
          type: string
          nullable: true
          example: null
      required:
        - authority
        - program
        - list_key
        - listed_at
        - delisted_at
    EvidenceAttributionDto:
      type: object
      properties:
        name:
          type: string
          nullable: true
          example: Lazarus Group
        category:
          type: string
          enum:
            - sanctions
            - special-measures
            - terrorism-financing
            - child-abuse-material
            - mixer
            - darknet
            - theft
            - ransomware
            - malware
            - extortion
            - scam
            - illicit-actor
            - blacklisted
            - high-risk-exchange
            - high-risk-jurisdiction
            - gambling
            - law-enforcement
            - exchange
            - dex
            - defi
            - bridge
            - token-contract
            - smart-contract
            - mining-pool
            - donation
            - service
            - wallet-provider
            - payment-processor
            - burn
            - unknown
          example: sanctions
        role:
          type: string
          enum:
            - owner
            - user
            - cluster
            - label
          example: owner
        polarity:
          type: string
          enum:
            - risk
            - mitigating
            - informational
          example: risk
        confidence:
          type: number
          nullable: true
          example: 98
          minimum: 0
          maximum: 100
      required:
        - name
        - category
        - role
        - polarity
        - confidence
    EvidenceExposureDto:
      type: object
      properties:
        name:
          type: string
          nullable: true
          example: Tornado Cash
        category:
          type: string
          enum:
            - sanctions
            - special-measures
            - terrorism-financing
            - child-abuse-material
            - mixer
            - darknet
            - theft
            - ransomware
            - malware
            - extortion
            - scam
            - illicit-actor
            - blacklisted
            - high-risk-exchange
            - high-risk-jurisdiction
            - gambling
            - law-enforcement
            - exchange
            - dex
            - defi
            - bridge
            - token-contract
            - smart-contract
            - mining-pool
            - donation
            - service
            - wallet-provider
            - payment-processor
            - burn
            - unknown
          example: mixer
        direction:
          type: string
          enum:
            - incoming
            - outgoing
            - both
          example: incoming
        hop:
          type: string
          enum:
            - ownership
            - direct
            - indirect
            - unknown
          example: direct
        share:
          type: number
          nullable: true
          example: 0.123
          description: Share (0–1) of `share_basis`.
        share_basis:
          type: string
          nullable: true
          enum:
            - total-volume
            - direction-volume
            - composition
          example: total-volume
        usd:
          type: number
          nullable: true
          example: 45210
      required:
        - name
        - category
        - direction
        - hop
        - share
        - share_basis
        - usd
    EvidenceTotalsDto:
      type: object
      properties:
        incoming_usd:
          type: number
          example: 367000
        outgoing_usd:
          type: number
          example: 120000
        flagged_incoming_usd:
          type: number
          example: 45210
        flagged_outgoing_usd:
          type: number
          example: 0
      required:
        - incoming_usd
        - outgoing_usd
        - flagged_incoming_usd
        - flagged_outgoing_usd
    EvidenceSignalRuleDto:
      type: object
      properties:
        name:
          type: string
          nullable: true
          example: Sanctions exposure
        threshold:
          type: string
          nullable: true
          example: 1% (severe)
      required:
        - name
        - threshold
  securitySchemes:
    Authorization:
      type: apiKey
      in: header
      name: X-API-KEY
      description: Authorization method required to allow user to access the api endpoints.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.