Account

An Account represents the entity which performs API operations.

Each API operation like creating an order or creating an emission estimate is ring-fenced within an Account.

Endpoints

GET

 /accounts/me

GET

 /accounts/client/me

POST

 /accounts

GET

 /accounts

PUT

 /accounts/{id}

PATCH

 /accounts/{id}

POST

 /accounts/{id}/logo

The Account object

idstringrequired

The Account's unique identifier

---

namestringrequired

The Account's name

---

organisation_idstringrequired

The unique identifier of the organisation this account belongs to

---

handlestring^[a-z0-9-_]+$required

handle is a client defined URL-friendly string that identifies the account.

The handle is unique per organisation and account type.

---

currencystringrequired

The Account's currency

---

typeenumrequired

The account's type.

See the <a href="#section/Live-and-test-accounts">Live and test accounts section</a> for details.

Enum:

• live
• test

---

logostringrequired

The account logo

---

beneficiarystringrequired

Retirement beneficiary

This is the name that appears on future retirements that are made in this account. If none is present, the organisation beneficiary will be used instead.

---

bundle_portfolio_idstringrequired

Bundle portfolio id tied to the account.

Account

{
  "id": "ljmkOq7vXd239gAE9WALWQ8ZGVD5ExNz",
  "name": "ACME",
  "beneficiary": "ACME Inc",
  "currency": "USD",
  "type": "live",
  "organisation_id": "VndoQ0PZjGMzvYOZGwqy6kbgN1eOJx9B",
  "logo": null,
  "bundle_portfolio_id": null
}