describe
Resolve required fields and input JSON Schema for an ISO 20022 message type after search, so you can construct flat records before validate or generate.
Instructions
Describe a message type: its required fields and input JSON Schema, resolved from the family's backing server. When to use: Use after 'search' to obtain the schema and required field names needed to construct flat records before calling 'validate' or 'generate'. When NOT to use: Do not use on raw XML payloads; use 'parse' instead. Behavior: Read-only, idempotent resolution from local schemas. Errors return a structured {'error': ...} payload rather than raising.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| message_type | Yes | ISO 20022 message type, e.g. 'pain.001.001.09', 'pacs.008' or 'camt.053'. For pain messages a fully-versioned type is preferred; the bare family name 'pain.001' resolves to 'pain.001.001.09'. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||