---
updatedAt: 2026-06-02T20:06:00.000Z
agentTools:
projectIndex: https://docs.zerohash.com/llms.txt
---
# Get account details
Retrieves customer account details
# OpenAPI definition
```json
{
"openapi": "3.1.0",
"info": {
"title": "zerohash API",
"description": "\n### Authentication\n\nzerohash Uses HMAC SHA-256 verification to ensure the authenticity of API requests, follow instructions by link [https://docs.zerohash.com/reference/api-authentication](https://docs.zerohash.com/reference/api-authentication)\n\nDownload zerohash OpenAPI Schema as JSON\n",
"version": "1.7.0"
},
"servers": [
{
"url": "https://api.cert.zerohash.com",
"description": "Certification API server"
}
],
"x-readme": {
"proxy-enabled": false
},
"tags": [
{
"name": "Customer Accounts (MTA)",
"description": "Create and Manage Customer Accounts (MTA)"
}
],
"paths": {
"/accounts/{zrn}/details": {
"get": {
"tags": [
"Customer Accounts (MTA)"
],
"summary": "Get account details",
"description": "Retrieves customer account details",
"parameters": [
{
"$ref": "#/components/parameters/Signature"
},
{
"$ref": "#/components/parameters/Timestamp"
},
{
"name": "zrn",
"in": "path",
"description": "Get customer account by account zrn, assigned to the account at creation by zerohash. \nFormat: `zrn:zh:eu:account:customer:`.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successfully retrieved customer account details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerAccountResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Code400"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Code403"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Code404"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Code500"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Code503"
}
}
}
}
}
}
}
},
"security": [
{
"apiKey": [],
"apiPassphrase": []
}
],
"components": {
"securitySchemes": {
"apiKey": {
"type": "apiKey",
"description": "Your API public key. See the [Authentication guide](https://docs.zerohash.com/reference/api-authentication) for how to obtain keys.",
"in": "header",
"name": "X-SCX-API-KEY"
},
"apiPassphrase": {
"type": "apiKey",
"description": "The passphrase associated with your API key, set when the key was created.",
"in": "header",
"name": "X-SCX-PASSPHRASE"
}
},
"parameters": {
"Signature": {
"name": "X-SCX-SIGNED",
"in": "header",
"description": "HMAC-SHA256 signature of the request, base64-encoded. See the [Authentication guide](https://docs.zerohash.com/reference/api-authentication) for the exact signing formula.",
"required": true,
"schema": {
"type": "string"
}
},
"Timestamp": {
"name": "X-SCX-TIMESTAMP",
"in": "header",
"description": "Current Unix timestamp in seconds. Must be within 60 seconds of server time or the request is rejected.",
"required": true,
"schema": {
"type": "string",
"example": "1678901234"
}
}
},
"schemas": {
"Code400": {
"type": "object",
"description": "Request was rejected by validation or a downstream service. `errors` is an array of human-readable messages; each entry describes a single validation failure or business-rule violation.",
"required": [
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"body/amount must be >= 0",
"body/asset is required"
]
}
}
},
"Code403": {
"type": "object",
"description": "Authentication or authorization failed. `error` is always `true`; `message` explains which check failed (missing API key, bad signature, insufficient permission, etc.).",
"required": [
"error",
"message"
],
"properties": {
"error": {
"type": "boolean",
"example": true
},
"message": {
"type": "string",
"example": "This api key does not have write permission to this endpoint"
}
}
},
"Code404": {
"type": "object",
"description": "The requested resource does not exist or is not visible to the caller.",
"required": [
"error"
],
"properties": {
"error": {
"type": "string",
"example": "Not Found"
}
}
},
"Code500": {
"type": "object",
"description": "An unexpected error occurred on the server. The request can be retried after a short delay, but the same inputs may reproduce the error.",
"required": [
"error"
],
"properties": {
"error": {
"type": "string",
"example": "Internal Server Error"
}
}
},
"Code503": {
"type": "object",
"description": "A downstream dependency was unavailable, timed out, or returned a retryable error. Safe to retry; the response carries a `zh-allow-retry: true` header.",
"required": [
"error"
],
"properties": {
"error": {
"type": "string",
"example": "Service Unavailable"
}
}
},
"CustomerAccountResponse": {
"type": "object",
"properties": {
"message": {
"type": "object",
"properties": {
"zrn": {
"type": "string",
"description": "The unique zerohash Account Identifier.",
"example": "zrn:zh:us:accounts:customer:c761fc96-5c44-40d4-8eb2-3fcd5d06754b"
},
"participant_code": {
"type": "string",
"description": "The `participant_code` is the primary account holder.",
"example": "PAR001"
},
"platform_code": {
"type": "string",
"description": "The code of the platform associated with the newly created account.",
"example": "PLAT01"
},
"prefunded": {
"type": "boolean",
"description": "Indicates whether the participant is using a prefunded model, or using the plaform float funding model to fund buy trades. \n\n - If `true`, the participant is prefunding their account and will be responsible for ensuring they have sufficient balance in their account to cover trades. \n - If `false`, the platform will fund trades from their float balance at zerohash, on behalf of the participant and settle at the end of the day. ",
"example": false
},
"account_label": {
"type": "string",
"description": "The platform-dictated account label for the participants account. Accounts labels created for the same participant must have a different `account_label` value, and all maintain an individual balance.",
"example": "custom-account-label"
},
"account_group": {
"type": "string",
"description": "The group that the account is a part of",
"example": "XYZ456"
},
"type": {
"type": "string",
"enum": [
"individual",
"business",
"jtic",
"jtwros",
"trust",
"utma"
],
"description": "The account type associated with the account",
"example": "individual"
},
"tier": {
"type": "string",
"enum": [
"lite",
"pro",
"bronze",
"silver",
"gold"
],
"description": "The account `tier` associated with the account with regards to the commission structure defined by the platform. The specific tier values available depend on the platform configuration.",
"example": "pro"
},
"status": {
"type": "string",
"enum": [
"open",
"locked",
"withdraw_locked",
"divesting",
"closed"
],
"description": "The status of the customer account",
"example": "open"
},
"tenants": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tenants are the second owners of the account and have the same permissions as the primary account holder. Each tenant must be an onboarded participant to zerohash and not the same as the primary account holder.",
"example": [
"PAR002"
]
},
"financial_advisors": {
"type": "array",
"items": {
"type": "string"
},
"description": "The Financial Advisors of the participant which must be an onboarded participant to zerohash and not the same as the primary account holder.",
"example": [
"PAR003"
]
}
}
}
}
}
}
}
}
```