Skip to main content
POST
/
v1
/
accounts
Initiate a new account for the customer
curl --request POST \
  --url https://client-api.dev.finhost.io/v1/accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "currency": "<string>",
  "companyId": "<string>",
  "variantId": "<string>"
}
'
{
  "id": "db4e04c3-4756-f3c4-7497-be928c51135",
  "entity": "account",
  "operation": "async",
  "status": "processed"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
title
string
required
​
currency
string
required
​
companyId
string
​
variantId
string

required if contract is multipleVariants

Response

201 - application/json

The account was initiated

​
id
string

Requested entity ID

Example:

"db4e04c3-4756-f3c4-7497-be928c51135"

​
entity
string

Requested entity

Example:

"account"

​
operation
enum<string>

Operation type

Available options:
sync,
async
Example:

"async"

​
status
enum<string>

Operation status

Available options:
queue,
processed,
pending
Example:

"processed"