--- updatedAt: 2026-04-22T09:12:42.000Z agentTools: projectIndex: https://dev.fuze.finance/llms.txt --- # Get account Get an account for a user. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Digital Assets-as-a-Service", "description": "Digital Assets-as-a-Service (DAaaS) API Documentation", "termsOfService": "https://fuze.finance/", "contact": { "email": "engineering@fuze.finance" }, "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" }, "version": "0.0.7", "x-logo": { "url": "https://fuze.finance/logo.png", "backgroundColor": "white", "altText": "Fuze HQ" } }, "servers": [ { "url": "https://preprod-api.fuze.finance", "description": "Sandbox Server for testing" } ], "paths": { "/api/v1/ol/account/get": { "post": { "tags": [ "Account", "public" ], "summary": "Get account", "description": "Get an account for a user.", "operationId": "OpenLoopGetAccount", "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "name": "X-SIGNATURE", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-TIMESTAMP", "in": "header", "required": true, "schema": { "type": "number" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenLoopGetAccountRequest" } } } }, "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenLoopGetAccountResponse" }, "examples": { "200": { "$ref": "#/components/examples/OpenLoopGetAccountResponseExample200" } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "400": { "$ref": "#/components/examples/InvalidRequestResponseExample" } } } } }, "401": { "description": "Unauthorised.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "401": { "$ref": "#/components/examples/UnauthorisedResponseExample" } } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "403": { "$ref": "#/components/examples/ForbiddenResponseExample" } } } } }, "404": { "description": "Not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "404": { "$ref": "#/components/examples/NotFoundResponseExample" } } } } }, "500": { "description": "Internal server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "500": { "$ref": "#/components/examples/InternalServerErrorResponseExample" } } } } } } } } }, "components": { "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "X-API-KEY" }, "JWT": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } }, "examples": { "InvalidRequestResponseExample": { "value": { "code": 400, "error": "INVALID_REQUEST", "data": null } }, "UnauthorisedResponseExample": { "value": { "code": 401, "error": "UNAUTHENTICATED", "data": null } }, "ForbiddenResponseExample": { "value": { "code": 403, "error": "FORBIDDEN", "data": null } }, "NotFoundResponseExample": { "value": { "code": 404, "error": "NOT_FOUND", "data": null } }, "InternalServerErrorResponseExample": { "value": { "code": 500, "error": "INTERNAL_SERVER_ERROR", "data": null } }, "OpenLoopGetAccountResponseExample200": { "value": { "code": 200, "error": null, "data": { "orgUserId": "sherlock_holmes", "counterPartyId": "john_watson", "accountId": "123e4567-e89b-12d3-a456-426614174000", "status": "APPROVED", "owner": "THIRD_PARTY", "accountType": "EXTERNAL", "createdAt": "2023-10-01T00:00:00Z", "updatedAt": "2023-10-01T00:00:00Z", "accountDetails": { "accountNumber": "1234567890", "beneficiaryName": "John Watson", "bankName": "Bank of Baker Street", "bankCountry": "GB", "bankCity": "London", "currency": "AED", "type": "swift", "swift": "BOFAUS3N", "nickname": "John" } } } } }, "schemas": { "ErrorResponse": { "type": "object", "properties": { "code": { "type": "number", "description": "HTTP status code for the error (e.g. 400, 401, 404, 500).", "example": 400 }, "error": { "type": "string", "nullable": true, "description": "Machine-readable error code. Clients should branch on this rather than parsing the message.", "example": "INVALID_REQUEST" }, "data": { "type": "object", "nullable": true, "description": "Always null for error responses. Included for shape parity with success responses.", "example": null } }, "required": [ "code", "error", "data" ] }, "OpenLoopAccount": { "type": "object", "properties": { "orgUserId": { "type": "string", "description": "Identifier of the user who owns this account.", "example": "sherlock_holmes" }, "counterPartyId": { "type": "string", "description": "Counterparty this account belongs to. Null for internal accounts; always set for external accounts.", "nullable": true, "example": "123e4567-ea9b-12d3-a456-426614174000" }, "accountId": { "type": "string", "description": "Fuze-assigned UUID for the account. Use this ID to reference the account in transfer and listing calls.", "example": "123e4567-e89b-12d3-a456-426614174000" }, "owner": { "type": "string", "description": "Who owns the account. Internal accounts are always FIRST_PARTY. External accounts may be FIRST_PARTY or THIRD_PARTY.", "enum": [ "THIRD_PARTY", "FIRST_PARTY" ], "example": "THIRD_PARTY" }, "accountType": { "type": "string", "description": "INTERNAL accounts are custodied by Fuze on behalf of the user. EXTERNAL accounts are external bank accounts whitelisted for deposits or withdrawals.", "enum": [ "INTERNAL", "EXTERNAL" ], "example": "INTERNAL" }, "status": { "type": "string", "description": "Whitelisting state. Typically PENDING during review and APPROVED once usable for transfers.", "example": "APPROVED" }, "createdAt": { "type": "string", "format": "date-time", "description": "Timestamp the account was created, in ISO 8601 UTC.", "example": "2025-03-10T14:30:00Z" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Timestamp of the most recent change to the account, in ISO 8601 UTC.", "example": "2025-03-12T09:15:00Z" }, "accountDetails": { "type": "object", "properties": { "currency": { "type": "string", "description": "Fiat currency the account is denominated in (e.g. USD, EUR, AED).", "example": "USD" }, "beneficiaryName": { "type": "string", "description": "Name of the beneficiary registered on the bank account. Must match the account holder's legal name on the bank statement.", "example": "Sherlock Holmes" }, "accountNumber": { "type": "string", "description": "Local bank account number. For IBAN-based regions this may repeat the IBAN's BBAN portion.", "example": "123456789" }, "nickname": { "type": "string", "description": "User-provided short name for the account, shown in listings.", "example": "Sherlock" }, "bankName": { "type": "string", "description": "Full name of the bank holding the account.", "example": "Bank of America" }, "bankCountry": { "type": "string", "description": "ISO 3166-1 alpha-2 country code of the bank. Refer [list countries API](https://dev.fuze.finance/reference/openlooplistcountries).", "example": "US" }, "bankCity": { "type": "string", "description": "City where the bank branch is located. Required when sending USD to the external account.", "example": "New York" }, "bankAddressLine1": { "type": "string", "description": "First line of the bank's address.", "example": "270 Park Avenue" }, "bankAddressLine2": { "type": "string", "description": "Second line of the bank's address.", "example": "Floor 12" }, "bankState": { "type": "string", "description": "State or region where the bank is located.", "example": "New York" }, "bankPostalCode": { "type": "string", "description": "Postal / ZIP code of the bank's address.", "example": "10017" }, "type": { "type": "string", "description": "Which bank identifier is used to route to this account. Determines whether iban, swift, or routingNumber must be populated.", "enum": [ "iban", "swift", "routingNumber" ], "example": "iban" }, "iban": { "type": "string", "description": "International Bank Account Number. Provide when type is \"iban\". One of iban, swift, or routingNumber is required.", "example": "AE210860000006320984516" }, "swift": { "type": "string", "description": "SWIFT/BIC code of the bank. Provide when type is \"swift\". One of iban, swift, or routingNumber is required.", "example": "BOFAUS3N" }, "routingNumber": { "type": "string", "description": "ABA routing number for US banks. Provide when type is \"routingNumber\". One of iban, swift, or routingNumber is required.", "example": "021000021" } }, "required": [ "currency", "beneficiaryName", "accountNumber", "bankName", "bankCountry", "type" ] } }, "required": [ "orgUserId", "accountId", "status", "accountType", "createdAt", "updatedAt", "accountDetails" ] }, "OpenLoopGetAccountRequest": { "type": "object", "properties": { "orgUserId": { "type": "string", "description": "Unique identifier of the user.", "example": "sherlock_holmes" }, "accountId": { "type": "string", "description": "Unique identifier of the account.", "example": "123e4567-e89b-12d3-a456-426614174000" } }, "required": [ "orgUserId", "accountId" ], "xml": { "name": "OpenLoopGetAccountRequest" } }, "OpenLoopGetAccountResponse": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "example": 200 }, "error": { "type": "string", "nullable": true, "example": null }, "data": { "$ref": "#/components/schemas/OpenLoopAccount" } }, "required": [ "code", "error", "data" ], "xml": { "name": "OpenLoopGetAccountResponse" } } } }, "security": [ { "JWT": [] } ] } ```