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·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

401Unauthorized - Missing/invalid token or no access to this business

Schema: ErrorResponse

errorstringrequired: Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequired: Human-readable explanation, safe to show to end users.
codestringrequired: Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstring: Correlation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobject: Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

403Forbidden - Insufficient permissions

Schema: ErrorResponse

errorstringrequired: Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequired: Human-readable explanation, safe to show to end users.
codestringrequired: Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstring: Correlation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobject: Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

422Validation Error

Schema: ErrorResponse

errorstringrequired: Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequired: Human-readable explanation, safe to show to end users.
codestringrequired: Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstring: Correlation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobject: Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

Code samples

POST/api/v1/counterparty-aliases

bash

curl -X POST 'https://api.ondayzero.com/api/v1/counterparty-aliases' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "display_name": "string"
}'