Get counterparty list

Retrieves a paginated list of counterparties (business partners, clients, or related entities) with comprehensive filtering options and detailed profile information.

Endpoint

GET /v2/counterparty

Link

Gateway APIstagep.tst-apidmndelss.com

Request

Query Parameters

All parameters are optional. Use them to filter the counterparty list.

Parameter	Type	Description	Example
counterpartyId	string	Filter by counterparty ID.	"cp_12345"
counterpartyName	string	Filter by counterparty name.	"Tech Supplies"
customerId	string	Filter by customer ID.	"cust_67890"
customerName	string	Filter by customer name.	"John Doe"
fromCreatedAt	string	Filter from creation date (ISO 8601).	"2024-01-01T00:00:00Z"
toCreatedAt	string	Filter to creation date (ISO 8601).	"2024-12-31T23:59:59Z"
meta.page	integer	Page number (starts from 0).	0
meta.pageSize	integer	Items per page.	20

Headers

Key	Value	Required
Authorization	123	Yes
Accept	application/json	Yes

---

Response (200 OK)

Returns a paginated list of counterparties with complete details.

Response Fields

1. Meta (Pagination)

Field	Type	Description	Example
pageSize	integer	Items per page.	20
page	integer	Current page (0-indexed).	0
total	string	Total items count.	"150"

2. Items (Counterparty Array)

Field	Type	Description	Example
id	string	Counterparty unique ID.	"cp_12345"
description	string	Counterparty description.	"Primary electronics supplier"
createdAt	string	Creation timestamp.	"2024-01-15T10:30:00Z"
updatedAt	string	Last update timestamp.	"2024-05-20T14:45:00Z"

3. Customer Object

Field	Type	Description	Example
id	string	Customer ID.	"cust_67890"
name	string	Customer name.	"John Doe"
phone	string	Customer phone.	"[phone]"
email	string	Customer email.	"[email protected]"
status	string	Customer status: - NEW - READY_FOR_MODERATION - MODERATED - VERIFY - ACCEPT - REJECT - BANNED	"ACCEPT"

4. Profile Object

Field	Type	Description	Required	Example
name	string	Legal name.	Yes	"Tech Supplies Corp"
email	string	Contact email.	No	"[email protected]"
phoneNumber	string	Contact phone.	No	"[phone]"
taxNumber	string	Tax ID number.	No	"TAX-US-12345"
dateOfBirth	string	Date of birth/incorporation.	No	"1985-05-15T00:00:00Z"
website	string	Company website.	No	"https://techsupplies.com"
lastname	string	Last name (individuals).	No	"Smith"

5. Address Object

Field	Type	Description	Required	Example
addressLine1	string	Primary address.	Yes	"123 Main Street"
addressLine2	string	Suite/floor.	No	"Suite 500"
addressLine3	string	Additional info.	No	"Building B"
city	string	City.	No	"New York"
stateIso	string	State code.	No	"NY"
countryIso	string	Country code.	No	"US"
postalCode	string	Postal code.	No	"10001"
unitNumber	string	Unit number.	No	"5A"

6. AdditionalInfo Object

Field	Type	Description	Allowed Values	Example
type	string	Legal structure.	INDIVIDUAL, CORPORATION	"CORPORATION"
businessLine	string	Industry type.	PLB_AUTOMOTIVE, PLB_RETAIL, PLB_HIGH_TECH_SOFTWARE_TELECOMS, etc.	"PLB_HIGH_TECH_SOFTWARE_TELECOMS"
relationship	string	Business relationship.	PRC_SUPPLIER, PRC_CUSTOMER, PRC_BUSINESS_PARTNER, etc.	"PRC_SUPPLIER"

Example Response:

json

{
  "meta": {
    "pageSize": 20,
    "page": 0,
    "total": "150"
  },
  "items": [
    {
      "id": "cp_12345",
      "customer": {
        "id": "cust_67890",
        "name": "John Doe",
        "phone": "[phone]",
        "email": "[email protected]",
        "status": "ACCEPT"
      },
      "description": "Primary electronics supplier",
      "profile": {
        "name": "Tech Supplies Corp",
        "email": "[email protected]",
        "phoneNumber": "[phone]",
        "taxNumber": "TAX-US-12345",
        "dateOfBirth": "1985-05-15T00:00:00Z",
        "address": {
          "addressLine1": "123 Main Street",
          "addressLine2": "Suite 500",
          "addressLine3": "Building B",
          "city": "New York",
          "stateIso": "NY",
          "countryIso": "US",
          "postalCode": "10001",
          "unitNumber": "5A"
        },
        "website": "https://techsupplies.com",
        "additionalInfo": {
          "type": "CORPORATION",
          "businessLine": "PLB_HIGH_TECH_SOFTWARE_TELECOMS",
          "relationship": "PRC_SUPPLIER"
        },
        "lastname": "Smith"
      },
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-05-20T14:45:00Z"
    }
  ]
}

---

Examples

Request

bash

curl -X GET 'https://stagep.tst-apidmndelss.com/v2/counterparty?meta.page=0&meta.pageSize=10&customerName=John' \
  -H 'Authorization: 123' \
  -H 'Accept: application/json'

Individual Counterparty Example

Response:

json

{
  "meta": {
    "pageSize": 10,
    "page": 0,
    "total": "25"
  },
  "items": [
    {
      "id": "cp_67890",
      "customer": {
        "id": "cust_12345",
        "name": "Jane Smith",
        "phone": "[phone]",
        "email": "[email protected]",
        "status": "MODERATED"
      },
      "description": "Freelance consultant",
      "profile": {
        "name": "Jane",
        "email": "[email protected]",
        "phoneNumber": "[phone]",
        "taxNumber": "UK123456789",
        "dateOfBirth": "1990-08-20T00:00:00Z",
        "address": {
          "addressLine1": "45 Park Lane",
          "addressLine2": "Flat 3B",
          "city": "London",
          "countryIso": "GB",
          "postalCode": "W1K 7AA"
        },
        "website": "https://janeconsulting.com",
        "additionalInfo": {
          "type": "INDIVIDUAL",
          "businessLine": "PLB_CONSULTING_PROFESSIONAL_SERVICES",
          "relationship": "PRC_BUSINESS_PARTNER"
        },
        "lastname": "Smith"
      },
      "createdAt": "2024-03-10T14:20:00Z",
      "updatedAt": "2024-05-15T09:30:00Z"
    }
  ]
}

---

Error Responses

1. Unauthorized:

   json

   { "error": "Unauthorized" }

2. Invalid Parameters:

   json

   { "error": "Invalid query parameters" }

---

Notes

• Pagination: Use meta.page and meta.pageSize for large datasets
• Filtering: Combine multiple filters for precise searches
• Address Validation: addressLine1 is required for KYC compliance
• Business Lines: Extensive industry classification available
• Relationships: Defines the business context of the counterparty

Common Use Cases:

• Supplier/vendor management
• Client portfolio review
• Compliance auditing
• Relationship mapping

Request sample

Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOjE2NCwiZXhwIjoxNzYxNjU0NzI1LCJrZXkiOiI1Y2ZiOGZjN2RmYjk4ZjVkYmIyZTgwNTVkZWFhN2U2Zjk4MzEyYmE3Iiwib3RwX3ZlcmlmaWVkIjpmYWxzZX0.IFznwinEJGqxZOXue1XxNenO8Ap8oVCpbzsAx9jKC8U
counterpartyId: string
counterpartyName: string
customerId: Dnewcvn-euuI-vG0FZCRDjLXS
customerName: string
fromCreatedAt: string
meta.page: integer
meta.pageSize: integer
toCreatedAt: string

Response sample

{
  "meta": {
    "pageSize": 6,
    "page": 0,
    "total": "6"
  },
  "items": [
    {
      "counterpartyId": "DDpmgVt-kKiC-j6kTFUi0DYoo",
      "customer": {
        "id": "Dnewcvn-euuI-vG0FZCRDjLXS",
        "name": "Test Eugen Test Eugen",
        "phone": "",
        "email": "",
        "status": "ACCEPT"
      },
      "description": "string",
      "profile": {
        "name": "Test recipient 123",
        "email": "string",
        "phoneNumber": "string",
        "taxNumber": "123123",
        "dateOfBirth": "2019-08-24T14:15:22Z",
        "address": {
          "addressLine1": "Test",
          "addressLine2": "Test",
          "addressLine3": "string",
          "city": "NY",
          "stateIso": "NY",
          "countryIso": "US",
          "postalCode": "0000",
          "unitNumber": "string"
        },
        "website": "string",
        "additionalInfo": {
          "type": "INDIVIDUAL",
          "businessLine": "PLB_ARTS_AND_ANTIQUES",
          "relationship": "PRC_SPOUSE"
        },
        "lastname": "Test"
      },
      "createdAt": "2025-08-11T09:51:58Z",
      "updatedAt": "2025-08-11T09:51:58Z"
    },
    {
      "counterpartyId": "DMhmXb9-w7xD-Uf9scYzRW0Qw",
      "customer": {
        "id": "Dnewcvn-euuI-vG0FZCRDjLXS",
        "name": "Test Eugen Test Eugen",
        "phone": "",
        "email": "",
        "status": "ACCEPT"
      },
      "description": "test",
      "profile": {
        "name": "testAPI",
        "email": "string",
        "phoneNumber": "string",
        "taxNumber": "string",
        "dateOfBirth": "2019-08-24T14:15:22Z",
        "address": {
          "addressLine1": "string",
          "addressLine2": "string",
          "addressLine3": "string",
          "city": "string",
          "stateIso": "string",
          "countryIso": "string",
          "postalCode": "string",
          "unitNumber": "string"
        },
        "website": "string",
        "additionalInfo": {
          "type": "INDIVIDUAL",
          "businessLine": "PLB_ARTS_AND_ANTIQUES",
          "relationship": "PRC_SPOUSE"
        },
        "lastname": "string"
      },
      "createdAt": "2025-04-29T05:44:37Z",
      "updatedAt": "2025-04-29T05:44:37Z"
    },
    {
      "counterpartyId": "DwLxwtt-zxiL-AsUmMYJKMnXx",
      "customer": {
        "id": "Dnewcvn-euuI-vG0FZCRDjLXS",
        "name": "Test Eugen Test Eugen",
        "phone": "",
        "email": "",
        "status": "ACCEPT"
      },
      "description": "test",
      "profile": {
        "name": "testAPI",
        "email": "string",
        "phoneNumber": "string",
        "taxNumber": "string",
        "dateOfBirth": "2019-08-24T14:15:22Z",
        "address": {
          "addressLine1": "string",
          "addressLine2": "string",
          "addressLine3": "string",
          "city": "string",
          "stateIso": "string",
          "countryIso": "string",
          "postalCode": "string",
          "unitNumber": "string"
        },
        "website": "string",
        "additionalInfo": {
          "type": "INDIVIDUAL",
          "businessLine": "PLB_ARTS_AND_ANTIQUES",
          "relationship": "PRC_SPOUSE"
        },
        "lastname": "string"
      },
      "createdAt": "2025-04-29T05:44:29Z",
      "updatedAt": "2025-04-29T05:44:29Z"
    },
    {
      "counterpartyId": "DlKei8y-5dOd-M69tp7Gd8K8G",
      "customer": {
        "id": "Dnewcvn-euuI-vG0FZCRDjLXS",
        "name": "Test Eugen Test Eugen",
        "phone": "",
        "email": "",
        "status": "ACCEPT"
      },
      "description": "string",
      "profile": {
        "name": "Test Finvoka",
        "email": "string",
        "phoneNumber": "string",
        "taxNumber": "string",
        "dateOfBirth": "2019-08-24T14:15:22Z",
        "address": {
          "addressLine1": "string",
          "addressLine2": "string",
          "addressLine3": "string",
          "city": "NY",
          "stateIso": "US",
          "countryIso": "US",
          "postalCode": "string",
          "unitNumber": "string"
        },
        "website": "string",
        "additionalInfo": {
          "type": "INDIVIDUAL",
          "businessLine": "PLB_ARTS_AND_ANTIQUES",
          "relationship": "PRC_SPOUSE"
        },
        "lastname": "string"
      },
      "createdAt": "2025-03-24T15:47:05Z",
      "updatedAt": "2025-03-24T15:47:05Z"
    },
    {
      "counterpartyId": "DZoDX6z-XIba-eTiF27sCEOho",
      "customer": {
        "id": "Dnewcvn-euuI-vG0FZCRDjLXS",
        "name": "Test Eugen Test Eugen",
        "phone": "",
        "email": "",
        "status": "ACCEPT"
      },
      "description": "",
      "profile": {
        "name": "",
        "email": "",
        "phoneNumber": "",
        "taxNumber": "",
        "dateOfBirth": "1970-01-01T00:00:00Z",
        "address": {
          "addressLine1": "",
          "addressLine2": "",
          "addressLine3": "",
          "city": "",
          "stateIso": "",
          "countryIso": "",
          "postalCode": "",
          "unitNumber": ""
        },
        "website": "",
        "additionalInfo": {
          "type": "CORPORATION",
          "businessLine": "PLB_ARTS_AND_ANTIQUES",
          "relationship": "PRC_SPOUSE"
        },
        "lastname": ""
      },
      "createdAt": "2025-02-13T08:25:09Z",
      "updatedAt": "2025-02-13T08:25:09Z"
    },
    {
      "counterpartyId": "DkCSHAN-B9nW-HoakBCwCq36I",
      "customer": {
        "id": "Dnewcvn-euuI-vG0FZCRDjLXS",
        "name": "Test Eugen Test Eugen",
        "phone": "",
        "email": "",
        "status": "ACCEPT"
      },
      "description": "",
      "profile": {
        "name": "Test Eugen USD",
        "email": "Test Eugen USD",
        "phoneNumber": "111",
        "taxNumber": "Test Eugen USD",
        "dateOfBirth": "1970-01-01T00:00:00Z",
        "address": {
          "addressLine1": "Test Eugen USD",
          "addressLine2": "Test Eugen USD",
          "addressLine3": "Test Eugen USD",
          "city": "Test Eugen USD",
          "stateIso": "Test Eugen USD",
          "countryIso": "Test Eugen USD",
          "postalCode": "Test Eugen USD",
          "unitNumber": "Test Eugen USD"
        },
        "website": "Test Eugen USD",
        "additionalInfo": {
          "type": "INDIVIDUAL",
          "businessLine": "PLB_TECHNICAL_SUPPORT",
          "relationship": "PRC_SPOUSE"
        },
        "lastname": ""
      },
      "createdAt": "2025-01-28T09:03:54Z",
      "updatedAt": "2025-01-28T12:19:35Z"
    }
  ]
}