IssuerDocumentation

public final class IssuerDocumentation : Sendable

Represents organization and issuer information from a stellar.toml file.

This class parses and provides access to the DOCUMENTATION section of a domain’s stellar.toml file. It contains organizational details about the asset issuer or service provider including legal information, contact details, and verification data.

The information in this class helps establish trust and transparency by providing verifiable details about the organization operating Stellar infrastructure or issuing assets. This includes legal names, physical addresses with attestations, social media accounts, and licensing information.

Developers use this class to display issuer information in wallets, verify organizational legitimacy, and provide users with contact details for support.

See also:

  • [StellarToml] for the main stellar.toml parser
  • SEP-0001
  • Legal name of the organization

    Declaration

    Swift

    public let orgName: String?
  • (may not apply) DBA of the organization

    Declaration

    Swift

    public let orgDBA: String?
  • uses https: The organization’s official URL. Your stellar.toml must be hosted on the same domain.

    Declaration

    Swift

    public let orgURL: String?
  • The organization’s logo

    Declaration

    Swift

    public let orgLogo: String?
  • Short description of the organization

    Declaration

    Swift

    public let orgDescription: String?
  • Physical address of the organization

    Declaration

    Swift

    public let orgPhysicalAddress: String?
  • https:// url URL on the same domain as your ORG_URL that contains an image or pdf official document attesting to your physical address. It must list your ORG_NAME or ORG_DBA as the party at the address. Only documents from an official third party are acceptable. E.g. a utility bill, mail from a financial institution, or business license.

    Declaration

    Swift

    public let orgPhysicalAddressAttestation: String?
  • The organization’s phone number

    Declaration

    Swift

    public let orgPhoneNumber: String?
  • https:// url URL on the same domain as your ORG_URL that contains an image or pdf of a phone bill showing both the phone number and your organization’s name.

    Declaration

    Swift

    public let orgPhoneNumberAttestation: String?
  • A Keybase account name of the organization. Should contain proof of ownership of any public online accounts you list here, including your organization’s domain.

    Declaration

    Swift

    public let orgKeybase: String?
  • The organization’s Twitter account

    Declaration

    Swift

    public let orgTwitter: String?
  • The organization’s Github account

    Declaration

    Swift

    public let orgGithub: String?
  • An email where clients can contact the organization. Must be hosted at your ORG_URL domain.

    Declaration

    Swift

    public let orgOfficialEmail: String?
  • An email that users can use to request support regarding the organizations Stellar assets or applications.

    Declaration

    Swift

    public let orgSupportEmail: String?
  • Name of the authority or agency that licensed the organization, if applicable

    Declaration

    Swift

    public let orgLicensingAuthority: String?
  • Type of financial or other license the organization holds, if applicable

    Declaration

    Swift

    public let orgLicenseType: String?
  • Official license number of the organization, if applicable

    Declaration

    Swift

    public let orgLicenseNumber: String?
  • Initializes issuer documentation from a parsed TOML document.

    Declaration

    Swift

    public init(fromToml toml: Toml)

    Parameters

    toml

    The parsed TOML document containing organization information