Overview

This API lets you add wallet addresses to the allowlist of your stablecoin's contracts, and take them off again. Once a wallet is on a contract's allowlist, it may hold and transact the asset according to the contract's rules.

The API is resource-oriented:

• An asset is your stablecoin. It has one contract on each chain it is deployed on, and each contract keeps its own allowlist. Every contract has a readable id such as ast_demousd and a permanent key generated by us. Responses carry the readable id in assetId and the permanent key in assetUuid; when you read the contract itself, the permanent key is its id (see Read your assets). The readable id can be changed on request; the key never changes and is returned, never accepted in a URL. Predicate can also give your asset an asset name that stands for all of its contracts at once (see Which id goes in the URL).
• An onboarding is one wallet address on one contract's allowlist. There is at most one onboarding per wallet per contract, and that pair identifies it — there is no separate onboarding id anywhere on the wire.
• The onboarding stays addressable for good, so you can poll its current status. It is kept when the wallet is removed, and the same record is used again when the wallet is added again.
• A batch is the record of one write request: a handle, a tally, and one result per wallet you sent (per wallet and contract under an asset name). Every add, removal and retry is recorded as a batch, including a request for a single wallet. Batches are kept indefinitely.

You can add a wallet, remove it (see Remove a wallet), and try a wallet again when its work did not succeed (see Retry).

This page describes the endpoints your API key is supported on. A path under /assets that this page does not describe is not part of the supported surface: it may change or be refused at any time. Asset setup and operational recovery are handled by Predicate on your behalf — see Handled by Predicate.

Base URL

https://api.predicate.io/v1

Every endpoint on this page is under /assets.

JSON contract

The API accepts JSON request bodies and returns JSON response bodies, including errors.

• Send Content-Type: application/json when a request includes a body.
• Send Accept: application/json on every request.
• Successful responses and errors both use Content-Type: application/json.
• Any unrecognised field in a request body is a 400. Fields are not silently ignored.
• A request body is capped at 1 MiB. A larger body is a 400.

Authentication