Skip to main content
PUT
Stops the hosted page from opening a link. Use it when a link went to the wrong person or the onboarding is cancelled.
Revoking does not refund a fee the customer already paid, and no endpoint does.A revoked link ignores every review that arrives afterwards, also for a check the customer had already submitted. The link stays EXPIRED, nothing is queued and no customer record changes, so a customer who passes that check later must be onboarded again with a new link. See A review settles once.
The link’s status becomes EXPIRED and expiresAt is set to the time of revocation. There is no separate revoked status, so a revoked link lists as EXPIRED. Nothing else changes. The customer record, a queued registration and any on-chain identity stay as they are. A wallet already registered through the link is removed with Revoke Identity. A COMPLETED link cannot be revoked. A REJECTED link can be, and revoking an EXPIRED link succeeds again.

Path Parameters

The link id from Create ID Link or List ID Links. Not the token.

Response Fields

boolean
true. The response carries no data.

Error Codes