Delete a relationship
/relationships/{relationship_uuid}
Soft-delete a relationship by its UUID. The record is hidden from the API (it is no longer
returned by the list endpoint) but remains in the database during a recovery window. The
deleted relationship is returned in the response as confirmation.
Example Request
DELETERequest Schema
relationship_uuid
The relationship UUID
Available Response Data
13 Data Pointsuuid uuid
The relationship's UUID
relationship_type enum
The type of relationship: spouse_of, director_of, shareholder_of, trustee_of, beneficiary_of, parent_of, …
forward_label string (Human-readable label when read from the from entity (e.g. "Director of"))
inverse_label string (Human-readable label when read from the to entity (e.g. "Has director"))
symmetric boolean
When true the relationship reads the same from both sides
from_entity_uuid uuid
UUID of the entity the relationship is recorded from
to_entity_uuid uuid
UUID of the entity the relationship points to
percentage_ownership number (Ownership percentage (0-100) for relationship types that support it (such as shareholder_of, partner_in and owner_of))
source string (How the relationship was recorded (e.g. manual, workflow, report, kyb_discovery, import))
effective_from string (Optional date from which the relationship is effective (YYYY-MM-DD))
effective_to string (Optional date the relationship is effective until (YYYY-MM-DD))
comment string
Optional free-text comment describing the relationship
api_reference uuid
unique request identifier for log tracing and audit
API Data Scale & Coverage tag
Unmatched data depth to power your compliance and verification workflows.
Sandbox Environment
Build and test against a sandbox account. Sandbox is a separate account with its own UUID and its own API keys, and the environment is fixed at the account level, so you cannot switch an existing key between live and sandbox with a parameter or header. Both share the same base URL, so the account behind your key is what determines which environment you are in. GET /v1/account returns an environment field of live or sandbox, and that is the authoritative answer.
Calls on a sandbox key are not billed. Every endpoint, response shape, error envelope, idempotency and rate-limit behaviour mirrors live, so the only change when you move to production should be the credentials. Sandbox accounts are provisioned by your Global Data account manager.
Technical Use Cases tag
Removing a record from day-to-day workflows
Take a relationship out of active lists when it is no longer relevant. The delete is a soft delete: the record is hidden from the API and the portal but retained for compliance.
Recoverable for 30 days
A soft-deleted record can be restored from the portal within 30 days. After that window it is eligible for permanent removal.
Prefer archiving where you need to keep it
Where a record must stay accessible for audit or historical reporting, archive it instead. Archived records are retained indefinitely and are not subject to the 30-day window.
Compliance & Security tag
Enterprise-grade infrastructure audited against the standards your regulators require.
Common Questions tag
Everything you need to know about implementation details and compliance infrastructure.
gavel Compliance
Is the record permanently removed?
add
Is the record permanently removed?
No. Every DELETE in this API is a soft delete, because WatchEye retains a record of every entity, program, monitor and note for compliance and audit purposes.
A soft-deleted record disappears from list endpoints, and its own GET returns 404. The original DELETE returns the deleted record once as confirmation; subsequent calls return 404.
Deleted records can be restored from the portal within 30 days. There is no API equivalent of the restore action. After 30 days they are eligible for permanent removal. If you need to keep a record beyond that window, archive it instead.
rocket_launch Implementation
What are the rate limits?
add
What are the rate limits?
600 requests per minute by default, enforced with a 60-second fixed window. Every response carries X-RateLimit-Limit and X-RateLimit-Remaining.
Exceeding the limit returns 429 Too Many Requests with a Retry-After header giving the number of seconds to wait, and X-RateLimit-Reset giving the reset timestamp. Schedule retries from Retry-After instead of a fixed sleep, and slow down before you hit zero, not after.
Higher limits can be arranged case by case through WatchEye support.
Ready to integrate Delete a relationship?
Talk to our team about credentials, sandbox access and the right combination of endpoints for your workflow.