API Docs
API referenceCounterparties

List counterparties

GET/api/v2/counterparties

Newest first by createdAt, id as tie-breaker. A recipient-managed row that a team-managed row overrides (same email) is not listed. Needs counterparties:read.

Query Parameters

type?string

Only counterparties of this type.

Value in

  • "individual"
  • "organization"
country?string

Only counterparties with an address in this country.

Match^[A-Z]{2}$
payable?string

true lists only counterparties with an empty missing, false only the others.

Value in

  • "true"
  • "false"
paymentMethodType?string

Only counterparties whose saved payment method has this type, e.g. bank_iban.

email?string

a string that will be converted to lowercase

limit?between(1, 100)

Page size, 1 to 100. Default 20.

cursor?string

The nextCursor of the previous page. Opaque: never build or decode it.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v2/counterparties"
{  "object": "list",  "data": [    {      "object": "counterparty",      "id": "counterparty_0e4ba886-0bfe-4b6a-ae2e-d6d9d135dd1e",      "customId": "campaign-42",      "identity": {        "type": "individual",        "firstName": "string",        "lastName": "string"      },      "email": "jane@example.com",      "address": {        "line1": "string",        "line2": "string",        "city": "string",        "state": "string",        "postalCode": "string",        "country": "DE"      },      "paymentMethod": {        "type": "bank_iban",        "iban": "string",        "currency": "string"      },      "taxIdentity": {        "taxId": "string",        "vatNumber": "string",        "dateOfBirth": "2026-10-01",        "birthPlaceCity": "string",        "birthPlaceCountry": "DE",        "registrationNumber": "string"      },      "recipientManaged": true,      "missing": [        "address"      ],      "createdAt": "2026-09-24T10:00:00.000Z",      "updatedAt": "2026-09-24T10:00:00.000Z"    }  ],  "hasMore": true,  "nextCursor": "string"}

Pay counterparties in one request POST

Requests the transfer for up to 100 counterparty payouts. Every payout moves to `requested` in one transaction; settlement follows per payout as `payout.completed` or `payout.failed`. All or nothing: one failing item fails the request with that item's code and `error.index`, and nothing is applied. Needs `payouts:write`, plus `payouts:approve` when any payout is `failed`.

Create a counterparty POST

`taxIdentity` is checked against the rules of [`GET /countries`](https://www.talentir.com/docs/v2/reference/countries/countries.list) for the address country and the identity type. Without `paymentMethod` and `taxIdentity` the counterparty exists, and `missing` names what a direct payment still needs. Needs `counterparties:write`. > **Warning:** Talentir can change the tax rules, the settlement currencies, and the payout assets at any time, without prior notice. Do not hardcode them. Read the tax fields from [`GET /countries`](https://www.talentir.com/docs/v2/reference/countries/countries.list) and the currencies and assets from [`GET /payment-method-types`](https://www.talentir.com/docs/v2/reference/payment-method-types/payment-method-types.list) when you build the form.