Subjects

Delete a reference face

DELETE https://api.xipid.org/subjects/{id}/reference-face

Deletes the reference face this brand enrolled, from every store; deleting one that is gone is not an error. With If-Match, it goes ahead only while the subject is as the brand last read it.

Scope: any live key of the brand.

Limits: 1,000 requests a minute per key and 2,000 requests a minute per source address; every answer says what is left in X-RateLimit-Remaining, and a refusal when to come back in Retry-After.

Idempotency: repeating it does what it did, and no more.

Changes: 2026-09-26: added.

Parameters

• id in the path, required, ULID

  XipID's id for the subject.

• If-Match a header, optional, string, at most 1,024 characters

  The ETag of the subject as the brand last read it, or a list of them: the change goes ahead only while the subject is as one says, and is refused 412 otherwise.

• Xip-Version a header, optional, string, one of the values below

  The version to answer in; when absent, the version the brand's org is pinned to.

  • 2026-09-26: The first version: challenges, subjects and events, and the signed outcome.

Answers

204 No Content

Deleted, or gone already.

Its headers: X-Request-Id, Xip-Version, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

Errors

• json_invalid, 400: The request body is not valid JSON.
• parameter_invalid, 400: The request contains invalid parameters.
• parameter_unknown, 400: The request contains a parameter this route does not take.
• version_invalid, 400: Xip-Version names no released version of this API.
• authentication_required, 401: Authentication is required.
• authentication_failed, 401: The credential is invalid, expired or revoked.
• insufficient_scope, 403: The credential does not allow this operation.
• resource_not_found, 404: No such resource.
• resource_conflict, 409: The resource's state conflicts with the request; read it again.
• precondition_failed, 412: If-Match does not match the resource's current ETag.
• content_too_large, 413: The request body is larger than this route accepts.
• media_type_unsupported, 415: This route does not accept that Content-Type.
• rate_limit_exceeded, 429: Too many requests; try again later.
• internal_error, 500: Something went wrong on our side.
• upstream_error, 502: A service XipID depends on failed.
• service_unavailable, 503: The service is temporarily unavailable.
• upstream_timeout, 504: A service XipID depends on did not answer in time.