Get Organization Info

GET 
/organization

This endpoint returns the organization's info. It is used in many places across the UI. It returns the name in the navbar and the public key of the organization’s distribution account.

Responses

200

Returns organization details

application/json

Schema

Schema

name stringrequired
logo_url stringrequired

distribution_account

object

required

address string

The address of the distribution account, present when the account type is STELLAR.

circle_wallet_id string

The ID of the Circle wallet, present when the account type is CIRCLE.

type stringrequired

Possible values: [DISTRIBUTION_ACCOUNT.STELLAR.ENV, DISTRIBUTION_ACCOUNT.STELLAR.DB_VAULT, DISTRIBUTION_ACCOUNT.CIRCLE.DB_VAULT]

The type of the distribution account.

status stringrequired

Possible values: [ACTIVE, PENDING_USER_ACTIVATION]

distribution_account_public_key string

DEPRECATED! Please refer to distribution_account.address instead.

timezone_utc_offset stringrequired
is_approval_required booleanrequired

Enables multi-user approval workflow for disbursements

sms_resend_interval integerrequired

The amount of days that the SDP will wait to resend the invitation SMS to the receivers that have not registered. If 0, that means the resending invitation SMS feature is disabled.

payment_cancellation_period_days integerrequired

The amount of days that the SDP will wait to cancel a payment that is waiting for the receiver to register. If 0, that means the payment cancellation feature is disabled.

privacy_policy_link stringrequired

The link to the organization privacy policy

sms_registration_message_template string

The custom SMS message template set for the registration invite. The default message isn't returned. In the message's content it's possible to add the following template variables: {{.OrganizationName}} which is the Organization Name configured and {{.RegistrationLink}} which is the link generated by SDP to send to the receiver (in case this is not present in the message, it's automatically appended at the end).

otp_message_template string

The custom OTP message template set to send OTP code to the receiver complete the registration flow. The default message isn't returned. In the message's content it's possible to add the following template variables: {{.OrganizationName}} which is the Organization Name configured and {{.OTP}} which is the OTP code to send to the receiver complete the registration flow (in case this is not present in the message, it's automatically appended at the end).

Example (from schema)

{
  "name": "Stellar Aid",
  "logo_url": "https://stellar-disbursement-platform-backend-dev.stellar.org/organization/logo",
  "distribution_account": {
    "address": "GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL",
    "circle_wallet_id": "1000646072",
    "type": "DISTRIBUTION_ACCOUNT.STELLAR.DB_VAULT",
    "status": "ACTIVE"
  },
  "distribution_account_public_key": "GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL",
  "timezone_utc_offset": "+00:00",
  "is_approval_required": true,
  "sms_resend_interval": 5,
  "payment_cancellation_period_days": 5,
  "privacy_policy_link": "https://stellar.org/privacy-policy",
  "sms_registration_message_template": "You have a payment waiting for you from {{.OrganizationName}}. Click {{.RegistrationLink}} to register.",
  "otp_message_template": "{{.OTP}} is your {{.OrganizationName}} phone verification code."
}

401

Unauthorized

application/json

Schema

Schema

error string

extras

object

status number

message string

Example (from schema)

{
  "error": "Not authorized",
  "extras": {
    "status": 401,
    "message": "Not authorized"
  }
}

Example

{
  "error": "Not authorized",
  "extras": {
    "status": 401,
    "message": "Not authorized"
  }
}

Loading...