Create Account

post/api/accounts

Create an account.

Request

Body application/json

One of

typestringrequired
Allowed values:cardholder
The type of the account
namestring
Account name
partnerAccountIdstringrequired
The id of the partner account that this cardholder must be linked to
ownerUserIdstringrequired
This user will be set as the owner of the created account

typestringrequired
Allowed values:cardholder
The type of the account
namestring
Account name
parentAccountIdstringrequired
The id of the partner account that this cardholder must be made child of

typestringrequired
Allowed values:partner
The type of the account
namestringrequired
Account name
parentAccountIdstring
Parent account. If provided, this account will be set as the parent of the created account
ownerUserIdstring
Owner user id. If provided, this user will be set as the owner of the created account

Response

Account created successfully.

Body application/json

idstring
The unique account ID
versionstring
The resource version number.
createdAtstring
Timestamp of account creation
modifiedAtstring
Timestamp of last account modification
partnerAccountIdstring
The partner account ID that this account belongs to
isActiveboolean
Whether the account is active or not
typestring
Allowed values:cardholderidentitypartner
The account type
livenessstring
Allowed values:livetest
The resource liveness mode.

Request fields are invalid.

Body application/json

statusCodeintegerrequired
statusNamestringrequired
errorCodestringrequired
errorsobject[]
Items
- messagestring
- pathstring
  The location of the invalid path param, query param or payload attribute.

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.

Body application/json

statusCodeintegerrequired
statusNamestringrequired
errorCodestringrequired
reasonstring

Example

Example Request

ServerAuthentication

curl https://api.immersve.com/api/accounts \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "cardholder",
  "name": "string",
  "partnerAccountId": "12fff060a9550622e86a7a962f548c1d",
  "ownerUserId": "9c4010f2946be546c716add4bf479410"
}'

curl https://api.immersve.com/api/accounts \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "cardholder",
  "name": "string",
  "parentAccountId": "12fff060a9550622e86a7a962f548c1d"
}'

curl https://api.immersve.com/api/accounts \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "partner",
  "name": "string",
  "parentAccountId": "dbc1d6aa6c0b2a5be2f567470623ede5",
  "ownerUserId": "1a4d3b41756ce73db66ed969e4e86448"
}'

curl https://api.immersve.com/api/accounts \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "cardholder",
  "name": "string",
  "partnerAccountId": "12fff060a9550622e86a7a962f548c1d",
  "ownerUserId": "9c4010f2946be546c716add4bf479410"
}'

curl https://api.immersve.com/api/accounts \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "cardholder",
  "name": "string",
  "parentAccountId": "12fff060a9550622e86a7a962f548c1d"
}'

curl https://api.immersve.com/api/accounts \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "partner",
  "name": "string",
  "parentAccountId": "dbc1d6aa6c0b2a5be2f567470623ede5",
  "ownerUserId": "1a4d3b41756ce73db66ed969e4e86448"
}'

curl https://api.immersve.com/api/accounts \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "cardholder",
  "name": "string",
  "partnerAccountId": "12fff060a9550622e86a7a962f548c1d",
  "ownerUserId": "9c4010f2946be546c716add4bf479410"
}'

curl https://api.immersve.com/api/accounts \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "cardholder",
  "name": "string",
  "parentAccountId": "12fff060a9550622e86a7a962f548c1d"
}'

curl https://api.immersve.com/api/accounts \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "partner",
  "name": "string",
  "parentAccountId": "dbc1d6aa6c0b2a5be2f567470623ede5",
  "ownerUserId": "1a4d3b41756ce73db66ed969e4e86448"
}'

curl https://api.immersve.com/api/accounts \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "cardholder",
  "name": "string",
  "partnerAccountId": "12fff060a9550622e86a7a962f548c1d",
  "ownerUserId": "9c4010f2946be546c716add4bf479410"
}'

curl https://api.immersve.com/api/accounts \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "cardholder",
  "name": "string",
  "parentAccountId": "12fff060a9550622e86a7a962f548c1d"
}'

curl https://api.immersve.com/api/accounts \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "partner",
  "name": "string",
  "parentAccountId": "dbc1d6aa6c0b2a5be2f567470623ede5",
  "ownerUserId": "1a4d3b41756ce73db66ed969e4e86448"
}'

curl https://test.immersve.com/api/accounts \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "cardholder",
  "name": "string",
  "partnerAccountId": "12fff060a9550622e86a7a962f548c1d",
  "ownerUserId": "9c4010f2946be546c716add4bf479410"
}'

curl https://test.immersve.com/api/accounts \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "cardholder",
  "name": "string",
  "parentAccountId": "12fff060a9550622e86a7a962f548c1d"
}'

curl https://test.immersve.com/api/accounts \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "partner",
  "name": "string",
  "parentAccountId": "dbc1d6aa6c0b2a5be2f567470623ede5",
  "ownerUserId": "1a4d3b41756ce73db66ed969e4e86448"
}'

curl https://test.immersve.com/api/accounts \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "cardholder",
  "name": "string",
  "partnerAccountId": "12fff060a9550622e86a7a962f548c1d",
  "ownerUserId": "9c4010f2946be546c716add4bf479410"
}'

curl https://test.immersve.com/api/accounts \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "cardholder",
  "name": "string",
  "parentAccountId": "12fff060a9550622e86a7a962f548c1d"
}'

curl https://test.immersve.com/api/accounts \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "partner",
  "name": "string",
  "parentAccountId": "dbc1d6aa6c0b2a5be2f567470623ede5",
  "ownerUserId": "1a4d3b41756ce73db66ed969e4e86448"
}'

curl https://test.immersve.com/api/accounts \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "cardholder",
  "name": "string",
  "partnerAccountId": "12fff060a9550622e86a7a962f548c1d",
  "ownerUserId": "9c4010f2946be546c716add4bf479410"
}'

curl https://test.immersve.com/api/accounts \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "cardholder",
  "name": "string",
  "parentAccountId": "12fff060a9550622e86a7a962f548c1d"
}'

curl https://test.immersve.com/api/accounts \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "partner",
  "name": "string",
  "parentAccountId": "dbc1d6aa6c0b2a5be2f567470623ede5",
  "ownerUserId": "1a4d3b41756ce73db66ed969e4e86448"
}'

curl https://test.immersve.com/api/accounts \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "cardholder",
  "name": "string",
  "partnerAccountId": "12fff060a9550622e86a7a962f548c1d",
  "ownerUserId": "9c4010f2946be546c716add4bf479410"
}'

curl https://test.immersve.com/api/accounts \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "cardholder",
  "name": "string",
  "parentAccountId": "12fff060a9550622e86a7a962f548c1d"
}'

curl https://test.immersve.com/api/accounts \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "partner",
  "name": "string",
  "parentAccountId": "dbc1d6aa6c0b2a5be2f567470623ede5",
  "ownerUserId": "1a4d3b41756ce73db66ed969e4e86448"
}'

Example Response

{
  "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"
}

{
  "statusCode": 400,
  "statusName": "Bad Request",
  "errorCode": "INVALID_REQUEST_INPUT",
  "errors": [
    {
      "message": "Invalid type",
      "path": "items[1].attributes.invalidField"
    }
  ]
}

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