Create Account

POST 
/api/accounts

Create an account.

Request

application/json

Body

required

oneOf

Create non-custodial cardholder account

type stringrequired

Possible values: [cardholder]

The type of the account

name string

Account name

partnerAccountId stringrequired

The id of the partner account that this cardholder must be linked to

ownerUserId stringrequired

This user will be set as the owner of the created account

Create custodial cardholder account

type stringrequired

Possible values: [cardholder]

The type of the account

name string

Account name

parentAccountId stringrequired

The id of the partner account that this cardholder must be made child of

Create partner account

type stringrequired

Possible values: [partner]

The type of the account

name stringrequired

Account name

parentAccountId string

Parent account. If provided, this account will be set as the parent of the created account

ownerUserId string

Owner user id. If provided, this user will be set as the owner of the created account

Responses

200

Account created successfully

application/json

Schema

Schema

id string

The unique account ID

version string

The resource version number.

createdAt string

Timestamp of account creation

modifiedAt string

Timestamp of last account modification

partnerAccountId string

The partner account ID that this account belongs to

isActive boolean

Whether the account is active or not

type string

Possible values: [cardholder, identity, partner]

The account type

liveness string

Possible values: [live, test]

The resource liveness mode.

Example (from schema)

{
  "id": "e4b66d1ddecbf518f5f337n5e5a4f682",
  "version": "1",
  "createdAt": "2022-11-16T03:13:18.142Z",
  "modifiedAt": "2022-11-18T03:13:18.142Z",
  "partnerAccountId": "c7d84a7bf1c34323732d21bc60d17s746",
  "isActive": true,
  "type": "cardholder",
  "liveness": "live"
}

400

Request fields are invalid

application/json

Schema

Schema

statusCode integerrequired
statusName stringrequired
errorCode stringrequired
errors string[]

Example (from schema)

{
  "statusCode": 400,
  "statusName": "Bad Request",
  "errorCode": "BAD_REQUEST",
  "errors": [
    "Expected string, received number"
  ]
}

403

User is not allowed to perform the action with the reason stated in the errorCode

FORBIDDEN Insufficient permissions to perform the action.

INVALID_PARTNER_ACCOUNT The provided partner account is not of type partner.

INVALID_PARENT_ACCOUNT The provided parent account is not of type partner.

application/json

Schema

Schema

statusCode integerrequired
statusName stringrequired
errorCode stringrequired
reason string

Example (from schema)

{
  "statusCode": 403,
  "statusName": "Forbidden",
  "errorCode": "FORBIDDEN",
  "reason": "Unauthorized"
}

Loading...