# Get Counterparties

This endpoint allows you to list all the counterparties associated with a customer's pocket. You can filter the results by
counterparty type (ach, wire, international_wire, on_us, etc.) and status (PENDING, LINKED, UNLINKED, etc.).

It returns a paginated list of Counterparty objects. The response includes a next_page token for retrieving more results.

Endpoint: GET /api/v2/counterparties/
Version: Version: 5153994b
Security: CodeBearer

## Query parameters:

  - `cursor` (string)

  - `limit` (integer)

  - `type` (any)

  - `status` (any)

## Response 200 fields (application/json):

  - `prev_page` (any)

  - `next_page` (any)

  - `items` (array, required) — one of (discriminator: type):
    - ach:
      - `id` (string, required)
      - `time_created` (string, required)
      - `status` (string, required)
        Enum: "PENDING", "FAILED", "LINKED", "UNLINKED", "CLOSED"
      - `verification` (any, required) — one of (discriminator: type):
        - incoming_wire:
          - `id` (string, required)
          - `description` (any, required)
          - `type` (string, required)
          - `wire_id` (string, required)
          - `status` (string, required)
            Enum: "PENDING_REVIEW", "APPROVED", "REJECTED"
        - micro_deposits:
          - `id` (string, required)
          - `description` (any, required)
          - `type` (string, required)
          - `status` (any, required)
          - `verification_failure_count` (integer, required)
        - name_match:
          - `id` (string, required)
          - `description` (any, required)
          - `type` (string, required)
        - plaid:
          - `id` (string, required)
          - `description` (any, required)
          - `type` (string, required)
          - `status` (any, required)
          - `account_number_masked` (string, required)
        - pre_verified:
          - `id` (string, required)
          - `description` (any, required)
          - `type` (string, required)
          - `status` (string, required)
            Enum: same as `status` in "incoming_wire" (3 values)
        - supporting_documents:
          - `id` (string, required)
          - `description` (any, required)
          - `type` (string, required)
          - `supporting_documents` (array, required)
          - `supporting_documents.id` (string, required)
          - `supporting_documents.document_id` (string, required)
          - `supporting_documents.status` (string, required)
            Enum: same as `status` in "incoming_wire" (3 values)
          - `status` (string, required)
            Enum: same as `status` in "incoming_wire" (3 values)
        - unverified:
          - `id` (string, required)
          - `description` (any, required)
          - `type` (string, required)
      - `type` (string, required)
      - `counterparty_name` (string, required)
      - `institution_name` (any, required)
      - `routing_number` (any, required)
      - `account_number` (any, required)
      - `account_type` (string, required)
        Enum: "CHECKING", "SAVINGS"
      - `object_type` (string, required)
    - crypto_wallet_address:
      - `id` (string, required)
      - `time_created` (string, required)
      - `status` (string, required)
        Enum: same as `status` in "ach" (5 values)
      - `verification` (any, required) — one of (discriminator: type):
        - incoming_wire:
          - `id` (string, required)
          - `description` (any, required)
          - `type` (string, required)
          - `wire_id` (string, required)
          - `status` (string, required)
            Enum: same as `status` in "incoming_wire" (3 values)
        - micro_deposits:
          - `id` (string, required)
          - `description` (any, required)
          - `type` (string, required)
          - `status` (any, required)
          - `verification_failure_count` (integer, required)
        - name_match:
          - `id` (string, required)
          - `description` (any, required)
          - `type` (string, required)
        - plaid:
          - `id` (string, required)
          - `description` (any, required)
          - `type` (string, required)
          - `status` (any, required)
          - `account_number_masked` (string, required)
        - pre_verified:
          - `id` (string, required)
          - `description` (any, required)
          - `type` (string, required)
          - `status` (string, required)
            Enum: same as `status` in "incoming_wire" (3 values)
        - supporting_documents:
          - `id` (string, required)
          - `description` (any, required)
          - `type` (string, required)
          - `supporting_documents` (array, required)
          - `supporting_documents.id` (string, required)
          - `supporting_documents.document_id` (string, required)
          - `supporting_documents.status` (string, required)
            Enum: same as `status` in "incoming_wire" (3 values)
          - `status` (string, required)
            Enum: same as `status` in "incoming_wire" (3 values)
        - unverified:
          - `id` (string, required)
          - `description` (any, required)
          - `type` (string, required)
      - `counterparty_name` (string, required)
      - `type` (string, required)
      - `wallet_address` (string, required)
      - `chain` (string, required)
      - `object_type` (string, required)
    - international_wire:
      - `id` (string, required)
      - `time_created` (string, required)
      - `status` (string, required)
        Enum: same as `status` in "ach" (5 values)
      - `verification` (any, required) — one of (discriminator: type):
        - incoming_wire:
          - `id` (string, required)
          - `description` (any, required)
          - `type` (string, required)
          - `wire_id` (string, required)
          - `status` (string, required)
            Enum: same as `status` in "incoming_wire" (3 values)
        - micro_deposits:
          - `id` (string, required)
          - `description` (any, required)
          - `type` (string, required)
          - `status` (any, required)
          - `verification_failure_count` (integer, required)
        - name_match:
          - `id` (string, required)
          - `description` (any, required)
          - `type` (string, required)
        - plaid:
          - `id` (string, required)
          - `description` (any, required)
          - `type` (string, required)
          - `status` (any, required)
          - `account_number_masked` (string, required)
        - pre_verified:
          - `id` (string, required)
          - `description` (any, required)
          - `type` (string, required)
          - `status` (string, required)
            Enum: same as `status` in "incoming_wire" (3 values)
        - supporting_documents:
          - `id` (string, required)
          - `description` (any, required)
          - `type` (string, required)
          - `supporting_documents` (array, required)
          - `supporting_documents.id` (string, required)
          - `supporting_documents.document_id` (string, required)
          - `supporting_documents.status` (string, required)
            Enum: same as `status` in "incoming_wire" (3 values)
          - `status` (string, required)
            Enum: same as `status` in "incoming_wire" (3 values)
        - unverified:
          - `id` (string, required)
          - `description` (any, required)
          - `type` (string, required)
      - `type` (string, required)
      - `counterparty_name` (any, required) — one of (discriminator: type):
        - business:
          - `business_name` (string, required)
            The name of the business counterparty.
          - `type` (string, required)
        - individual:
          - `first_name` (string, required)
          - `last_name` (string, required)
          - `type` (string, required)
      - `address` (object, required)
      - `address.street_address` (string, required)
        Street address
      - `address.street_address2` (any)
        Apartment, Suite, Box number, etc.
      - `address.city` (string, required)
        City / Town
      - `address.postal_code` (string, required)
        Postal code / ZIP code
      - `address.state` (string, required)
        State (Postal Abbreviations. Example: "AL", "NJ", "OH")
      - `address.country` (string, required)
        A ISO-3166 Alpha-2 country code (Abbreviated. Example: "US")
      - `swift_bic` (string, required)
      - `identifier` (string, required)
      - `identifier_type` (string)
        Enum: "iban", "local"
      - `bank_name` (string, required)
      - `wire_instructions` (any)
        Any additional wire instructions required for the wire to be processed correctly.
      - `ownership_type` (any)
        Relationship of the counterparty to the account holder. FIRST_PARTY means the counterparty is owned by the account holder, THIRD_PARTY means it is owned by a different entity.
      - `object_type` (string, required)
    - on_us:
      - `id` (string, required)
      - `time_created` (string, required)
      - `status` (string, required)
        Enum: same as `status` in "ach" (5 values)
      - `verification` (any, required) — one of (discriminator: type):
        - incoming_wire:
          - `id` (string, required)
          - `description` (any, required)
          - `type` (string, required)
          - `wire_id` (string, required)
          - `status` (string, required)
            Enum: same as `status` in "incoming_wire" (3 values)
        - micro_deposits:
          - `id` (string, required)
          - `description` (any, required)
          - `type` (string, required)
          - `status` (any, required)
          - `verification_failure_count` (integer, required)
        - name_match:
          - `id` (string, required)
          - `description` (any, required)
          - `type` (string, required)
        - plaid:
          - `id` (string, required)
          - `description` (any, required)
          - `type` (string, required)
          - `status` (any, required)
          - `account_number_masked` (string, required)
        - pre_verified:
          - `id` (string, required)
          - `description` (any, required)
          - `type` (string, required)
          - `status` (string, required)
            Enum: same as `status` in "incoming_wire" (3 values)
        - supporting_documents:
          - `id` (string, required)
          - `description` (any, required)
          - `type` (string, required)
          - `supporting_documents` (array, required)
          - `supporting_documents.id` (string, required)
          - `supporting_documents.document_id` (string, required)
          - `supporting_documents.status` (string, required)
            Enum: same as `status` in "incoming_wire" (3 values)
          - `status` (string, required)
            Enum: same as `status` in "incoming_wire" (3 values)
        - unverified:
          - `id` (string, required)
          - `description` (any, required)
          - `type` (string, required)
      - `type` (string, required)
      - `counterparty_name` (string, required)
      - `account_number` (string, required)
        Represents the Jiko network address of the pocket.
      - `display_name` (any)
      - `object_type` (string, required)
    - wire:
      - `id` (string, required)
      - `time_created` (string, required)
      - `status` (string, required)
        Enum: same as `status` in "ach" (5 values)
      - `verification` (any, required) — one of (discriminator: type):
        - incoming_wire:
          - `id` (string, required)
          - `description` (any, required)
          - `type` (string, required)
          - `wire_id` (string, required)
          - `status` (string, required)
            Enum: same as `status` in "incoming_wire" (3 values)
        - micro_deposits:
          - `id` (string, required)
          - `description` (any, required)
          - `type` (string, required)
          - `status` (any, required)
          - `verification_failure_count` (integer, required)
        - name_match:
          - `id` (string, required)
          - `description` (any, required)
          - `type` (string, required)
        - plaid:
          - `id` (string, required)
          - `description` (any, required)
          - `type` (string, required)
          - `status` (any, required)
          - `account_number_masked` (string, required)
        - pre_verified:
          - `id` (string, required)
          - `description` (any, required)
          - `type` (string, required)
          - `status` (string, required)
            Enum: same as `status` in "incoming_wire" (3 values)
        - supporting_documents:
          - `id` (string, required)
          - `description` (any, required)
          - `type` (string, required)
          - `supporting_documents` (array, required)
          - `supporting_documents.id` (string, required)
          - `supporting_documents.document_id` (string, required)
          - `supporting_documents.status` (string, required)
            Enum: same as `status` in "incoming_wire" (3 values)
          - `status` (string, required)
            Enum: same as `status` in "incoming_wire" (3 values)
        - unverified:
          - `id` (string, required)
          - `description` (any, required)
          - `type` (string, required)
      - `type` (string, required)
      - `counterparty_name` (any, required) — one of (discriminator: type):
        - business:
          - `business_name` (string, required)
            The name of the business counterparty.
          - `type` (string, required)
        - individual:
          - `first_name` (string, required)
          - `last_name` (string, required)
          - `type` (string, required)
      - `address` (object, required)
      - `address.street_address` (string, required)
        Street address
      - `address.street_address2` (any)
        Apartment, Suite, Box number, etc.
      - `address.city` (string, required)
        City / Town
      - `address.postal_code` (string, required)
        Postal code / ZIP code
      - `address.state` (string, required)
        State (Postal Abbreviations. Example: "AL", "NJ", "OH")
      - `address.country` (string, required)
        A ISO-3166 Alpha-2 country code (Abbreviated. Example: "US")
      - `institution_name` (string, required)
      - `routing_number` (string, required)
      - `identifier` (string, required)
      - `identifier_code` (string, required)
        Enum: "SWIFT_BIC", "CHIPS_PARTICIPANT", "DIRECT_DEPOSIT_ACCOUNT", "FED_ROUTING_NUMBER", "SWIFT_ID_AND_ACCOUNT_NUMBER", "CHIPS_IDENTIFIER", "PASSPORT_NUMBER", "TAX_IDENTIFICATION_NUMBER", "DRIVERS_LICENSE_NUMBER", "ALIEN_REGISTRATION_NUMBER", "CORPORATE_IDENTIFICATION", "OTHER_IDENTIFICATION"
      - `wire_instructions` (any)
        Any additional wire instructions required for the wire to be processed correctly.
      - `ownership_type` (any)
        Relationship of the counterparty to the account holder. FIRST_PARTY means the counterparty is owned by the account holder, THIRD_PARTY means it is owned by a different entity.
      - `object_type` (string, required)

  - `object_type` (string)

## Response 422 fields (application/json):

  - `detail` (array)

  - `detail.loc` (array, required)

  - `detail.msg` (string, required)

  - `detail.type` (string, required)

  - `detail.input` (any)

  - `detail.ctx` (object)