curl -s \
"https://engine.example.com/v1/instruments/FUND/precheck?act=subscription&holderId=alpha&units=100.0" \
-H "Authorization: Bearer $TOKEN"// A client from OpenAPI Generator: see Build a client.
import {
Configuration,
PoliciesApi,
ProblemFromJSON,
ResponseError,
} from "./nodeasset-client";
const api = new PoliciesApi(new Configuration({
basePath: "https://engine.example.com",
accessToken: process.env.TOKEN,
}));
try {
const answer = await api.getPrecheck({
instrumentId: "FUND",
act: "subscription",
holderId: "alpha",
units: 100.0,
});
console.log(answer.value);
} catch (e) {
if (!(e instanceof ResponseError)) throw e;
// A refusal is a problem; its type ends in the slug.
const problem = ProblemFromJSON(await e.response.json());
const slug = problem.type.split(":").pop();
console.error(e.response.status, slug, problem.detail);
}
# A client from OpenAPI Generator: see Build a client.
import os
import sys
import nodeasset_client
config = nodeasset_client.Configuration(
host="https://engine.example.com",
access_token=os.environ["TOKEN"],
)
with nodeasset_client.ApiClient(config) as client:
api = nodeasset_client.PoliciesApi(client)
try:
answer = api.get_precheck(
instrument_id="FUND",
act="subscription",
holder_id="alpha",
units=100.0,
)
print(answer.value)
except nodeasset_client.ApiException as e:
# A refusal is a problem; its type ends in the slug.
problem = nodeasset_client.Problem.from_json(e.body)
slug = problem.type.rsplit(":", 1)[-1]
print(e.status, slug, problem.detail, file=sys.stderr)
// A client from OpenAPI Generator: see Build a client.
import java.math.BigDecimal;
import nodeasset.client.ApiClient;
import nodeasset.client.ApiException;
import nodeasset.client.api.PoliciesApi;
import nodeasset.client.model.PrecheckAct;
import nodeasset.client.model.Problem;
public class GetPrecheck {
public static void main(String[] args) throws Exception {
ApiClient client = new ApiClient();
client.updateBaseUri("https://engine.example.com");
client.setRequestInterceptor(builder ->
builder.header("Authorization", "Bearer " + System.getenv("TOKEN")));
PoliciesApi api = new PoliciesApi(client);
try {
var request = PoliciesApi.APIGetPrecheckRequest.newBuilder()
.instrumentId("FUND")
.act(PrecheckAct.fromValue("subscription"))
.holderId("alpha")
.units(new BigDecimal("100.0"))
.build();
var answer = api.getPrecheck(request);
System.out.println(answer.getValue());
} catch (ApiException e) {
// A refusal is a problem; its type ends in the slug.
Problem problem = client.getObjectMapper()
.readValue(e.getResponseBody(), Problem.class);
String type = problem.getType();
String slug = type.substring(type.lastIndexOf(':') + 1);
System.err.println(e.getCode() + " " + slug + " " + problem.getDetail());
}
}
}
{
"offset": 612,
"now": "2026-10-03T13:23:25.077470325Z",
"value": {
"instrumentId": "FUND",
"allowed": true,
"policyVersion": 0,
"refusals": []
}
}Get a precheck
Returns what would refuse a subscription or a transfer of units now, without acting.
An investor prechecks its own holder only, and reads the receiver’s own refusals as receiver.
curl -s \
"https://engine.example.com/v1/instruments/FUND/precheck?act=subscription&holderId=alpha&units=100.0" \
-H "Authorization: Bearer $TOKEN"// A client from OpenAPI Generator: see Build a client.
import {
Configuration,
PoliciesApi,
ProblemFromJSON,
ResponseError,
} from "./nodeasset-client";
const api = new PoliciesApi(new Configuration({
basePath: "https://engine.example.com",
accessToken: process.env.TOKEN,
}));
try {
const answer = await api.getPrecheck({
instrumentId: "FUND",
act: "subscription",
holderId: "alpha",
units: 100.0,
});
console.log(answer.value);
} catch (e) {
if (!(e instanceof ResponseError)) throw e;
// A refusal is a problem; its type ends in the slug.
const problem = ProblemFromJSON(await e.response.json());
const slug = problem.type.split(":").pop();
console.error(e.response.status, slug, problem.detail);
}
# A client from OpenAPI Generator: see Build a client.
import os
import sys
import nodeasset_client
config = nodeasset_client.Configuration(
host="https://engine.example.com",
access_token=os.environ["TOKEN"],
)
with nodeasset_client.ApiClient(config) as client:
api = nodeasset_client.PoliciesApi(client)
try:
answer = api.get_precheck(
instrument_id="FUND",
act="subscription",
holder_id="alpha",
units=100.0,
)
print(answer.value)
except nodeasset_client.ApiException as e:
# A refusal is a problem; its type ends in the slug.
problem = nodeasset_client.Problem.from_json(e.body)
slug = problem.type.rsplit(":", 1)[-1]
print(e.status, slug, problem.detail, file=sys.stderr)
// A client from OpenAPI Generator: see Build a client.
import java.math.BigDecimal;
import nodeasset.client.ApiClient;
import nodeasset.client.ApiException;
import nodeasset.client.api.PoliciesApi;
import nodeasset.client.model.PrecheckAct;
import nodeasset.client.model.Problem;
public class GetPrecheck {
public static void main(String[] args) throws Exception {
ApiClient client = new ApiClient();
client.updateBaseUri("https://engine.example.com");
client.setRequestInterceptor(builder ->
builder.header("Authorization", "Bearer " + System.getenv("TOKEN")));
PoliciesApi api = new PoliciesApi(client);
try {
var request = PoliciesApi.APIGetPrecheckRequest.newBuilder()
.instrumentId("FUND")
.act(PrecheckAct.fromValue("subscription"))
.holderId("alpha")
.units(new BigDecimal("100.0"))
.build();
var answer = api.getPrecheck(request);
System.out.println(answer.getValue());
} catch (ApiException e) {
// A refusal is a problem; its type ends in the slug.
Problem problem = client.getObjectMapper()
.readValue(e.getResponseBody(), Problem.class);
String type = problem.getType();
String slug = type.substring(type.lastIndexOf(':') + 1);
System.err.println(e.getCode() + " " + slug + " " + problem.getDetail());
}
}
}
{
"offset": 612,
"now": "2026-10-03T13:23:25.077470325Z",
"value": {
"instrumentId": "FUND",
"allowed": true,
"policyVersion": 0,
"refusals": []
}
}app, approver, auditor, investor, operator, risk. An investor reaches only its own holder’s records.Authorizations
A JWT from the deployment's identity provider, whose roles claim names the caller's roles and whose holder claim names an investor's holder.
Headers
A signed request's key id, as venue.api.signing.clients configures it for the bearer's subject.
Seconds since the epoch, within venue.api.signing.window of the engine's clock, 5 minutes by default.
^[0-9]+$At least 16 random bytes in base64url, never reused within twice the window.
22 - 128^[A-Za-z0-9_-]+={0,2}$The base64 HMAC-SHA256, under the key's secret, of the method, the path and query, the timestamp, the nonce and the body's SHA-256.
Your id for this request, 1 to 128 printable characters, repeated in the answer; absent, the engine makes one.
128^[\x21-\x7E]+$A W3C trace context, which the engine joins and passes on.
^[0-9a-f]{2}-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$Path Parameters
The instrument's id on the Registry.
Query Parameters
The act to precheck. An act a precheck judges.
subscription, transfer The holder subscribing, or the holder sending a transfer.
The holder receiving a transfer; a transfer only.
The units the act would move.
Response
What the act would meet.
The ledger offset the answer was read at; 0 for an answer from the engine's own records.
The engine's clock when it answered, an ISO-8601 instant.
What the read answers; for a list, the page's records in the list's order.
Show child attributes
Show child attributes

