# 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.
Each `Counterparty` object includes an optional `display_name` — a custom, human-friendly label that, when set, can be shown in place of the counterparty's default name to distinguish counterparties that belong to the same legal entity.

Endpoint: GET /api/v2/counterparties/
Version: Version: cf52545e
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)

  - `items.id` (string, required)

  - `items.time_created` (string, required)

  - `items.status` (string, required)
    Enum: "PENDING", "FAILED", "LINKED", "UNLINKED", "CLOSED"

  - `items.verification` (any, required)

  - `items.verification.id` (string, required)

  - `items.verification.description` (any, required)

  - `items.verification.type` (string, required)

  - `items.verification.supporting_documents` (array, required)

  - `items.verification.supporting_documents.id` (string, required)

  - `items.verification.supporting_documents.document_id` (string, required)

  - `items.verification.supporting_documents.status` (string, required)
    Enum: "PENDING_REVIEW", "APPROVED", "REJECTED"

  - `items.verification.status` (string, required)
    Enum: "PENDING_REVIEW", "APPROVED", "REJECTED"

  - `items.verification.wire_id` (string, required)

  - `items.verification.account_number_masked` (string, required)

  - `items.verification.verification_failure_count` (integer, required)

  - `items.display_name` (any)
    An optional custom display name for the counterparty, useful for distinguishing multiple counterparties that share the same legal name.

  - `items.type` (string, required)

  - `items.counterparty_name` (string, required)

  - `items.institution_name` (any, required)

  - `items.routing_number` (any, required)

  - `items.account_number` (any, required)

  - `items.account_type` (string, required)
    Enum: "CHECKING", "SAVINGS"

  - `items.object_type` (string, required)

  - `items.address` (object, required)

  - `items.address.street_address` (string, required)
    Street address

  - `items.address.street_address2` (any)
    Apartment, Suite, Box number, etc.

  - `items.address.city` (string, required)
    City / Town

  - `items.address.postal_code` (string, required)
    Postal code / ZIP code

  - `items.address.state` (string, required)
    State (Postal Abbreviations. Example: "AL", "NJ", "OH")

  - `items.address.country` (string, required)
    A ISO-3166 Alpha-2 country code (Abbreviated. Example: "US")

  - `items.identifier` (string, required)

  - `items.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"

  - `items.wire_instructions` (any)
    Any additional wire instructions required for the wire to be processed correctly.

  - `items.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.

  - `items.account_number` (string, required)
    Represents the Jiko network address of the pocket.

  - `items.swift_bic` (string, required)

  - `items.identifier_type` (string)
    Enum: "iban", "local"

  - `items.bank_name` (string, required)

  - `items.wallet_address` (string, required)

  - `items.chain` (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)