stellar-sdk/com.soneso.stellar.sdk.sep.sep01/Documentation

Documentation

data class Documentation(val orgName: String? = null, val orgDba: String? = null, val orgUrl: String? = null, val orgLogo: String? = null, val orgDescription: String? = null, val orgPhysicalAddress: String? = null, val orgPhysicalAddressAttestation: String? = null, val orgPhoneNumber: String? = null, val orgPhoneNumberAttestation: String? = null, val orgKeybase: String? = null, val orgTwitter: String? = null, val orgGithub: String? = null, val orgOfficialEmail: String? = null, val orgSupportEmail: String? = null, val orgLicensingAuthority: String? = null, val orgLicenseType: String? = null, val orgLicenseNumber: String? = null)

Organization documentation from the stellar.toml DOCUMENTATION section.

Contains identifying information about the organization publishing the stellar.toml file, including legal name, contact details, and verification attestations.

See SEP-0001 Specification

Constructors

Documentation

constructor(orgName: String? = null, orgDba: String? = null, orgUrl: String? = null, orgLogo: String? = null, orgDescription: String? = null, orgPhysicalAddress: String? = null, orgPhysicalAddressAttestation: String? = null, orgPhoneNumber: String? = null, orgPhoneNumberAttestation: String? = null, orgKeybase: String? = null, orgTwitter: String? = null, orgGithub: String? = null, orgOfficialEmail: String? = null, orgSupportEmail: String? = null, orgLicensingAuthority: String? = null, orgLicenseType: String? = null, orgLicenseNumber: String? = null)

Properties

orgDba

val orgDba: String?

(May not apply) DBA of the organization.

orgDescription

val orgDescription: String?

Short description of the organization.

orgGithub

val orgGithub: String?

The organization's Github account.

orgKeybase

val orgKeybase: String?

A Keybase account name for the organization. Should contain proof of ownership of any public online accounts you list here, including the organization's domain.

orgLicenseNumber

val orgLicenseNumber: String?

Official license number of the organization, if applicable.

orgLicenseType

val orgLicenseType: String?

Type of financial or other license the organization holds, if applicable.

orgLicensingAuthority

val orgLicensingAuthority: String?

Name of the authority or agency that licensed the organization, if applicable.

orgLogo

val orgLogo: String?

A URL to a PNG image of the organization's logo on a transparent background.

orgName

val orgName: String?

Legal name of the organization.

orgOfficialEmail

val orgOfficialEmail: String?

An email where clients can contact the organization. Must be hosted at the orgUrl domain.

orgPhoneNumber

val orgPhoneNumber: String?

The organization's phone number in E.164 format, e.g. +14155552671.

orgPhoneNumberAttestation

val orgPhoneNumberAttestation: String?

URL on the same domain as the orgUrl that contains an image or PDF of a phone bill showing both the phone number and the organization's name.

orgPhysicalAddress

val orgPhysicalAddress: String?

Physical address for the organization.

orgPhysicalAddressAttestation

val orgPhysicalAddressAttestation: String?

URL on the same domain as the orgUrl that contains an image or PDF official document attesting to the physical address. It must list the orgName or orgDba 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.

orgSupportEmail

val orgSupportEmail: String?

An email that users can use to request support regarding the organization's Stellar assets or applications.

orgTwitter

val orgTwitter: String?

The organization's Twitter account.

orgUrl

val orgUrl: String?

The organization's official URL. The stellar.toml must be hosted on the same domain.