Skip to main content
GET
/
account
Receive all accounts for the client 
curl --request GET \
  --url https://client-api.dev.finhost.io/account \
  --header 'Authorization: Bearer <token>'
[
  {
    "client": "39eab26c-8788-4375-810c-9807aaf98191",
    "account": "40eab26c-8788-4375-810c-9807aaf98190",
    "agent": "50eab26c-8788-4375-810c-9807aaf98191",
    "auditor": "70eab26c-8788-4375-810c-9807aaf98190",
    "available": 150,
    "holding": 10,
    "pending": 5,
    "balance": 155,
    "title": "USD account",
    "currency": "USD",
    "created": "2022-07-06T13:42:24.094Z",
    "updated": "2022-07-06T13:42:24.094Z",
    "contract": "basicContract",
    "status": "individual",
    "bankDetails": "{\"iban\":\"GB60TEST26161681306171\",\"bic\":\"TESTGB21\"}",
    "variantId": "1",
    "alias": "10002000"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
companyId
string

Company id

Response

200 - application/json

200 response

​
client
string<uuid>
required

Client ID

Example:

"39eab26c-8788-4375-810c-9807aaf98191"

​
account
string<uuid>
required

Account ID

Example:

"40eab26c-8788-4375-810c-9807aaf98190"

​
agent
string<uuid>
required

Agent ID

Example:

"50eab26c-8788-4375-810c-9807aaf98191"

​
auditor
string<uuid>
required

OperationKey for the next transaction

Example:

"70eab26c-8788-4375-810c-9807aaf98190"

​
available
number
required

Available amount of currency

Required range: x >= 0
Example:

150

​
holding
number
required

Total sum of currency on hold for the account (out coming from the account)

Required range: x >= 0
Example:

10

​
pending
number
required

Total sum of currency waiting to be added (incoming to the account)

Required range: x >= 0
Example:

5

​
balance
number
required

Is equal to available + pending

Required range: x >= 0
Example:

155

​
title
string
required

Title for the account

Example:

"USD account"

​
currency
string
required

Currency code (ISO 4217)

Required string length: 3
Example:

"USD"

​
created
string<date-time>
required

When the account was created in RFC 3339 (section 5.6)

Example:

"2022-07-06T13:42:24.094Z"

​
updated
string<date-time>
required

Time of the last update in RFC 3339 (section 5.6)

Example:

"2022-07-06T13:42:24.094Z"

​
contract
string

The contract for the account

Example:

"basicContract"

​
status
enum<string>

Account status

Available options:
activated,
pending,
initiated
Example:

"individual"

​
bankDetails
string

bank details(json stringify)

Example:

"{\"iban\":\"GB60TEST26161681306171\",\"bic\":\"TESTGB21\"}"

​
variantId
string
Example:

"1"

​
alias
string
Example:

"10002000"