Invoke Skill Estate Review
post
/api/v1/skills/estate.review/invokeReview wills, trusts, beneficiaries, control, and tax exposure of an estate plan.
Request bodyapplication/json
| Field | Type | Description |
|---|---|---|
file_ids | string (uuid)[] | β |
jurisdiction | "AU" | "GB" | "CA" | "US" | "NZ" | null | β |
review_mode | "full" | "tax_only" | "control_only" | "trust_only" | βfulltax_onlycontrol_onlytrust_only |
client_context | object | βshow nestedEmpty object. |
Responses
200Skill executed successfully
| Field | Type | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
skillrequired | string | β | ||||||||||||||||||||||||
outputrequired | object | βshow nested
| ||||||||||||||||||||||||
correlation_idrequired | string | β |
401Authentication required
| Field | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errorrequired | object | βshow nested
|
403Insufficient permissions
| Field | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errorrequired | object | βshow nested
|
404Skill not found
| Field | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errorrequired | object | βshow nested
|
429Rate limit exceeded
| Field | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errorrequired | object | βshow nested
|
5XXInternal server error
| Field | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errorrequired | object | βshow nested
|
curl https://api.dev.arch.ie/api/v1/skills/estate.review/invoke \
-X POST \
-H "Authorization: Bearer sk_..." \
-H "Content-Type: application/json" \
-d '{
"file_ids": [
"00000000-0000-0000-0000-000000000000"
],
"jurisdiction": null,
"review_mode": "full",
"client_context": {}
}'