Skip to content
aerandil.com
GitHub

Validate Propose person match (dry-run)

POST
/v1/actions/hospitality.action.propose_person_match/validate
curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.propose_person_match/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "match_method": "deterministic_email", "match_score": "example", "matched_attributes": [ "example" ], "person_a": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "person_b": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }, "return_modified": false }'

Dry-run of apply_hospitality_action_propose_person_match’s parameter checks. No side effects, no idempotency reservation, no handler dispatch — just the schema pass plus action-level shape (target presence, target type, unknown-parameter rejection). return_modified is meaningless here and ignored.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
branch

Apply against an open branch’s overlay view instead of the canonical (main) plane. The action’s writes land in the branch’s copy-on-first-write overlay, its events in the branch’s own stream, and the invocation is journaled for merge-by-replay. Branch writes are action-only, so this is the write-side entry point to a branch (POST /v1/branches forks one).

string format: uuid
params
required
object
match_method
required
How the candidate was surfaced
string
Allowed values: deterministic_email deterministic_loyalty_id deterministic_phone probabilistic_name_dob probabilistic_fuzzy manual
match_score
required
Match confidence in [0, 1] (1.0 for deterministic / manual)
string format: decimal
matched_attributes
Attribute names the match keyed on (names only, never values)
Array<string>
person_a
required
First person of the proposed pair
string format: uuid
person_b
required
Second person of the proposed pair
string format: uuid
return_modified

When true, the response carries modified_objects and modified_links projections — the engine reads the event log inside the same transaction so the projection observes the handler’s own writes.

boolean

Responses

Section titled “Responses”

200

Section titled “200”

Validation outcome. result is valid or invalid; per-parameter diagnostics are always populated for every declared parameter so a UI can render the action’s full surface.

Media typeapplication/json
object
action
required
string
errors

Action-level errors not tied to a single parameter (missing target, target type mismatch, unknown parameter names). Absent when empty.

Array<string>
parameters
required

Per-parameter diagnostics keyed by api_name.

object
key
additional properties
object
errors
Array<string>
result
required
Allowed values: valid invalid
value
required

The serialised value the server interpreted, or null if the parameter was not supplied.

result
required
Allowed values: valid invalid
Example
{
  "parameters": {
    "additionalProperty": {
      "result": "valid"
    }
  },
  "result": "valid"
}