Skip to main content
POST
Revokes one claim slot on the registry and removes the ledger row that recorded which proof backed it. Use it when a proved fact stops being true.
The confirm leg deletes the ledger row as soon as it accepts a receipt, so check what it accepts. On the Trusset register the receipt must be a mined revokeClaim on this instance’s register, for this wallet and this slot. On an ERC-3643 register the slot cannot be read back from the transaction: any mined revokeClaimBySignature, or a removeClaim on this wallet’s ONCHAINID, is accepted.

Body Parameters

string
required
The subject.
string | integer
required
The slot to revoke, as a name or an integer index from 0 to 7.
string
Send it to confirm the revocation. Omit it to receive the calldata.
string
ERC-3643 register only. The instance wallet you will send the revocation from, echoed back as signerAddress.

Sign and confirm

Without txHash the response carries one unsigned transaction. On the Trusset register it calls revokeClaim on the register, which needs a wallet holding KYC_PROVIDER_ROLE. The API checks that one of your instance’s wallets holds that role, and refuses with KYC_PROVIDER_ROLE_MISSING otherwise. The register reverts the call when the slot holds no active claim. On an ERC-3643 register it calls revokeClaimBySignature on the trusted issuer that signed the claim, which marks that signature revoked. The claim stays on the ONCHAINID, and List Claims stops returning it once the issuer reports it invalid. A slot with no claim is refused up front with CLAIM_NOT_FOUND. The role check becomes an agent check on the register. With txHash, the API checks the receipt as described above, deletes the ledger row, and writes a REVOKE_CLAIM entry to the customer audit log. It does not check who signed.

Response Fields

object
This revokes on the registry, which is a different act from the revocation the proof tool records. npm run revoke in the tool writes a signed entry into your own append-only registry, distinguishing a claim that lapsed from one that was never valid. Doing that keeps your record straight; doing this stops a token contract acting on the claim. A real revocation usually wants both.

Error Codes