Counterparties

Add a counterparty

Adds a vendor, contractor or client, checked by the rules of the console's form and screened as one added there: the answer's riskLevel is the screening's verdict, or unscreened when screening could not finish. It is recorded in the ledger as create_counterparty with via: "api" and the key's id.

An address added through the API waits for a person. The agent pays nothing to it until an owner, admin or approver confirms it on Counterparties, so a key can add records but cannot point the agent's payments at a new address.

post/api/v1/counterparties

Request

Base URL: https://www.vestiarion.xyz
URL: https://www.vestiarion.xyz/api/v1/counterparties
Auth: HTTP bearer

Headers

Idempotency-Keystring

Makes a retry safe: up to 255 printable ASCII characters, unique to the record being added, such as its id in your own system. A repeat with the same key and the same body within 24 hours gets the first answer back, with Idempotent-Replayed: true, and adds nothing. The same key with a different body answers 409.

Request body

namestring required

2 to 160 characters.

role'vendor' | 'client' | 'contractor' required

vendor or contractor, whom the business pays, or client, who pays the business.

addressstring

Where the agent pays it. An address added through the API waits for a person in the workspace to confirm it on Counterparties; until then the agent pays nothing to it.

The chain the address receives on. Defaults to the workspace's own chain: ARC-TESTNET on Arc testnet, ARC on Arc mainnet. Only a chain the workspace's network pays on is accepted (on Arc mainnet, BASE besides its own), and only a vendor can be paid on another chain than the workspace's own.

jurisdictionstring

Where it is based, up to 80 characters; screening uses it.

noticeEmailstring

Where it is emailed once a payment to it is confirmed.

Response

Created

Changes

No recorded changes to this operation across all 1 revision of this API.