Sign in

v1

latestOpenAPI 3.1.02026-07-26165182724.7 KB
Counterparty

List counterparties by user

Returns counterparties for the given owner (userId or businessId) within the authenticated application.

Body filter may be SELF_HOSTED, VASP, or ALL (default behavior when omitted is no type filter — same effect as ALL). Pagination: omitted page defaults to 1; omitted limit defaults to 20 server-side.

post/counterparty

Request body

userIdstring uuid

User whose counterparties to list. Provide exactly one of userId or businessId.

businessIdstring uuid

Business whose counterparties to list. Provide exactly one of userId or businessId.

filter'SELF_HOSTED' | 'VASP' | 'ALL'

Restrict by counterparty type; omit or use ALL for no filter.

pageinteger

1-based page index (default 1 when omitted).

limitinteger

Page size (default 20 when omitted).

Example request

{
  "userId": "f714f7e8-6ba1-4802-81cc-12040113ff5b",
  "filter": "ALL",
  "page": 1,
  "limit": 10
}

Response

success

totalinteger required

Total matching rows for this user and application (before pagination).

pageinteger required

Current page number (1-based). Defaults to 1 when page is omitted from the request body.

Example response

{
  "page": 1,
  "total": 2,
  "counterparties": [
    {
      "counterpartyId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "userId": "8ae384b7-ce6b-4b00-a4ec-1bcb9a5e5d1d",
      "identityType": "CONSUMER",
      "counterpartyAddress": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
      "network": "Eth",
      "type": "SELF_HOSTED",
      "subType": "OWNED",
      "walletVerified": true,
      "createdAt": "2026-05-14T12:00:00.000Z",
      "updatedAt": "2026-05-14T12:00:00.000Z"
    },
    {
      "counterpartyId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
      "userId": "8ae384b7-ce6b-4b00-a4ec-1bcb9a5e5d1d",
      "identityType": "CONSUMER",
      "counterpartyAddress": "0x1111111111111111111111111111111111111111",
      "network": "Eth",
      "type": "VASP",
      "subType": "VASP",
      "counterpartyData": {
        "entityType": "LEGAL",
        "counterpartyVaspId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
      },
      "createdAt": "2026-05-13T09:30:00.000Z",
      "updatedAt": "2026-05-13T09:30:00.000Z"
    }
  ]
}