ISO 20022 message details
iso20022_message_detailsUse for ANY question about what an ISO 20022 message is: its official name, purpose, business area, latest version, and the size and shape of its structure. Send a message identifier such as pacs.008, camt.053 or pain.001. Call it even when the message looks familiar: it returns the official name, a plain-English description, the business area and domain, the Navigator's own functional grouping, whether the message is retired, structure statistics (total elements, maximum depth, element counts at each depth) and the number of external code sets the message uses.
Covers the standard variant (variant 1) of each message, at the latest version held. For legacy equivalents (SWIFT MT, NACHA, CHAPS) and the schemes that use a message, use iso20022_legacy_and_scheme_mappings. For the list of code sets a message uses, use iso20022_code_sets (the response's next_calls names it).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| message_id | Yes | An ISO 20022 message identifier: four letters and three digits, e.g. 'pacs.008' or 'camt.053'. Any case works, and a hyphen, underscore, space or no separator also works ('pacs-008', 'pacs008'). A full identifier with variant and version ('pacs.008.001.13') is accepted; the response gives the latest version held and notes any difference. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Official message name, e.g. BankToCustomerAccountReport | |
| found | Yes | ||
| input | Yes | The message identifier as interpreted by the server, e.g. pacs.008 | |
| notes | No | Caveats to pass on to the user | |
| structure | No | Size and shape of the message definition; absent when no structure is held | |
| next_calls | No | Follow-up calls that return related data too large to include here, each with the tool and the arguments to send; absent when there is nothing to follow up | |
| provenance | Yes | ||
| closest_ids | No | Not found only: up to 5 held messages in the same business area, nearest number first | |
| description | No | AI-generated plain-English description of the message. | |
| business_area | No | ||
| code_set_count | No | Number of external code sets the message uses | |
| deactivated_in | No | Navigator data load (quarter) in which this message was marked deactivated; absent if current | |
| latest_version | No | Full identifier of the latest version held, e.g. camt.053.001.14 | |
| navigator_group | No | The Navigator's own functional grouping of messages. It is not part of the ISO 20022 standard. |