Get an account

GET 
/api/accounts/:accountId

Get an Account by account id

Request

Path Parameters

accountId stringrequired
Id of the account.
Example: 225d85e65495722bf6517ea0ba0d6f56

Responses

200

Successful operation

application/json

Schema

Schema

id string

The unique account ID

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

Example (from schema)

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

403

No Authorization to access resource

application/json

Schema

Schema

statusCode integerrequired
statusName stringrequired
errorCode stringrequired
reason string

Example (from schema)

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

Loading...