Address book

List saved people and businesses

List the people and businesses your organization has identified before.

GET
/api/v2/counterparty-requests/parties

Returns people and businesses your organization has already identified as wallet owners, newest first. Name one in a wallet declaration with party THIRD_PARTY and its id, and supply only the details still missing.

Query Parameters

kind?string

Only people (INDIVIDUAL) or only businesses (ENTITY). Case-insensitive.

Value in"INDIVIDUAL" | "ENTITY"
search?string

Part of the name. Case and accents are ignored.

Lengthlength <= 250
limit?integer

Maximum number of results.

Default100
Range1 <= value <= 200

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://compose.finance/api/v2/counterparty-requests/parties"
{
  "items": [
    {
      "id": "clx0party0000000000000001",
      "kind": "INDIVIDUAL",
      "name": "Alex Example"
    }
  ]
}
{
  "error": "kind: Invalid enum value. Expected 'INDIVIDUAL' | 'ENTITY', received 'PERSON'"
}
{
  "error": "Unauthorized - Invalid or missing API key or session"
}
{
  "error": "Rate limit exceeded. Please try again later."
}

{
  "error": "Internal server error"
}