`personalTax.shareholder.request.resolve`

As a freshly verified administrator of the exact company saved on this setup request, explicitly save the requested person's real shareholder details against the current request and register revisions. Select an existing individual record or add the actual person; email must match the requested person's current verified identity. Notifies the requested person and company administrators after real setup is saved. Preserves other persons, classes, share holdings and officers, and never approves tax sharing. Use the native reviewed form; never put a SIN in these details.

POST/api/v1/accounting/personalTax.shareholder.request.resolve

Permissions

accounting:readaccounting:writeaccounting:admin

Who can call it

admin, finance, contributor, accountant

Retries

Idempotency key required, with expectedRevision

MCP

Not offered over MCP: Resolving setup requires fresh administrator access in the request's saved company and accounting:admin OAuth consent. The requester's identity or current workspace role cannot substitute for that permission.

Reaches outside Oatmilk

It emails people or calls another service.

Fields

idstring (ID)Required
The record's ID.
existingHolderIdstring
Matches ^[a-z0-9][a-z0-9-]{7,39}$
holderobjectRequired
No other fields
expectedRevisionintegerRequired
The record's current revision, from the last time you read it. If someone changed the record since, the request is refused with a conflict so you can reload and check before trying again.
at most 9007199254740991 · greater than 0
expectedRegisterRevisionintegerRequired
The related record's current revision, from the last time you read it.
0 to 1000000000
idempotencyKeystringRequired
Any unique text you generate once per intended change, so a retried request only happens once. Send it as the Idempotency-Key header instead if you prefer; if you send both they must match.
8–200 characters

curl https://app.getoatmilk.com/api/v1/accounting/personalTax.shareholder.request.resolve \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
  "holder": {
    "legalName": "Synthetic Ventures Inc.",
    "email": "finance@example.com",
    "residency": "canada",
    "address": {
      "line1": "example",
      "line2": "example",
      "city": "example",
      "region": "example",
      "postalCode": "example",
      "country": "CA"
    }
  },
  "expectedRevision": 3,
  "expectedRegisterRevision": 3
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/personalTax.shareholder.request.resolve", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
    "holder": {
      "legalName": "Synthetic Ventures Inc.",
      "email": "finance@example.com",
      "residency": "canada",
      "address": {
        "line1": "example",
        "line2": "example",
        "city": "example",
        "region": "example",
        "postalCode": "example",
        "country": "CA"
      }
    },
    "expectedRevision": 3,
    "expectedRegisterRevision": 3
  }),
});
const { data, error } = await response.json();
if (!response.ok) throw new Error(`${error.code}: ${error.message}`);
console.log(data);

import os
import uuid

import requests

response = requests.post(
    "https://app.getoatmilk.com/api/v1/accounting/personalTax.shareholder.request.resolve",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
        "holder": {
            "legalName": "Synthetic Ventures Inc.",
            "email": "finance@example.com",
            "residency": "canada",
            "address": {
                "line1": "example",
                "line2": "example",
                "city": "example",
                "region": "example",
                "postalCode": "example",
                "country": "CA",
            },
        },
        "expectedRevision": 3,
        "expectedRegisterRevision": 3,
    },
    timeout=30,
)
payload = response.json()
if not response.ok:
    raise RuntimeError(f"{payload['error']['code']}: {payload['error']['message']}")
print(payload["data"])

Response

{
  "data": { … }
}

Try it

Checks your input with this action’s real schema and answers like the API, with synthetic data. No key needed, and nothing changes.

Input

POST/api/v1/accounting/personalTax.shareholder.request.resolve

curl https://app.getoatmilk.com/api/v1/accounting/personalTax.shareholder.request.resolve \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
  "holder": {
    "legalName": "Synthetic Ventures Inc.",
    "email": "finance@example.com",
    "residency": "canada",
    "address": {
      "line1": "example",
      "line2": "example",
      "city": "example",
      "region": "example",
      "postalCode": "example",
      "country": "CA"
    }
  },
  "expectedRevision": 3,
  "expectedRegisterRevision": 3
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/personalTax.shareholder.request.resolve", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
    "holder": {
      "legalName": "Synthetic Ventures Inc.",
      "email": "finance@example.com",
      "residency": "canada",
      "address": {
        "line1": "example",
        "line2": "example",
        "city": "example",
        "region": "example",
        "postalCode": "example",
        "country": "CA"
      }
    },
    "expectedRevision": 3,
    "expectedRegisterRevision": 3
  }),
});
const { data, error } = await response.json();
if (!response.ok) throw new Error(`${error.code}: ${error.message}`);
console.log(data);

import os
import uuid

import requests

response = requests.post(
    "https://app.getoatmilk.com/api/v1/accounting/personalTax.shareholder.request.resolve",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
        "holder": {
            "legalName": "Synthetic Ventures Inc.",
            "email": "finance@example.com",
            "residency": "canada",
            "address": {
                "line1": "example",
                "line2": "example",
                "city": "example",
                "region": "example",
                "postalCode": "example",
                "country": "CA",
            },
        },
        "expectedRevision": 3,
        "expectedRegisterRevision": 3,
    },
    timeout=30,
)
payload = response.json()
if not response.ok:
    raise RuntimeError(f"{payload['error']['code']}: {payload['error']['message']}")
print(payload["data"])

Fields

Fields inside holder

Example

Try it