Skip to main content
GET
Retrieve an account's details

Authorizations

Authorization
string
header
required

Path Parameters

accountId
string
required

The ID of the account to work with.

Example:

"F50091"

Query Parameters

personId
string<uuid>

The ID of the person to work with.

Maximum string length: 36
Example:

"775596ae-2624-40af-a9dc-9756110a4a04"

include
enum<string>

The type of embed to include. Comma separated list, url encoded.

Available options:
addresses,
currencies,
primaryOwner,
market,
settings,
maxCardsAndBudgets,
banks,
currencyAlignment,
productWithFeatures
Example:

"currencies,market"

Response

200 - application/json

OK

id
string
required

The ID of the account to work with.

Example:

"F50091"

type
enum<string>
required

The type of Account.

Available options:
Business,
Personal
status
enum<string>
required

The status of Account.

Available options:
applicationPending,
active,
inactive,
suspended,
customerClosed,
equalsFullClosed,
equalsReadonlyClosed,
identityVerificationRequired
termsAccepted
boolean
required

If they've accepted our Terms and Conditions when registering.

Example:

true

privacyAccepted
boolean
required

If they've accepted our Privacy Policy when registering.

Example:

true

salesperson
string | null
required

The Salesperson's display name. Resolved from salespersonStaffId when set; otherwise the legacy free-text value. Use salespersonStaffId as the identifier.

Maximum string length: 256
Example:

"Lester Spinka"

accountManager
string | null
required

The Account Manager's display name. Resolved from accountManagerStaffId when set; otherwise the legacy free-text value. Use accountManagerStaffId as the identifier.

Maximum string length: 256
Example:

"Kerry McDermott"

primaryOwnerPersonaId
string<uuid> | null
required

The ID of the primary owner persona.

Maximum string length: 36
Example:

"8e214819-5c83-429f-a976-eb127a0a8a88"

locale
enum<string>
required

Determines customer communication language. emails, notifications, etc.

Available options:
en-GB,
es-ES,
fr-FR,
nl-NL,
de-DE,
it-IT,
pt-PT
Example:

"en-GB"

preferredLanguage
enum<string> | null
required

The preferred language for business correspondence. ISO 639-1 uppercase.

Available options:
EN,
FR,
DE,
ES,
IT,
NL,
PT
createdAt
string<date-time>
required

The date the Resource was initially created. ISO 8601 format without milliseconds.

updatedAt
string<date-time>
required

The date the Resource was last modified. ISO 8601 format without milliseconds.

correlationId
string
Example:

"16700261790"

salespersonStaffId
string<uuid> | null

The staff id of the Salesperson. Source of truth for the assignment; salesperson carries the resolved display name.

Maximum string length: 36
Example:

"775596ae-2624-40af-a9dc-9756110a4a04"

accountManagerStaffId
string<uuid> | null

The staff id of the Account Manager. Source of truth for the assignment; accountManager carries the resolved display name.

Maximum string length: 36
Example:

"775596ae-2624-40af-a9dc-9756110a4a04"

bankEntity
string | null

Name of their Bank used for outgoing payments.

Maximum string length: 256
Example:

"BARC"

configurationId
string | null

The configuration ID used for billing configuration. Links the account to a specific fee structure. Set when the account is created; afterwards modifiable by Equals staff only.

Maximum string length: 36
Example:

"12345678901"

currentRiskLevel
enum<string>

Risk level of Account, or redacted when hidden from the caller.

Available options:
Low,
Medium,
MediumHigh,
High,
Dormant,
Extreme,
redacted
tier
enum<string>

tier of Account

Available options:
BRONZE,
SILVER,
GOLD,
NotTraded
Example:

"BRONZE"

features
object
productId
string<uuid>

The ID of the product to work with.

Maximum string length: 36
Example:

"3ef24d53-6e22-4103-a16b-d268e4f7346d"

primaryOwner
object

Primary owner person

business
object | null

Appears if the Account type is Business.

personal
object | null

Appears if the Account type is Personal.

addresses
object[]
currencies
object[]
payments
object

Account payments

solutions
boolean

If account belongs to solution client or not.

maxCardsAndBudgets
object | null

Maximum number of cards and budgets allowed for the account

details
object
organisationId
string<uuid> | null

The ID of the Organisation.

Maximum string length: 36
Example:

"5f8d2a91-3c47-4b6e-8a1d-7e9f0c2b4d6a"

companyId
string<uuid> | null

The ID of the Company.

Maximum string length: 36
Example:

"9b2f8c44-1e6a-4a7d-9c3b-2f1e0d5a6b7c"

marketId
string<uuid> | null

The ID of the market.

Maximum string length: 36
Example:

"3ef24d53-6e22-4103-a16b-d268e4f7346d"

market
object
currencyAlignment
boolean

Currency alignment value for a the account.

accountBanks
object[]
settings
object