Get Account

get/api/accounts/{accountId}

Get an Account by account id

Request

Path Parameters

accountIdstringrequired
Id of the account.

Response

Successful operation.

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.

No Authorization to access resource.

Body application/json

statusCodeintegerrequired
statusNamestringrequired
errorCodestringrequired
reasonstring

Example

Example Request

ServerAuthentication

curl 'https://api.immersve.com/api/accounts/{accountId}' \
  --header 'Authorization: Bearer <access-token>'

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": 403,
  "statusName": "Forbidden",
  "errorCode": "FORBIDDEN",
  "reason": "Unauthorized"
}