Create Counterparty

Creates a counterparty, optionally with payment accounts.

Identity and account ownership verification evidence is optional. Zepto
stores the evidence provided without attempting to validate it.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length between 1 and 64
^[A-Za-z0-9\-._~]+$

A supplied unique ID, unique within your account

uuid

The ID of the client the counterparty belongs to. Supply the sub-client's ID for counterparties of agreements initiated on its behalf.

identity
object
required

The verifiable identity of the counterparty, separate from any of their payment accounts

payment_accounts
array of objects
payment_accounts
metadata
object | null

Use for your custom data. A place to store any miscellaneous information your system may need in regards to the record you are creating. This will be included in associated webhook payloads under the resource_metadata key. Nested values (i.e., objects and arrays) are not allowed. The maximum size of this parameter is 2kb.

Headers
string
^\d{8}$
Defaults to 20250101

API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.

Responses

403

forbidden

500

Internal Server Error

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json