Get a counterparty
/api/v2/counterparties/{id}{id} is the counterparty id or your customId. Needs counterparties:read.
Path Parameters
The counterparty id (counterparty_…) or your customId.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/v2/counterparties/counterparty_0e4ba886-0bfe-4b6a-ae2e-d6d9d135dd1e"{ "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"}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.
Update a counterparty PATCH
An omitted field is unchanged; a nested object is replaced as a whole and `null` clears it. A change to the address, payment method, or tax data moves every `approved` payout to this counterparty back to `created`. Needs `counterparties:write`.