ENTITY developer reference
ResolutionResult
Candidate documentation for reading and synthetic examples. Account creation, live API access, SDKs, collections and MCP are not available here. A released service profile and matching integration instructions are required before use.
This is a documentation reading view of an unreleased candidate, not a downloadable replacement schema. Public wire names, types and constraints are retained except for the explicitly marked private-only subsets and route patterns. Private governance references are explained in public language. Use only a separately released, verified generation for clients. Read the explicit exclusions.
This is the public candidate schema reading view. Read it with the operation that uses it; a representable field does not establish enabled coverage or entitlement.
Declared fields
This list shows only properties declared directly in this schema. Required labels refer only to this schema’s own required array. Referenced, composed and conditional rules can add constraints; a field not listed as required here is not guaranteed to be optional.
No properties are declared directly here. Read the complete definition for scalar, array, referenced or composed constraints.
Schema reading view
Read all retained constraints, including any allOf, oneOf, anyOf, conditional and additional-property constraints. The field list does not combine branches. Explicitly marked private-only omissions mean this view is not an executable substitute for the original schema or a released contract.
{
"oneOf": [
{
"type": "object",
"properties": {
"outcome": {
"const": "established"
},
"reason_codes": {
"type": "array",
"items": {
"type": "string",
"x-profile-maxLength": "string_characters_max"
},
"x-profile-maxItems": "collection_items_max"
},
"explanation": {
"type": "string",
"x-profile-maxLength": "string_characters_max"
},
"policy_id": {
"type": "string",
"x-profile-maxLength": "string_characters_max"
},
"completeness": {
"$ref": "#/components/schemas/Completeness"
},
"entity": {
"$ref": "#/components/schemas/Entity"
},
"normalisation": {
"$ref": "#/components/schemas/InputNormalisation"
},
"identity_assessment": {
"$ref": "#/components/schemas/IdentityConfidence"
},
"recovery": {
"$ref": "#/components/schemas/RecoveryGuidance"
}
},
"required": [
"outcome",
"reason_codes",
"explanation",
"policy_id",
"completeness",
"entity",
"normalisation",
"identity_assessment",
"recovery"
],
"additionalProperties": false,
"allOf": [
{
"properties": {
"identity_assessment": {
"properties": {
"qualification": {
"enum": [
"exact_checked_identifier",
"qualified_equivalent_rule"
]
},
"rating": {
"properties": {
"score_basis_points": {
"type": "integer",
"minimum": 8500,
"maximum": 10000
},
"zone": {
"const": "strong"
}
}
}
}
}
}
},
{
"properties": {
"recovery": {
"properties": {
"actions": {
"maxItems": 0
}
}
}
}
}
]
},
{
"type": "object",
"properties": {
"outcome": {
"const": "ambiguous"
},
"reason_codes": {
"type": "array",
"items": {
"type": "string",
"x-profile-maxLength": "string_characters_max"
},
"x-profile-maxItems": "collection_items_max"
},
"explanation": {
"type": "string",
"x-profile-maxLength": "string_characters_max"
},
"policy_id": {
"type": "string",
"x-profile-maxLength": "string_characters_max"
},
"completeness": {
"$ref": "#/components/schemas/Completeness"
},
"candidates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Candidate"
},
"minItems": 2,
"x-profile-maxItems": "candidate_count_max"
},
"normalisation": {
"$ref": "#/components/schemas/InputNormalisation"
},
"identity_assessment": {
"$ref": "#/components/schemas/IdentityConfidence"
},
"recovery": {
"$ref": "#/components/schemas/RecoveryGuidance"
}
},
"required": [
"outcome",
"reason_codes",
"explanation",
"policy_id",
"completeness",
"candidates",
"normalisation",
"identity_assessment",
"recovery"
],
"additionalProperties": false,
"allOf": [
{
"properties": {
"recovery": {
"properties": {
"actions": {
"minItems": 1
}
}
}
}
}
]
},
{
"type": "object",
"properties": {
"outcome": {
"const": "insufficient_evidence"
},
"reason_codes": {
"type": "array",
"items": {
"type": "string",
"x-profile-maxLength": "string_characters_max"
},
"x-profile-maxItems": "collection_items_max"
},
"explanation": {
"type": "string",
"x-profile-maxLength": "string_characters_max"
},
"policy_id": {
"type": "string",
"x-profile-maxLength": "string_characters_max"
},
"completeness": {
"$ref": "#/components/schemas/Completeness"
},
"candidates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Candidate"
},
"x-profile-maxItems": "candidate_count_max"
},
"normalisation": {
"$ref": "#/components/schemas/InputNormalisation"
},
"identity_assessment": {
"$ref": "#/components/schemas/IdentityConfidence"
},
"recovery": {
"$ref": "#/components/schemas/RecoveryGuidance"
}
},
"required": [
"outcome",
"reason_codes",
"explanation",
"policy_id",
"completeness",
"candidates",
"normalisation",
"identity_assessment",
"recovery"
],
"additionalProperties": false,
"allOf": [
{
"properties": {
"recovery": {
"properties": {
"actions": {
"minItems": 1
}
}
}
}
}
]
},
{
"type": "object",
"properties": {
"outcome": {
"const": "no_match"
},
"reason_codes": {
"type": "array",
"items": {
"type": "string",
"x-profile-maxLength": "string_characters_max"
},
"x-profile-maxItems": "collection_items_max"
},
"explanation": {
"type": "string",
"x-profile-maxLength": "string_characters_max"
},
"policy_id": {
"type": "string",
"x-profile-maxLength": "string_characters_max"
},
"completeness": {
"allOf": [
{
"$ref": "#/components/schemas/Completeness"
},
{
"properties": {
"state": {
"const": "complete_for_requested_scope"
}
}
}
]
},
"candidates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Candidate"
},
"maxItems": 0,
"x-profile-maxItems": "candidate_count_max"
},
"normalisation": {
"$ref": "#/components/schemas/InputNormalisation"
},
"identity_assessment": {
"$ref": "#/components/schemas/IdentityConfidence"
},
"recovery": {
"$ref": "#/components/schemas/RecoveryGuidance"
}
},
"required": [
"outcome",
"reason_codes",
"explanation",
"policy_id",
"completeness",
"candidates",
"normalisation",
"identity_assessment",
"recovery"
],
"additionalProperties": false,
"allOf": [
{
"properties": {
"recovery": {
"properties": {
"actions": {
"minItems": 1
}
}
}
}
}
]
}
]
}