check_descent_eligibility
Read-onlyIdempotent
Check whether a person qualifies for citizenship by descent.
Give the user's direct ancestral line, one entry per generation, starting
with relation='self'. Every generation between the user and the ancestor
must be present even if little is known about them, because descent passes
generation by generation and a gap changes the answer.
Ask for exact dates where you can. Year-only input is accepted but the
result will carry a caveat, and for Ireland a registration and a birth in
the same year cannot be resolved at all.
Args:
country: ISO 3166-1 alpha-2, lowercase. Currently 'ie' or 'ca'.
line: The direct line, from the user upward.
as_of: Evaluation date. Defaults to today. Rules with commencement
dates (Canada's Bill C-3) depend on it.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| line | Yes | ||
| as_of | No | ||
| country | Yes |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| caveats | No | Approximations and unresolvable ambiguities in the input. Relay these. | |
| missing | No | ||
| verdict | Yes | One-line plain reading of the confidence band. | |
| blockers | No | ||
| rationale | Yes | ||
| confidence | Yes | green, yellow, or red | |
| disclaimer | Yes | ||
| learn_more | Yes | ||
| pathway_id | Yes | ||
| next_action | No | ||
| country_code | Yes | ||
| supporting_facts | No | ||
| rules_verified_as_of | Yes |