Start free trial

Create or update a counterparty alias

POST/api/v1/counterparty-aliases

Create a counterparty alias, upserting when one already exists for the same counterparty.

Provide either registry_id (preferred — applies to every transaction linked to that registry entry) or a raw counterparty_name string for unlinked counterparties.

Operation ID: create_counterparty_alias_api_v1_counterparty_aliases_post·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Request body

Schema: CounterpartyAliasCreate

registry_idstring

Linked counterparty registry entry. Preferred — the alias then applies to every transaction linked to that entry, surviving raw-string variations.

counterparty_namestring

Raw counterparty string to match (case-insensitive) when the counterparty is not linked to the registry. Required when registry_id is absent.

display_namestringrequired

Name to display for this counterparty in this business.

Responses

201Successful Response

Schema: SuccessEnvelope_CounterpartyAliasResponse_

successboolean
messagestring
codestring
dataCounterpartyAliasResponse

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError
5 fields
locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject