{ "info": { "_postman_id": "9de33547-b733-4542-84a5-f0225253783e", "name": "Broker Account Activities Accounts API", "description": "Open brokerage accounts, enable crypto and stock trading, and manage the ongoing user experience with Alpaca Broker API\n\nContact Support:\n Name: Alpaca Support\n Email: support@alpaca.markets", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T00:30:09.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "lastUpdatedBy": "35240", "uid": "35240-9de33547-b733-4542-84a5-f0225253783e" }, "item": [ { "name": "v1", "item": [ { "name": "accounts", "item": [ { "name": "{account_id}", "item": [ { "name": "documents", "item": [ { "name": "upload", "item": [ { "name": "Upload a document to an already existing account", "id": "f8d3df53-ce3e-4964-86bf-1cf72c83cd0a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"document_type\": \"date_of_birth_verification\",\n \"content\": \"\",\n \"mime_type\": \"\",\n \"document_sub_type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:account_id/documents/upload", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":account_id", "documents", "upload" ], "variable": [ { "id": "38c2fc99-6a19-46f4-931a-cbd88fdc1871", "key": "account_id", "value": "", "description": "(Required) Account identifier." } ] }, "description": "Upload a document to be attached to an account.\n\nDocuments are binary objects whose contents are encoded in base64. Each encoded content size is limited to 10MB if you use Alpaca for KYCaaS. If you perform your own KYC there are no document size limitations." }, "response": [ { "id": "ef644b45-8b54-48bd-b287-3d8d14e1d42e", "name": "Success (No Content)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"document_type\": \"date_of_birth_verification\",\n \"content\": \"\",\n \"mime_type\": \"\",\n \"document_sub_type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:account_id/documents/upload", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":account_id", "documents", "upload" ], "variable": [ { "key": "account_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-ef644b45-8b54-48bd-b287-3d8d14e1d42e" }, { "id": "635585bb-e7ae-4eb0-8147-6502451c229a", "name": "Bad Request. The body in the request is not valid.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"document_type\": \"date_of_birth_verification\",\n \"content\": \"\",\n \"mime_type\": \"\",\n \"document_sub_type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:account_id/documents/upload", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":account_id", "documents", "upload" ], "variable": [ { "key": "account_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-635585bb-e7ae-4eb0-8147-6502451c229a" }, { "id": "59b814ae-dc0f-4ae1-a133-144b896461f3", "name": "Not Found. No account was found for this account_id", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"document_type\": \"date_of_birth_verification\",\n \"content\": \"\",\n \"mime_type\": \"\",\n \"document_sub_type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:account_id/documents/upload", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":account_id", "documents", "upload" ], "variable": [ { "key": "account_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-59b814ae-dc0f-4ae1-a133-144b896461f3" } ], "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-f8d3df53-ce3e-4964-86bf-1cf72c83cd0a" } ], "id": "773951ef-7d10-4ed8-b46c-0f235ed558e7", "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-773951ef-7d10-4ed8-b46c-0f235ed558e7" } ], "id": "6dca2cb8-83ef-4eaf-a9e7-e82c81b9e14c", "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-6dca2cb8-83ef-4eaf-a9e7-e82c81b9e14c" }, { "name": "recipient_banks", "item": [ { "name": "{bank_id}", "item": [ { "name": "Delete a Bank Relationship for an account", "id": "ae065f08-f116-4e3e-9532-7989f00bf1f7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v1/accounts/:account_id/recipient_banks/:bank_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":account_id", "recipient_banks", ":bank_id" ], "variable": [ { "id": "d897ef58-1287-4691-9ed8-8bfe368dea3f", "key": "account_id", "value": "", "description": "(Required) Account identifier." }, { "id": "9168299a-0645-44d9-bec8-4925b2a83a57", "key": "bank_id", "value": "", "description": "(Required) " } ] }, "description": "If successful, deletes Bank Relationship for an account" }, "response": [ { "id": "68ccfd31-30ff-4bbf-b0a7-3b7b1b63a33e", "name": "Success (No Content)", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:account_id/recipient_banks/:bank_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":account_id", "recipient_banks", ":bank_id" ], "variable": [ { "key": "account_id" }, { "key": "bank_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-68ccfd31-30ff-4bbf-b0a7-3b7b1b63a33e" }, { "id": "cbd98c4d-32b7-4fd7-9585-a5dce24f921d", "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:account_id/recipient_banks/:bank_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":account_id", "recipient_banks", ":bank_id" ], "variable": [ { "key": "account_id" }, { "key": "bank_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-cbd98c4d-32b7-4fd7-9585-a5dce24f921d" }, { "id": "4a2260e1-3cf3-4d93-a243-9336f421bbfd", "name": "Bank Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:account_id/recipient_banks/:bank_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":account_id", "recipient_banks", ":bank_id" ], "variable": [ { "key": "account_id" }, { "key": "bank_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-4a2260e1-3cf3-4d93-a243-9336f421bbfd" } ], "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-ae065f08-f116-4e3e-9532-7989f00bf1f7" } ], "id": "e743b4c5-bc76-4e8e-9597-abc0772bc260", "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-e743b4c5-bc76-4e8e-9597-abc0772bc260" }, { "name": "Retrieve bank relationships for an account", "id": "d8516945-5458-4a22-b2cc-a3005c46093a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:account_id/recipient_banks?status=ACTIVE&bank_name=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":account_id", "recipient_banks" ], "query": [ { "key": "status", "value": "ACTIVE" }, { "key": "bank_name", "value": "" } ], "variable": [ { "id": "99f99010-38a5-499d-aa97-bb3cb988d52a", "key": "account_id", "value": "", "description": "(Required) Account identifier." } ] }, "description": "Retrieves Bank Relationships for an account" }, "response": [ { "id": "e89d4092-b2ba-495a-a676-a2d284476e8b", "name": "Success. Returns the bank relationship model.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:account_id/recipient_banks?status=ACTIVE&bank_name=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":account_id", "recipient_banks" ], "query": [ { "key": "status", "value": "ACTIVE" }, { "key": "bank_name", "value": "" } ], "variable": [ { "key": "account_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"name\": \"\",\n \"bank_code\": \"\",\n \"bank_code_type\": \"ABA\",\n \"account_number\": \"\",\n \"account_id\": \"\",\n \"status\": \"QUEUED\",\n \"country\": \"\",\n \"state_province\": \"\",\n \"postal_code\": \"\",\n \"city\": \"\",\n \"street_address\": \"\"\n },\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"name\": \"\",\n \"bank_code\": \"\",\n \"bank_code_type\": \"BIC\",\n \"account_number\": \"\",\n \"account_id\": \"\",\n \"status\": \"CANCELED\",\n \"country\": \"\",\n \"state_province\": \"\",\n \"postal_code\": \"\",\n \"city\": \"\",\n \"street_address\": \"\"\n }\n]", "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-e89d4092-b2ba-495a-a676-a2d284476e8b" }, { "id": "6fdb50b5-8d2e-4356-bb8b-62697f6eb76b", "name": "Bad request. The body in the request is not valid.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:account_id/recipient_banks?status=ACTIVE&bank_name=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":account_id", "recipient_banks" ], "query": [ { "key": "status", "value": "ACTIVE" }, { "key": "bank_name", "value": "" } ], "variable": [ { "key": "account_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-6fdb50b5-8d2e-4356-bb8b-62697f6eb76b" } ], "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-d8516945-5458-4a22-b2cc-a3005c46093a" }, { "name": "Create a Bank Relationship for an account", "id": "1704044e-92fb-4471-b4f0-fdc28975ca6d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"bank_code\": \"\",\n \"bank_code_type\": \"ABA\",\n \"account_number\": \"\",\n \"country\": \"\",\n \"state_province\": \"\",\n \"postal_code\": \"\",\n \"city\": \"\",\n \"street_address\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:account_id/recipient_banks", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":account_id", "recipient_banks" ], "variable": [ { "id": "8263cbae-e4ba-4c4d-85ea-b5f9bcea8c4b", "key": "account_id", "value": "", "description": "(Required) Account identifier." } ] }, "description": "If successful, retrieves Bank Relationships for an account" }, "response": [ { "id": "38b1905a-5ea5-4610-8fd9-f50e421fc75e", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"bank_code\": \"\",\n \"bank_code_type\": \"ABA\",\n \"account_number\": \"\",\n \"country\": \"\",\n \"state_province\": \"\",\n \"postal_code\": \"\",\n \"city\": \"\",\n \"street_address\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:account_id/recipient_banks", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":account_id", "recipient_banks" ], "variable": [ { "key": "account_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"name\": \"\",\n \"bank_code\": \"\",\n \"bank_code_type\": \"BIC\",\n \"account_number\": \"\",\n \"account_id\": \"\",\n \"status\": \"QUEUED\",\n \"country\": \"\",\n \"state_province\": \"\",\n \"postal_code\": \"\",\n \"city\": \"\",\n \"street_address\": \"\"\n}", "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-38b1905a-5ea5-4610-8fd9-f50e421fc75e" }, { "id": "e84d8d3d-be95-4040-b026-2ea3a1b06e3f", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"bank_code\": \"\",\n \"bank_code_type\": \"ABA\",\n \"account_number\": \"\",\n \"country\": \"\",\n \"state_province\": \"\",\n \"postal_code\": \"\",\n \"city\": \"\",\n \"street_address\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:account_id/recipient_banks", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":account_id", "recipient_banks" ], "variable": [ { "key": "account_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-e84d8d3d-be95-4040-b026-2ea3a1b06e3f" }, { "id": "3f5634dd-e608-4f05-8cbf-986828a01e68", "name": "Conflict", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"bank_code\": \"\",\n \"bank_code_type\": \"ABA\",\n \"account_number\": \"\",\n \"country\": \"\",\n \"state_province\": \"\",\n \"postal_code\": \"\",\n \"city\": \"\",\n \"street_address\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:account_id/recipient_banks", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":account_id", "recipient_banks" ], "variable": [ { "key": "account_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-3f5634dd-e608-4f05-8cbf-986828a01e68" } ], "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-1704044e-92fb-4471-b4f0-fdc28975ca6d" } ], "id": "f014f357-e847-4769-a6ad-5bd2b76e0210", "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-f014f357-e847-4769-a6ad-5bd2b76e0210" }, { "name": "transfers", "item": [ { "name": "{transfer_id}", "item": [ { "name": "Request to close a transfer", "id": "b59a2fae-711b-4092-8870-5d77bf9efd11", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:account_id/transfers/:transfer_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":account_id", "transfers", ":transfer_id" ], "variable": [ { "id": "a309a77e-2b50-43f8-a6a2-729134568d45", "key": "account_id", "value": "", "description": "(Required) Account identifier." }, { "id": "187b1a9b-c776-41eb-a97b-ac2e6cd25663", "key": "transfer_id", "value": "", "description": "(Required) Tranfer identifier" } ] }, "description": "Request to close a transfer" }, "response": [ { "id": "cfdb6f3e-8fbf-4733-9803-4140da1c4279", "name": "Success (No Content)", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:account_id/transfers/:transfer_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":account_id", "transfers", ":transfer_id" ], "variable": [ { "key": "account_id" }, { "key": "transfer_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-cfdb6f3e-8fbf-4733-9803-4140da1c4279" }, { "id": "ca3e1025-3e61-4185-9f33-dc5a21f9fd78", "name": "Resource does not exist.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:account_id/transfers/:transfer_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":account_id", "transfers", ":transfer_id" ], "variable": [ { "key": "account_id" }, { "key": "transfer_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-ca3e1025-3e61-4185-9f33-dc5a21f9fd78" } ], "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-b59a2fae-711b-4092-8870-5d77bf9efd11" } ], "id": "22dde052-3d6d-4920-8091-98977d894b70", "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-22dde052-3d6d-4920-8091-98977d894b70" }, { "name": "Return a list of transfers for an account.", "id": "43856387-9c3d-423a-9d9c-9b40d903127d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:account_id/transfers?direction=INCOMING&limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":account_id", "transfers" ], "query": [ { "description": "INCOMING or OUTGOING", "key": "direction", "value": "INCOMING" }, { "key": "limit", "value": "" }, { "key": "offset", "value": "" } ], "variable": [ { "id": "c48ef5ee-6609-48cf-b114-331d29e7acd2", "key": "account_id", "value": "", "description": "(Required) Account identifier." } ] }, "description": "You can query a list of transfers for an account.\n\n\nYou can filter requested transfers by values such as direction and status.\n" }, "response": [ { "id": "2753984c-fbd4-497d-8f72-3b5e80d83e81", "name": "Success.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:account_id/transfers?direction=INCOMING&limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":account_id", "transfers" ], "query": [ { "description": "INCOMING or OUTGOING", "key": "direction", "value": "INCOMING" }, { "key": "limit", "value": "" }, { "key": "offset", "value": "" } ], "variable": [ { "key": "account_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"account_id\": \"\",\n \"type\": \"wire\",\n \"status\": \"RETURNED\",\n \"amount\": \"\",\n \"direction\": \"INCOMING\",\n \"created_at\": \"\",\n \"relationship_id\": \"\",\n \"bank_id\": \"\",\n \"reason\": \"\",\n \"updated_at\": \"\",\n \"expires_at\": \"\",\n \"additional_information\": \"\",\n \"hold_until\": \"\",\n \"instant_amount\": \"\"\n },\n {\n \"id\": \"\",\n \"account_id\": \"\",\n \"type\": \"instant_ach\",\n \"status\": \"COMPLETE\",\n \"amount\": \"\",\n \"direction\": \"OUTGOING\",\n \"created_at\": \"\",\n \"relationship_id\": \"\",\n \"bank_id\": \"\",\n \"reason\": \"\",\n \"updated_at\": \"\",\n \"expires_at\": \"\",\n \"additional_information\": \"\",\n \"hold_until\": \"\",\n \"instant_amount\": \"\"\n }\n]", "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-2753984c-fbd4-497d-8f72-3b5e80d83e81" } ], "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-43856387-9c3d-423a-9d9c-9b40d903127d" }, { "name": "Request a new transfer", "id": "879cd348-9dc0-466d-b77e-a5ac4fb75f51", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transfer_type\": \"wire\",\n \"amount\": \"\",\n \"direction\": \"INCOMING\",\n \"timing\": \"immediate\",\n \"relationship_id\": \"\",\n \"bank_id\": \"\",\n \"additional_information\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:account_id/transfers", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":account_id", "transfers" ], "variable": [ { "id": "ddc87e86-5fa9-4ec5-b3ac-80d513c6d382", "key": "account_id", "value": "", "description": "(Required) " } ] }, "description": "Create a new transfer to an account to fund it.\n\nIn the sandbox environment, you can instantly deposit to or withdraw from an account with a virtual money amount. In the production environment, this endpoint is used only for requesting an outgoing (withdrawal) wire transfer at this moment. For the wire transfer (in production), you need to create a bank resource first using the Bank API. For more on how to fund an account in sandbox please check out this tutorial [here](https://alpaca.markets/learn/fund-broker-api/)." }, "response": [ { "id": "4d8faadc-18dd-4a49-b417-6c831ec2d73a", "name": "Successfully requested a transfer.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"transfer_type\": \"wire\",\n \"amount\": \"\",\n \"direction\": \"INCOMING\",\n \"timing\": \"immediate\",\n \"relationship_id\": \"\",\n \"bank_id\": \"\",\n \"additional_information\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:account_id/transfers", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":account_id", "transfers" ], "variable": [ { "key": "account_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"account_id\": \"\",\n \"type\": \"instant_ach\",\n \"status\": \"QUEUED\",\n \"amount\": \"\",\n \"direction\": \"INCOMING\",\n \"created_at\": \"\",\n \"relationship_id\": \"\",\n \"bank_id\": \"\",\n \"reason\": \"\",\n \"updated_at\": \"\",\n \"expires_at\": \"\",\n \"additional_information\": \"\",\n \"hold_until\": \"\",\n \"instant_amount\": \"\"\n}", "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-4d8faadc-18dd-4a49-b417-6c831ec2d73a" } ], "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-879cd348-9dc0-466d-b77e-a5ac4fb75f51" } ], "id": "820c24e8-6e5e-4d3c-91ac-0461b5d9ddf6", "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-820c24e8-6e5e-4d3c-91ac-0461b5d9ddf6" }, { "name": "ach_relationships", "item": [ { "name": "{ach_relationship_id}", "item": [ { "name": "Delete an existing ACH relationship", "id": "0f1c5776-6af0-4281-995b-a0957aaad2f9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:account_id/ach_relationships/:ach_relationship_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":account_id", "ach_relationships", ":ach_relationship_id" ], "variable": [ { "id": "2ae4c1fa-58ae-45af-bd34-4fe0d45ed8bd", "key": "account_id", "value": "", "description": "(Required) Account identifier." }, { "id": "18fa68dc-af4c-43bf-8865-f3e38c28566b", "key": "ach_relationship_id", "value": "", "description": "(Required) ACH relationship identifier" } ] }, "description": "Delete an existing ACH relationship for an account" }, "response": [ { "id": "88595bc1-eb89-48e3-9aca-b047280b64a4", "name": "Success (No Content)", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:account_id/ach_relationships/:ach_relationship_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":account_id", "ach_relationships", ":ach_relationship_id" ], "variable": [ { "key": "account_id" }, { "key": "ach_relationship_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-88595bc1-eb89-48e3-9aca-b047280b64a4" }, { "id": "3a63ebd7-79cc-49cd-95a3-bd329a9917e2", "name": "the passed in account_id or relationship_id were invalid", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:account_id/ach_relationships/:ach_relationship_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":account_id", "ach_relationships", ":ach_relationship_id" ], "variable": [ { "key": "account_id" }, { "key": "ach_relationship_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-3a63ebd7-79cc-49cd-95a3-bd329a9917e2" }, { "id": "ee9354c6-f785-4bfd-882f-968b2e219107", "name": "Resource does not exist.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:account_id/ach_relationships/:ach_relationship_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":account_id", "ach_relationships", ":ach_relationship_id" ], "variable": [ { "key": "account_id" }, { "key": "ach_relationship_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-ee9354c6-f785-4bfd-882f-968b2e219107" } ], "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-0f1c5776-6af0-4281-995b-a0957aaad2f9" } ], "id": "d3eab79b-6791-4ea0-8e7b-863a7dffb2ce", "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-d3eab79b-6791-4ea0-8e7b-863a7dffb2ce" }, { "name": "Retrieve ACH Relationships for an account", "id": "915c7577-e60f-4143-b08a-30a925b9acb9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:account_id/ach_relationships?statuses=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":account_id", "ach_relationships" ], "query": [ { "description": "Comma-separated status values", "key": "statuses", "value": "" } ], "variable": [ { "id": "c4503641-2433-488f-8aa8-fffdbaf9acba", "key": "account_id", "value": "", "description": "(Required) Account identifier." } ] }, "description": "Returns a list of ACH Relationships for an account" }, "response": [ { "id": "b3e963e7-7361-4ba1-9c01-e6b28dd427b6", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:account_id/ach_relationships?statuses=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":account_id", "ach_relationships" ], "query": [ { "description": "Comma-separated status values", "key": "statuses", "value": "" } ], "variable": [ { "key": "account_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"account_id\": \"\",\n \"status\": \"PENDING\",\n \"account_owner_name\": \"\",\n \"bank_account_type\": \"SAVINGS\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"nickname\": \"\"\n },\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"account_id\": \"\",\n \"status\": \"APPROVED\",\n \"account_owner_name\": \"\",\n \"bank_account_type\": \"SAVINGS\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"nickname\": \"\"\n }\n]", "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-b3e963e7-7361-4ba1-9c01-e6b28dd427b6" } ], "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-915c7577-e60f-4143-b08a-30a925b9acb9" }, { "name": "Create an ACH Relationship", "id": "16935de3-2835-413f-91f5-a581fc74ba70", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"account_owner_name\": \"\",\n \"bank_account_type\": \"SAVINGS\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"nickname\": \"\",\n \"processor_token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:account_id/ach_relationships", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":account_id", "ach_relationships" ], "variable": [ { "id": "2e42da15-1b93-4615-99f6-a583f9736c5e", "key": "account_id", "value": "", "description": "(Required) Account identifier." } ] }, "description": "Create a new ACHRelationship for an account\n\nIf successful, will return 200 code with a newly created ACH Relationship entity." }, "response": [ { "id": "6585f089-21de-43eb-9103-a5d9e72cb4c5", "name": "returns the newly created ACH Relationship entity.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"account_owner_name\": \"\",\n \"bank_account_type\": \"SAVINGS\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"nickname\": \"\",\n \"processor_token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:account_id/ach_relationships", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":account_id", "ach_relationships" ], "variable": [ { "key": "account_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"account_id\": \"\",\n \"status\": \"APPROVED\",\n \"account_owner_name\": \"\",\n \"bank_account_type\": \"SAVINGS\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"nickname\": \"\"\n}", "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-6585f089-21de-43eb-9103-a5d9e72cb4c5" }, { "id": "d4f58de8-648c-4d7c-9415-588b49fd811b", "name": "Malformed input.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"account_owner_name\": \"\",\n \"bank_account_type\": \"SAVINGS\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"nickname\": \"\",\n \"processor_token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:account_id/ach_relationships", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":account_id", "ach_relationships" ], "variable": [ { "key": "account_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-d4f58de8-648c-4d7c-9415-588b49fd811b" }, { "id": "fdaa648d-b55d-442f-b1f6-8b2fc54aad87", "name": "Client is not authorized for this operation.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"account_owner_name\": \"\",\n \"bank_account_type\": \"SAVINGS\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"nickname\": \"\",\n \"processor_token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:account_id/ach_relationships", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":account_id", "ach_relationships" ], "variable": [ { "key": "account_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-fdaa648d-b55d-442f-b1f6-8b2fc54aad87" }, { "id": "88ab7e15-e26d-4c34-a77b-e2a4414c5b7a", "name": "The account already has an active relationship.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"account_owner_name\": \"\",\n \"bank_account_type\": \"SAVINGS\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"nickname\": \"\",\n \"processor_token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:account_id/ach_relationships", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":account_id", "ach_relationships" ], "variable": [ { "key": "account_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-88ab7e15-e26d-4c34-a77b-e2a4414c5b7a" } ], "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-16935de3-2835-413f-91f5-a581fc74ba70" } ], "id": "824cc6bc-feeb-4bda-93b9-3264a4095538", "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-824cc6bc-feeb-4bda-93b9-3264a4095538" }, { "name": "Get an account by Id.", "id": "214550e9-3c88-46ba-b28f-375a4dafe9a7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:account_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":account_id" ], "variable": [ { "id": "e8180dcf-3270-4fcc-a180-8790ddd9de44", "key": "account_id", "value": "", "description": "(Required) Account identifier." } ] }, "description": "You can query a specific account that you submitted to Alpaca by passing into the query the account_id associated with the account you\u2019re retrieving.\n" }, "response": [ { "id": "a0d0ae56-50cc-41d5-99b0-d969d7720984", "name": "Will return an AccountExtended if an account with account_id exists, otherwise will throw an error.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:account_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":account_id" ], "variable": [ { "key": "account_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"account_number\": \"\",\n \"status\": \"KYC_SUBMITTED\",\n \"currency\": \"\",\n \"last_equity\": \"\",\n \"created_at\": \"\",\n \"account_type\": \"trading\",\n \"crypto_status\": \"DISABLED\",\n \"kyc_result\": {\n \"reject\": {},\n \"accept\": {},\n \"indeterminate\": {},\n \"addidional_information\": \"\"\n },\n \"contact\": {\n \"email_address\": \"\",\n \"phone_number\": \"\",\n \"street_address\": [\n \"\",\n \"\"\n ],\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\"\n },\n \"identity\": {\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"date_of_birth\": \"\",\n \"country_of_tax_residence\": \"\",\n \"funding_source\": [\n \"savings\",\n \"family\"\n ],\n \"tax_id\": \"\",\n \"tax_id_type\": \"DOM_RNC\",\n \"country_of_citizenship\": \"\",\n \"country_of_birth\": \"\",\n \"annual_income_min\": \"\",\n \"annual_income_max\": \"\",\n \"liquid_net_worth_min\": \"\",\n \"liquid_net_worth_max\": \"\",\n \"total_net_worth_min\": \"\",\n \"total_net_worth_max\": \"\",\n \"extra\": {}\n },\n \"disclosures\": {\n \"is_control_person\": \"\",\n \"is_affiliated_exchange_or_finra\": \"\",\n \"is_politically_exposed\": \"\",\n \"immediate_family_exposed\": \"\",\n \"employment_status\": \"retired\",\n \"employer_name\": \"\",\n \"employer_address\": \"\",\n \"employment_position\": \"\",\n \"context\": [\n {\n \"context_type\": \"IMMEDIATE_FAMILY_EXPOSED\",\n \"company_name\": \"\",\n \"company_street_address\": \"\",\n \"company_city\": \"\",\n \"company_state\": \"\",\n \"company_country\": \"\",\n \"company_compliance_email\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\"\n },\n {\n \"context_type\": \"AFFILIATE_FIRM\",\n \"company_name\": \"\",\n \"company_street_address\": \"\",\n \"company_city\": \"\",\n \"company_state\": \"\",\n \"company_country\": \"\",\n \"company_compliance_email\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\"\n }\n ]\n },\n \"agreements\": [\n {\n \"agreement\": \"customer_agreement\",\n \"signed_at\": \"\",\n \"ip_address\": \"\",\n \"revision\": \"\"\n },\n {\n \"agreement\": \"customer_agreement\",\n \"signed_at\": \"\",\n \"ip_address\": \"\",\n \"revision\": \"\"\n }\n ],\n \"documents\": [\n {\n \"id\": \"\",\n \"document_type\": \"date_of_birth_verification\",\n \"created_at\": \"\",\n \"document_sub_type\": \"\",\n \"mime_type\": \"\"\n },\n {\n \"id\": \"\",\n \"document_type\": \"cip_result\",\n \"created_at\": \"\",\n \"document_sub_type\": \"\",\n \"mime_type\": \"\"\n }\n ],\n \"trusted_contact\": {\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"email_address\": \"\",\n \"phone_number\": \"\",\n \"street_address\": [\n \"\",\n \"\"\n ],\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\"\n },\n \"account_name\": \"\",\n \"custodial_account_type\": \"UTMA\",\n \"minor_identity\": {\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"date_of_birth\": \"\",\n \"country_of_tax_residence\": \"\",\n \"state\": \"\",\n \"email\": \"\",\n \"tax_id\": \"\",\n \"tax_id_type\": \"NOT_SPECIFIED\",\n \"country_of_citizenship\": \"\",\n \"country_of_birth\": \"\"\n },\n \"trading_configurations\": {\n \"dtbp_check\": \"entry\",\n \"trade_confirm_email\": \"none\",\n \"suspend_trade\": \"\",\n \"no_shorting\": \"\",\n \"fractional_trading\": \"\",\n \"max_margin_multiplier\": \"\",\n \"pdt_check\": \"\"\n }\n}", "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-a0d0ae56-50cc-41d5-99b0-d969d7720984" } ], "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-214550e9-3c88-46ba-b28f-375a4dafe9a7" }, { "name": "Update an account", "id": "daaad95a-20ae-4a44-9857-5427dc33f9b8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"contact\": {\n \"email_address\": \"\",\n \"phone_number\": \"\",\n \"street_address\": [\n \"\",\n \"\"\n ],\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\"\n },\n \"identity\": {\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"date_of_birth\": \"\",\n \"country_of_tax_residence\": \"\",\n \"funding_source\": [\n \"family\",\n \"employment_income\"\n ],\n \"tax_id\": \"\",\n \"tax_id_type\": \"USA_SSN\",\n \"country_of_citizenship\": \"\",\n \"country_of_birth\": \"\",\n \"annual_income_min\": \"\",\n \"annual_income_max\": \"\",\n \"liquid_net_worth_min\": \"\",\n \"liquid_net_worth_max\": \"\",\n \"total_net_worth_min\": \"\",\n \"total_net_worth_max\": \"\",\n \"extra\": {}\n },\n \"disclosures\": {\n \"is_control_person\": \"\",\n \"is_affiliated_exchange_or_finra\": \"\",\n \"is_politically_exposed\": \"\",\n \"immediate_family_exposed\": \"\",\n \"employment_status\": \"retired\",\n \"employer_name\": \"\",\n \"employer_address\": \"\",\n \"employment_position\": \"\",\n \"context\": [\n {\n \"context_type\": \"IMMEDIATE_FAMILY_EXPOSED\",\n \"company_name\": \"\",\n \"company_street_address\": \"\",\n \"company_city\": \"\",\n \"company_state\": \"\",\n \"company_country\": \"\",\n \"company_compliance_email\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\"\n },\n {\n \"context_type\": \"IMMEDIATE_FAMILY_EXPOSED\",\n \"company_name\": \"\",\n \"company_street_address\": \"\",\n \"company_city\": \"\",\n \"company_state\": \"\",\n \"company_country\": \"\",\n \"company_compliance_email\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\"\n }\n ]\n },\n \"trustedContact\": {\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"email_address\": \"\",\n \"phone_number\": \"\",\n \"street_address\": [\n \"\",\n \"\"\n ],\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:account_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":account_id" ], "variable": [ { "id": "7703dd7e-18ca-4569-ab1c-1c1d1a6352ab", "key": "account_id", "value": "", "description": "(Required) Account identifier." } ] }, "description": "This operation updates account information.\n\nIf all parameters are valid and updates have been made, it returns with status code 200. The response is the account model." }, "response": [ { "id": "ce7f986f-1672-4fbe-8bf0-f43f9c80db67", "name": "If all parameters are valid and updates have been made, it returns with status code 200. The response is the account model.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"contact\": {\n \"email_address\": \"\",\n \"phone_number\": \"\",\n \"street_address\": [\n \"\",\n \"\"\n ],\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\"\n },\n \"identity\": {\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"date_of_birth\": \"\",\n \"country_of_tax_residence\": \"\",\n \"funding_source\": [\n \"family\",\n \"employment_income\"\n ],\n \"tax_id\": \"\",\n \"tax_id_type\": \"USA_SSN\",\n \"country_of_citizenship\": \"\",\n \"country_of_birth\": \"\",\n \"annual_income_min\": \"\",\n \"annual_income_max\": \"\",\n \"liquid_net_worth_min\": \"\",\n \"liquid_net_worth_max\": \"\",\n \"total_net_worth_min\": \"\",\n \"total_net_worth_max\": \"\",\n \"extra\": {}\n },\n \"disclosures\": {\n \"is_control_person\": \"\",\n \"is_affiliated_exchange_or_finra\": \"\",\n \"is_politically_exposed\": \"\",\n \"immediate_family_exposed\": \"\",\n \"employment_status\": \"retired\",\n \"employer_name\": \"\",\n \"employer_address\": \"\",\n \"employment_position\": \"\",\n \"context\": [\n {\n \"context_type\": \"IMMEDIATE_FAMILY_EXPOSED\",\n \"company_name\": \"\",\n \"company_street_address\": \"\",\n \"company_city\": \"\",\n \"company_state\": \"\",\n \"company_country\": \"\",\n \"company_compliance_email\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\"\n },\n {\n \"context_type\": \"IMMEDIATE_FAMILY_EXPOSED\",\n \"company_name\": \"\",\n \"company_street_address\": \"\",\n \"company_city\": \"\",\n \"company_state\": \"\",\n \"company_country\": \"\",\n \"company_compliance_email\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\"\n }\n ]\n },\n \"trustedContact\": {\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"email_address\": \"\",\n \"phone_number\": \"\",\n \"street_address\": [\n \"\",\n \"\"\n ],\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:account_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":account_id" ], "variable": [ { "key": "account_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"account_number\": \"\",\n \"status\": \"KYC_SUBMITTED\",\n \"currency\": \"\",\n \"last_equity\": \"\",\n \"created_at\": \"\",\n \"account_type\": \"trading\",\n \"crypto_status\": \"DISABLED\",\n \"kyc_result\": {\n \"reject\": {},\n \"accept\": {},\n \"indeterminate\": {},\n \"addidional_information\": \"\"\n },\n \"contact\": {\n \"email_address\": \"\",\n \"phone_number\": \"\",\n \"street_address\": [\n \"\",\n \"\"\n ],\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\"\n },\n \"identity\": {\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"date_of_birth\": \"\",\n \"country_of_tax_residence\": \"\",\n \"funding_source\": [\n \"savings\",\n \"family\"\n ],\n \"tax_id\": \"\",\n \"tax_id_type\": \"DOM_RNC\",\n \"country_of_citizenship\": \"\",\n \"country_of_birth\": \"\",\n \"annual_income_min\": \"\",\n \"annual_income_max\": \"\",\n \"liquid_net_worth_min\": \"\",\n \"liquid_net_worth_max\": \"\",\n \"total_net_worth_min\": \"\",\n \"total_net_worth_max\": \"\",\n \"extra\": {}\n },\n \"disclosures\": {\n \"is_control_person\": \"\",\n \"is_affiliated_exchange_or_finra\": \"\",\n \"is_politically_exposed\": \"\",\n \"immediate_family_exposed\": \"\",\n \"employment_status\": \"retired\",\n \"employer_name\": \"\",\n \"employer_address\": \"\",\n \"employment_position\": \"\",\n \"context\": [\n {\n \"context_type\": \"IMMEDIATE_FAMILY_EXPOSED\",\n \"company_name\": \"\",\n \"company_street_address\": \"\",\n \"company_city\": \"\",\n \"company_state\": \"\",\n \"company_country\": \"\",\n \"company_compliance_email\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\"\n },\n {\n \"context_type\": \"AFFILIATE_FIRM\",\n \"company_name\": \"\",\n \"company_street_address\": \"\",\n \"company_city\": \"\",\n \"company_state\": \"\",\n \"company_country\": \"\",\n \"company_compliance_email\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\"\n }\n ]\n },\n \"agreements\": [\n {\n \"agreement\": \"customer_agreement\",\n \"signed_at\": \"\",\n \"ip_address\": \"\",\n \"revision\": \"\"\n },\n {\n \"agreement\": \"customer_agreement\",\n \"signed_at\": \"\",\n \"ip_address\": \"\",\n \"revision\": \"\"\n }\n ],\n \"documents\": [\n {\n \"id\": \"\",\n \"document_type\": \"date_of_birth_verification\",\n \"created_at\": \"\",\n \"document_sub_type\": \"\",\n \"mime_type\": \"\"\n },\n {\n \"id\": \"\",\n \"document_type\": \"cip_result\",\n \"created_at\": \"\",\n \"document_sub_type\": \"\",\n \"mime_type\": \"\"\n }\n ],\n \"trusted_contact\": {\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"email_address\": \"\",\n \"phone_number\": \"\",\n \"street_address\": [\n \"\",\n \"\"\n ],\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\"\n },\n \"account_name\": \"\",\n \"custodial_account_type\": \"UTMA\",\n \"minor_identity\": {\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"date_of_birth\": \"\",\n \"country_of_tax_residence\": \"\",\n \"state\": \"\",\n \"email\": \"\",\n \"tax_id\": \"\",\n \"tax_id_type\": \"NOT_SPECIFIED\",\n \"country_of_citizenship\": \"\",\n \"country_of_birth\": \"\"\n },\n \"trading_configurations\": {\n \"dtbp_check\": \"entry\",\n \"trade_confirm_email\": \"none\",\n \"suspend_trade\": \"\",\n \"no_shorting\": \"\",\n \"fractional_trading\": \"\",\n \"max_margin_multiplier\": \"\",\n \"pdt_check\": \"\"\n }\n}", "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-ce7f986f-1672-4fbe-8bf0-f43f9c80db67" }, { "id": "fb47e256-5316-49be-9b2a-7f29f525f508", "name": "The post body is not well formed.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"contact\": {\n \"email_address\": \"\",\n \"phone_number\": \"\",\n \"street_address\": [\n \"\",\n \"\"\n ],\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\"\n },\n \"identity\": {\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"date_of_birth\": \"\",\n \"country_of_tax_residence\": \"\",\n \"funding_source\": [\n \"family\",\n \"employment_income\"\n ],\n \"tax_id\": \"\",\n \"tax_id_type\": \"USA_SSN\",\n \"country_of_citizenship\": \"\",\n \"country_of_birth\": \"\",\n \"annual_income_min\": \"\",\n \"annual_income_max\": \"\",\n \"liquid_net_worth_min\": \"\",\n \"liquid_net_worth_max\": \"\",\n \"total_net_worth_min\": \"\",\n \"total_net_worth_max\": \"\",\n \"extra\": {}\n },\n \"disclosures\": {\n \"is_control_person\": \"\",\n \"is_affiliated_exchange_or_finra\": \"\",\n \"is_politically_exposed\": \"\",\n \"immediate_family_exposed\": \"\",\n \"employment_status\": \"retired\",\n \"employer_name\": \"\",\n \"employer_address\": \"\",\n \"employment_position\": \"\",\n \"context\": [\n {\n \"context_type\": \"IMMEDIATE_FAMILY_EXPOSED\",\n \"company_name\": \"\",\n \"company_street_address\": \"\",\n \"company_city\": \"\",\n \"company_state\": \"\",\n \"company_country\": \"\",\n \"company_compliance_email\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\"\n },\n {\n \"context_type\": \"IMMEDIATE_FAMILY_EXPOSED\",\n \"company_name\": \"\",\n \"company_street_address\": \"\",\n \"company_city\": \"\",\n \"company_state\": \"\",\n \"company_country\": \"\",\n \"company_compliance_email\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\"\n }\n ]\n },\n \"trustedContact\": {\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"email_address\": \"\",\n \"phone_number\": \"\",\n \"street_address\": [\n \"\",\n \"\"\n ],\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:account_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":account_id" ], "variable": [ { "key": "account_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-fb47e256-5316-49be-9b2a-7f29f525f508" }, { "id": "44482e04-b5b5-4790-8be1-35655603fb93", "name": "\u200b The request body contains an attribute that is not permitted to be updated or you are attempting to set an invalid value.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"contact\": {\n \"email_address\": \"\",\n \"phone_number\": \"\",\n \"street_address\": [\n \"\",\n \"\"\n ],\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\"\n },\n \"identity\": {\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"date_of_birth\": \"\",\n \"country_of_tax_residence\": \"\",\n \"funding_source\": [\n \"family\",\n \"employment_income\"\n ],\n \"tax_id\": \"\",\n \"tax_id_type\": \"USA_SSN\",\n \"country_of_citizenship\": \"\",\n \"country_of_birth\": \"\",\n \"annual_income_min\": \"\",\n \"annual_income_max\": \"\",\n \"liquid_net_worth_min\": \"\",\n \"liquid_net_worth_max\": \"\",\n \"total_net_worth_min\": \"\",\n \"total_net_worth_max\": \"\",\n \"extra\": {}\n },\n \"disclosures\": {\n \"is_control_person\": \"\",\n \"is_affiliated_exchange_or_finra\": \"\",\n \"is_politically_exposed\": \"\",\n \"immediate_family_exposed\": \"\",\n \"employment_status\": \"retired\",\n \"employer_name\": \"\",\n \"employer_address\": \"\",\n \"employment_position\": \"\",\n \"context\": [\n {\n \"context_type\": \"IMMEDIATE_FAMILY_EXPOSED\",\n \"company_name\": \"\",\n \"company_street_address\": \"\",\n \"company_city\": \"\",\n \"company_state\": \"\",\n \"company_country\": \"\",\n \"company_compliance_email\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\"\n },\n {\n \"context_type\": \"IMMEDIATE_FAMILY_EXPOSED\",\n \"company_name\": \"\",\n \"company_street_address\": \"\",\n \"company_city\": \"\",\n \"company_state\": \"\",\n \"company_country\": \"\",\n \"company_compliance_email\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\"\n }\n ]\n },\n \"trustedContact\": {\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"email_address\": \"\",\n \"phone_number\": \"\",\n \"street_address\": [\n \"\",\n \"\"\n ],\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:account_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":account_id" ], "variable": [ { "key": "account_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-44482e04-b5b5-4790-8be1-35655603fb93" } ], "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-daaad95a-20ae-4a44-9857-5427dc33f9b8" }, { "name": "Request to close an account", "id": "d5ba578e-41cd-465c-ba29-a3acad1b1a03", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v1/accounts/:account_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":account_id" ], "variable": [ { "id": "c86ab9d5-1413-45ca-9d6c-cbf1f0ccdb57", "key": "account_id", "value": "", "description": "(Required) Account identifier." } ] }, "description": "This operation closes an active account." }, "response": [ { "id": "363beb22-ccb8-4051-bcc5-3911fe16a4d9", "name": "No content.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:account_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":account_id" ], "variable": [ { "key": "account_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-363beb22-ccb8-4051-bcc5-3911fe16a4d9" } ], "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-d5ba578e-41cd-465c-ba29-a3acad1b1a03" } ], "id": "982c2ec7-c04b-41e8-9dfc-97d05127196f", "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-982c2ec7-c04b-41e8-9dfc-97d05127196f" }, { "name": "activities", "item": [ { "name": "{activity_type}", "item": [ { "name": "Retrieve specific account activities", "id": "06acaedd-6d68-4ca2-925a-02864f68c891", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/activities/:activity_type?account_id=&date=&until=&after=&direction=asc&page_size=100&page_token=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", "activities", ":activity_type" ], "query": [ { "description": "id of a single account to filter by", "key": "account_id", "value": "" }, { "description": "Both formats YYYY-MM-DD and YYYY-MM-DDTHH:MM:SSZ supported.", "key": "date", "value": "" }, { "description": "Both formats YYYY-MM-DD and YYYY-MM-DDTHH:MM:SSZ supported.", "key": "until", "value": "" }, { "description": "Both formats YYYY-MM-DD and YYYY-MM-DDTHH:MM:SSZ supported.", "key": "after", "value": "" }, { "description": "The chronological order of response based on the submission time. asc or desc. Defaults to desc.", "key": "direction", "value": "asc" }, { "description": "The maximum number of entries to return in the response", "key": "page_size", "value": "100" }, { "description": "The ID of the end of your current page of results", "key": "page_token", "value": "" } ], "variable": [ { "id": "95006629-ee2a-4540-8028-ccca8982e107", "key": "activity_type", "value": "DIVNRA", "description": "(Required) see ActivityType model for details about what the different types mean" } ] }, "description": "Retrieves an Array of Activies by type\n\nNotes:\n* Pagination is handled using the `page_token` and `page_size` parameters.\n* `page_token` represents the ID of the end of your current page of results.\n for example if in your first response the id of the last Activiy item returned in the array was `20220203000000000::045b3b8d-c566-4bef-b741-2bf598dd6ae7`, you'd pass that value as `page_token` to get the next page of results\n\n* If specified with a `direction` of `desc`, for example, the results will end before the activity with the specified ID.\n* If specified with a `direction` of `asc`, results will begin with the activity immediately after the one specified.\n* `page_size` is the maximum number of entries to return in the response.\n* If `date` is not specified, the default and maximum value is 100.\n* If `date` is specified, the default behavior is to return all results, and there is no maximum page size." }, "response": [ { "id": "33e10107-06c1-48e4-aa05-d3e856a1e682", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/accounts/activities/:activity_type?account_id=&date=&until=&after=&direction=asc&page_size=100&page_token=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", "activities", ":activity_type" ], "query": [ { "description": "id of a single account to filter by", "key": "account_id", "value": "" }, { "description": "Both formats YYYY-MM-DD and YYYY-MM-DDTHH:MM:SSZ supported.", "key": "date", "value": "" }, { "description": "Both formats YYYY-MM-DD and YYYY-MM-DDTHH:MM:SSZ supported.", "key": "until", "value": "" }, { "description": "Both formats YYYY-MM-DD and YYYY-MM-DDTHH:MM:SSZ supported.", "key": "after", "value": "" }, { "description": "The chronological order of response based on the submission time. asc or desc. Defaults to desc.", "key": "direction", "value": "asc" }, { "description": "The maximum number of entries to return in the response", "key": "page_size", "value": "100" }, { "description": "The ID of the end of your current page of results", "key": "page_token", "value": "" } ], "variable": [ { "key": "activity_type" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"activity_type\": \"SPLIT\",\n \"account_id\": \"\",\n \"transaction_time\": \"\",\n \"type\": \"partial_fill\",\n \"price\": \"\",\n \"qty\": \"\",\n \"side\": \"cross_short\",\n \"symbol\": \"\",\n \"leaves_qty\": \"\",\n \"order_id\": \"\",\n \"cum_qty\": \"\",\n \"order_status\": \"suspended\"\n },\n {\n \"id\": \"\",\n \"activity_type\": \"DIVCGS\",\n \"account_id\": \"\",\n \"transaction_time\": \"\",\n \"type\": \"fill\",\n \"price\": \"\",\n \"qty\": \"\",\n \"side\": \"cross_short\",\n \"symbol\": \"\",\n \"leaves_qty\": \"\",\n \"order_id\": \"\",\n \"cum_qty\": \"\",\n \"order_status\": \"expired\"\n }\n]", "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-33e10107-06c1-48e4-aa05-d3e856a1e682" } ], "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-06acaedd-6d68-4ca2-925a-02864f68c891" } ], "id": "1ea5cd36-7cf0-4554-a462-dc265ecff0d7", "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-1ea5cd36-7cf0-4554-a462-dc265ecff0d7" }, { "name": "Retrieve account activities", "id": "d37fadb2-2880-417c-816d-61b1841a1df0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/activities?account_id=&date=&until=&after=&direction=asc&page_size=100&page_token=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", "activities" ], "query": [ { "description": "id of a single account to filter by", "key": "account_id", "value": "" }, { "description": "Both formats YYYY-MM-DD and YYYY-MM-DDTHH:MM:SSZ supported.", "key": "date", "value": "" }, { "description": "Both formats YYYY-MM-DD and YYYY-MM-DDTHH:MM:SSZ supported.", "key": "until", "value": "" }, { "description": "Both formats YYYY-MM-DD and YYYY-MM-DDTHH:MM:SSZ supported. Cannot be used with date.", "key": "after", "value": "" }, { "description": "The chronological order of response based on the submission time. asc or desc. Defaults to desc.", "key": "direction", "value": "asc" }, { "description": "The maximum number of entries to return in the response", "key": "page_size", "value": "100" }, { "description": "The Activity ID of the end of your current page of results. ", "key": "page_token", "value": "" } ] }, "description": "Returns an array of Activities\n\nNotes:\n* Pagination is handled using the `page_token` and `page_size` parameters.\n* `page_token` represents the ID of the end of your current page of results.\n for example if in your first response the id of the last Activiy item returned in the array was `20220203000000000::045b3b8d-c566-4bef-b741-2bf598dd6ae7`, you'd pass that value as `page_token` to get the next page of results\n\n* If specified with a `direction` of `desc`, for example, the results will end before the activity with the specified ID.\n* If specified with a `direction` of `asc`, results will begin with the activity immediately after the one specified.\n* `page_size` is the maximum number of entries to return in the response.\n* If `date` is not specified, the default and maximum value is 100.\n* If `date` is specified, the default behavior is to return all results, and there is no maximum page size." }, "response": [ { "id": "21f46128-9079-4666-93dd-8545f868edac", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/accounts/activities?account_id=&date=&until=&after=&direction=asc&page_size=100&page_token=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", "activities" ], "query": [ { "description": "id of a single account to filter by", "key": "account_id", "value": "" }, { "description": "Both formats YYYY-MM-DD and YYYY-MM-DDTHH:MM:SSZ supported.", "key": "date", "value": "" }, { "description": "Both formats YYYY-MM-DD and YYYY-MM-DDTHH:MM:SSZ supported.", "key": "until", "value": "" }, { "description": "Both formats YYYY-MM-DD and YYYY-MM-DDTHH:MM:SSZ supported. Cannot be used with date.", "key": "after", "value": "" }, { "description": "The chronological order of response based on the submission time. asc or desc. Defaults to desc.", "key": "direction", "value": "asc" }, { "description": "The maximum number of entries to return in the response", "key": "page_size", "value": "100" }, { "description": "The Activity ID of the end of your current page of results. ", "key": "page_token", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"activity_type\": \"SPLIT\",\n \"account_id\": \"\",\n \"transaction_time\": \"\",\n \"type\": \"partial_fill\",\n \"price\": \"\",\n \"qty\": \"\",\n \"side\": \"cross_short\",\n \"symbol\": \"\",\n \"leaves_qty\": \"\",\n \"order_id\": \"\",\n \"cum_qty\": \"\",\n \"order_status\": \"suspended\"\n },\n {\n \"id\": \"\",\n \"activity_type\": \"DIVCGS\",\n \"account_id\": \"\",\n \"transaction_time\": \"\",\n \"type\": \"fill\",\n \"price\": \"\",\n \"qty\": \"\",\n \"side\": \"cross_short\",\n \"symbol\": \"\",\n \"leaves_qty\": \"\",\n \"order_id\": \"\",\n \"cum_qty\": \"\",\n \"order_status\": \"expired\"\n }\n]", "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-21f46128-9079-4666-93dd-8545f868edac" } ], "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-d37fadb2-2880-417c-816d-61b1841a1df0" } ], "id": "26177cf5-e9bf-460a-bc8f-21b6f9f2f2e1", "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-26177cf5-e9bf-460a-bc8f-21b6f9f2f2e1" }, { "name": "Get all accounts", "id": "87ff319d-df9e-4e2e-9618-89e8037e1325", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/accounts?query=&created_after=&created_before=&status=&sort=asc&entities=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts" ], "query": [ { "description": "Pass space-delimited tokens. The response will contain accounts that match with each of the tokens (logical AND). A match means the token is present in either the account\u2019s associated account number, phone number, name, or e-mail address (logical OR).", "key": "query", "value": "" }, { "key": "created_after", "value": "" }, { "key": "created_before", "value": "" }, { "description": "See the AccountStatus model for values", "key": "status", "value": "" }, { "description": "The chronological order of response based on the submission time. asc or desc. Defaults to desc.", "key": "sort", "value": "asc" }, { "description": "Comma-delimited entity names to include in the response", "key": "entities", "value": "" } ] }, "description": "Retrieves all accounts found by the query'" }, "response": [ { "id": "3e802d01-9c67-4ab1-9d27-e2fca4c6823c", "name": "The response is a list of Account model up to 1000 items\nper query order by created_at. To scroll the result,\nplease use the created_after parameter.\n", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/accounts?query=&created_after=&created_before=&status=&sort=asc&entities=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts" ], "query": [ { "description": "Pass space-delimited tokens. The response will contain accounts that match with each of the tokens (logical AND). A match means the token is present in either the account\u2019s associated account number, phone number, name, or e-mail address (logical OR).", "key": "query", "value": "" }, { "key": "created_after", "value": "" }, { "key": "created_before", "value": "" }, { "description": "See the AccountStatus model for values", "key": "status", "value": "" }, { "description": "The chronological order of response based on the submission time. asc or desc. Defaults to desc.", "key": "sort", "value": "asc" }, { "description": "Comma-delimited entity names to include in the response", "key": "entities", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"account_number\": \"\",\n \"status\": \"ACTION_REQUIRED\",\n \"currency\": \"\",\n \"created_at\": \"\",\n \"last_equity\": \"\",\n \"crypto_status\": \"ACTIVE\",\n \"kyc_results\": {\n \"reject\": {},\n \"accept\": {},\n \"indeterminate\": {},\n \"addidional_information\": \"\"\n },\n \"account_type\": \"trading\"\n },\n {\n \"id\": \"\",\n \"account_number\": \"\",\n \"status\": \"DISABLED\",\n \"currency\": \"\",\n \"created_at\": \"\",\n \"last_equity\": \"\",\n \"crypto_status\": \"APPROVED\",\n \"kyc_results\": {\n \"reject\": {},\n \"accept\": {},\n \"indeterminate\": {},\n \"addidional_information\": \"\"\n },\n \"account_type\": \"donor_advised\"\n }\n]", "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-3e802d01-9c67-4ab1-9d27-e2fca4c6823c" } ], "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-87ff319d-df9e-4e2e-9618-89e8037e1325" }, { "name": "Create an account", "id": "9db675b4-544b-4c02-a5be-fb736c4975ac", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"contact\": {\n \"email_address\": \"\",\n \"phone_number\": \"\",\n \"street_address\": [\n \"\",\n \"\"\n ],\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\"\n },\n \"identity\": {\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"date_of_birth\": \"\",\n \"country_of_tax_residence\": \"\",\n \"funding_source\": [\n \"inheritance\",\n \"family\"\n ],\n \"tax_id\": \"\",\n \"tax_id_type\": \"URY_RUT\",\n \"country_of_citizenship\": \"\",\n \"country_of_birth\": \"\",\n \"annual_income_min\": \"\",\n \"annual_income_max\": \"\",\n \"liquid_net_worth_min\": \"\",\n \"liquid_net_worth_max\": \"\",\n \"total_net_worth_min\": \"\",\n \"total_net_worth_max\": \"\",\n \"extra\": {}\n },\n \"disclosures\": {\n \"is_control_person\": \"\",\n \"is_affiliated_exchange_or_finra\": \"\",\n \"is_politically_exposed\": \"\",\n \"immediate_family_exposed\": \"\",\n \"employment_status\": \"unemployed\",\n \"employer_name\": \"\",\n \"employer_address\": \"\",\n \"employment_position\": \"\",\n \"context\": [\n {\n \"context_type\": \"IMMEDIATE_FAMILY_EXPOSED\",\n \"company_name\": \"\",\n \"company_street_address\": \"\",\n \"company_city\": \"\",\n \"company_state\": \"\",\n \"company_country\": \"\",\n \"company_compliance_email\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\"\n },\n {\n \"context_type\": \"IMMEDIATE_FAMILY_EXPOSED\",\n \"company_name\": \"\",\n \"company_street_address\": \"\",\n \"company_city\": \"\",\n \"company_state\": \"\",\n \"company_country\": \"\",\n \"company_compliance_email\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\"\n }\n ]\n },\n \"agreements\": [\n {\n \"agreement\": \"margin_agreement\",\n \"signed_at\": \"\",\n \"ip_address\": \"\",\n \"revision\": \"\"\n },\n {\n \"agreement\": \"crypto_agreement\",\n \"signed_at\": \"\",\n \"ip_address\": \"\",\n \"revision\": \"\"\n }\n ],\n \"documents\": [\n {\n \"document_type\": \"date_of_birth_verification\",\n \"content\": \"\",\n \"mime_type\": \"\",\n \"document_sub_type\": \"\"\n },\n {\n \"document_type\": \"tax_id_verification\",\n \"content\": \"\",\n \"mime_type\": \"\",\n \"document_sub_type\": \"\"\n }\n ],\n \"trusted_contact\": {\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"email_address\": \"\",\n \"phone_number\": \"\",\n \"street_address\": [\n \"\",\n \"\"\n ],\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts" ] }, "description": "Submit an account application with KYC information. This will create a trading account for the end user. The account status may or may not be ACTIVE immediately and you will receive account status updates on the event API. " }, "response": [ { "id": "dff1ba58-2617-4956-8969-6e90f8b2e02b", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"contact\": {\n \"email_address\": \"\",\n \"phone_number\": \"\",\n \"street_address\": [\n \"\",\n \"\"\n ],\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\"\n },\n \"identity\": {\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"date_of_birth\": \"\",\n \"country_of_tax_residence\": \"\",\n \"funding_source\": [\n \"inheritance\",\n \"family\"\n ],\n \"tax_id\": \"\",\n \"tax_id_type\": \"URY_RUT\",\n \"country_of_citizenship\": \"\",\n \"country_of_birth\": \"\",\n \"annual_income_min\": \"\",\n \"annual_income_max\": \"\",\n \"liquid_net_worth_min\": \"\",\n \"liquid_net_worth_max\": \"\",\n \"total_net_worth_min\": \"\",\n \"total_net_worth_max\": \"\",\n \"extra\": {}\n },\n \"disclosures\": {\n \"is_control_person\": \"\",\n \"is_affiliated_exchange_or_finra\": \"\",\n \"is_politically_exposed\": \"\",\n \"immediate_family_exposed\": \"\",\n \"employment_status\": \"unemployed\",\n \"employer_name\": \"\",\n \"employer_address\": \"\",\n \"employment_position\": \"\",\n \"context\": [\n {\n \"context_type\": \"IMMEDIATE_FAMILY_EXPOSED\",\n \"company_name\": \"\",\n \"company_street_address\": \"\",\n \"company_city\": \"\",\n \"company_state\": \"\",\n \"company_country\": \"\",\n \"company_compliance_email\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\"\n },\n {\n \"context_type\": \"IMMEDIATE_FAMILY_EXPOSED\",\n \"company_name\": \"\",\n \"company_street_address\": \"\",\n \"company_city\": \"\",\n \"company_state\": \"\",\n \"company_country\": \"\",\n \"company_compliance_email\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\"\n }\n ]\n },\n \"agreements\": [\n {\n \"agreement\": \"margin_agreement\",\n \"signed_at\": \"\",\n \"ip_address\": \"\",\n \"revision\": \"\"\n },\n {\n \"agreement\": \"crypto_agreement\",\n \"signed_at\": \"\",\n \"ip_address\": \"\",\n \"revision\": \"\"\n }\n ],\n \"documents\": [\n {\n \"document_type\": \"date_of_birth_verification\",\n \"content\": \"\",\n \"mime_type\": \"\",\n \"document_sub_type\": \"\"\n },\n {\n \"document_type\": \"tax_id_verification\",\n \"content\": \"\",\n \"mime_type\": \"\",\n \"document_sub_type\": \"\"\n }\n ],\n \"trusted_contact\": {\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"email_address\": \"\",\n \"phone_number\": \"\",\n \"street_address\": [\n \"\",\n \"\"\n ],\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"account_number\": \"\",\n \"status\": \"APPROVED\",\n \"currency\": \"\",\n \"created_at\": \"\",\n \"last_equity\": \"\",\n \"crypto_status\": \"ACCOUNT_UPDATED\",\n \"kyc_results\": {\n \"reject\": {},\n \"accept\": {},\n \"indeterminate\": {},\n \"addidional_information\": \"\"\n },\n \"account_type\": \"donor_advised\"\n}", "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-dff1ba58-2617-4956-8969-6e90f8b2e02b" }, { "id": "76614584-cf7f-4cde-bf8e-2791449118ac", "name": "The post body is not well formed.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"contact\": {\n \"email_address\": \"\",\n \"phone_number\": \"\",\n \"street_address\": [\n \"\",\n \"\"\n ],\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\"\n },\n \"identity\": {\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"date_of_birth\": \"\",\n \"country_of_tax_residence\": \"\",\n \"funding_source\": [\n \"inheritance\",\n \"family\"\n ],\n \"tax_id\": \"\",\n \"tax_id_type\": \"URY_RUT\",\n \"country_of_citizenship\": \"\",\n \"country_of_birth\": \"\",\n \"annual_income_min\": \"\",\n \"annual_income_max\": \"\",\n \"liquid_net_worth_min\": \"\",\n \"liquid_net_worth_max\": \"\",\n \"total_net_worth_min\": \"\",\n \"total_net_worth_max\": \"\",\n \"extra\": {}\n },\n \"disclosures\": {\n \"is_control_person\": \"\",\n \"is_affiliated_exchange_or_finra\": \"\",\n \"is_politically_exposed\": \"\",\n \"immediate_family_exposed\": \"\",\n \"employment_status\": \"unemployed\",\n \"employer_name\": \"\",\n \"employer_address\": \"\",\n \"employment_position\": \"\",\n \"context\": [\n {\n \"context_type\": \"IMMEDIATE_FAMILY_EXPOSED\",\n \"company_name\": \"\",\n \"company_street_address\": \"\",\n \"company_city\": \"\",\n \"company_state\": \"\",\n \"company_country\": \"\",\n \"company_compliance_email\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\"\n },\n {\n \"context_type\": \"IMMEDIATE_FAMILY_EXPOSED\",\n \"company_name\": \"\",\n \"company_street_address\": \"\",\n \"company_city\": \"\",\n \"company_state\": \"\",\n \"company_country\": \"\",\n \"company_compliance_email\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\"\n }\n ]\n },\n \"agreements\": [\n {\n \"agreement\": \"margin_agreement\",\n \"signed_at\": \"\",\n \"ip_address\": \"\",\n \"revision\": \"\"\n },\n {\n \"agreement\": \"crypto_agreement\",\n \"signed_at\": \"\",\n \"ip_address\": \"\",\n \"revision\": \"\"\n }\n ],\n \"documents\": [\n {\n \"document_type\": \"date_of_birth_verification\",\n \"content\": \"\",\n \"mime_type\": \"\",\n \"document_sub_type\": \"\"\n },\n {\n \"document_type\": \"tax_id_verification\",\n \"content\": \"\",\n \"mime_type\": \"\",\n \"document_sub_type\": \"\"\n }\n ],\n \"trusted_contact\": {\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"email_address\": \"\",\n \"phone_number\": \"\",\n \"street_address\": [\n \"\",\n \"\"\n ],\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-76614584-cf7f-4cde-bf8e-2791449118ac" }, { "id": "c0a3ce28-65e9-40fe-a0b9-72f6ce4f0807", "name": "There is already an existing account registered with the same email address.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"contact\": {\n \"email_address\": \"\",\n \"phone_number\": \"\",\n \"street_address\": [\n \"\",\n \"\"\n ],\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\"\n },\n \"identity\": {\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"date_of_birth\": \"\",\n \"country_of_tax_residence\": \"\",\n \"funding_source\": [\n \"inheritance\",\n \"family\"\n ],\n \"tax_id\": \"\",\n \"tax_id_type\": \"URY_RUT\",\n \"country_of_citizenship\": \"\",\n \"country_of_birth\": \"\",\n \"annual_income_min\": \"\",\n \"annual_income_max\": \"\",\n \"liquid_net_worth_min\": \"\",\n \"liquid_net_worth_max\": \"\",\n \"total_net_worth_min\": \"\",\n \"total_net_worth_max\": \"\",\n \"extra\": {}\n },\n \"disclosures\": {\n \"is_control_person\": \"\",\n \"is_affiliated_exchange_or_finra\": \"\",\n \"is_politically_exposed\": \"\",\n \"immediate_family_exposed\": \"\",\n \"employment_status\": \"unemployed\",\n \"employer_name\": \"\",\n \"employer_address\": \"\",\n \"employment_position\": \"\",\n \"context\": [\n {\n \"context_type\": \"IMMEDIATE_FAMILY_EXPOSED\",\n \"company_name\": \"\",\n \"company_street_address\": \"\",\n \"company_city\": \"\",\n \"company_state\": \"\",\n \"company_country\": \"\",\n \"company_compliance_email\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\"\n },\n {\n \"context_type\": \"IMMEDIATE_FAMILY_EXPOSED\",\n \"company_name\": \"\",\n \"company_street_address\": \"\",\n \"company_city\": \"\",\n \"company_state\": \"\",\n \"company_country\": \"\",\n \"company_compliance_email\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\"\n }\n ]\n },\n \"agreements\": [\n {\n \"agreement\": \"margin_agreement\",\n \"signed_at\": \"\",\n \"ip_address\": \"\",\n \"revision\": \"\"\n },\n {\n \"agreement\": \"crypto_agreement\",\n \"signed_at\": \"\",\n \"ip_address\": \"\",\n \"revision\": \"\"\n }\n ],\n \"documents\": [\n {\n \"document_type\": \"date_of_birth_verification\",\n \"content\": \"\",\n \"mime_type\": \"\",\n \"document_sub_type\": \"\"\n },\n {\n \"document_type\": \"tax_id_verification\",\n \"content\": \"\",\n \"mime_type\": \"\",\n \"document_sub_type\": \"\"\n }\n ],\n \"trusted_contact\": {\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"email_address\": \"\",\n \"phone_number\": \"\",\n \"street_address\": [\n \"\",\n \"\"\n ],\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-c0a3ce28-65e9-40fe-a0b9-72f6ce4f0807" }, { "id": "d599308b-cd55-482f-890d-6da477ea8233", "name": "One of the input values is not a valid value.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"contact\": {\n \"email_address\": \"\",\n \"phone_number\": \"\",\n \"street_address\": [\n \"\",\n \"\"\n ],\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\"\n },\n \"identity\": {\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"date_of_birth\": \"\",\n \"country_of_tax_residence\": \"\",\n \"funding_source\": [\n \"inheritance\",\n \"family\"\n ],\n \"tax_id\": \"\",\n \"tax_id_type\": \"URY_RUT\",\n \"country_of_citizenship\": \"\",\n \"country_of_birth\": \"\",\n \"annual_income_min\": \"\",\n \"annual_income_max\": \"\",\n \"liquid_net_worth_min\": \"\",\n \"liquid_net_worth_max\": \"\",\n \"total_net_worth_min\": \"\",\n \"total_net_worth_max\": \"\",\n \"extra\": {}\n },\n \"disclosures\": {\n \"is_control_person\": \"\",\n \"is_affiliated_exchange_or_finra\": \"\",\n \"is_politically_exposed\": \"\",\n \"immediate_family_exposed\": \"\",\n \"employment_status\": \"unemployed\",\n \"employer_name\": \"\",\n \"employer_address\": \"\",\n \"employment_position\": \"\",\n \"context\": [\n {\n \"context_type\": \"IMMEDIATE_FAMILY_EXPOSED\",\n \"company_name\": \"\",\n \"company_street_address\": \"\",\n \"company_city\": \"\",\n \"company_state\": \"\",\n \"company_country\": \"\",\n \"company_compliance_email\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\"\n },\n {\n \"context_type\": \"IMMEDIATE_FAMILY_EXPOSED\",\n \"company_name\": \"\",\n \"company_street_address\": \"\",\n \"company_city\": \"\",\n \"company_state\": \"\",\n \"company_country\": \"\",\n \"company_compliance_email\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\"\n }\n ]\n },\n \"agreements\": [\n {\n \"agreement\": \"margin_agreement\",\n \"signed_at\": \"\",\n \"ip_address\": \"\",\n \"revision\": \"\"\n },\n {\n \"agreement\": \"crypto_agreement\",\n \"signed_at\": \"\",\n \"ip_address\": \"\",\n \"revision\": \"\"\n }\n ],\n \"documents\": [\n {\n \"document_type\": \"date_of_birth_verification\",\n \"content\": \"\",\n \"mime_type\": \"\",\n \"document_sub_type\": \"\"\n },\n {\n \"document_type\": \"tax_id_verification\",\n \"content\": \"\",\n \"mime_type\": \"\",\n \"document_sub_type\": \"\"\n }\n ],\n \"trusted_contact\": {\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"email_address\": \"\",\n \"phone_number\": \"\",\n \"street_address\": [\n \"\",\n \"\"\n ],\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-d599308b-cd55-482f-890d-6da477ea8233" } ], "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-9db675b4-544b-4c02-a5be-fb736c4975ac" } ], "id": "b95c80b7-1f03-4664-8161-107627ba36a0", "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-b95c80b7-1f03-4664-8161-107627ba36a0" }, { "name": "trading", "item": [ { "name": "accounts", "item": [ { "name": "{account_id}", "item": [ { "name": "account", "item": [ { "name": "Retrieve trading details for an account.", "id": "d766ea29-5192-4dc9-bcde-3a67b7fd06ed", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/trading/accounts/:account_id/account", "host": [ "{{baseUrl}}" ], "path": [ "v1", "trading", "accounts", ":account_id", "account" ], "variable": [ { "id": "1679d7e2-77db-487d-834e-970488abe890", "key": "account_id", "value": "", "description": "(Required) Account identifier." } ] }, "description": "As a broker you can view more trading details about your users.\n\nThe response is a Trading Account model." }, "response": [ { "id": "0af09660-a6ab-49e2-baa4-ef418d5343c5", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/trading/accounts/:account_id/account", "host": [ "{{baseUrl}}" ], "path": [ "v1", "trading", "accounts", ":account_id", "account" ], "variable": [ { "key": "account_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"account_number\": \"\",\n \"status\": \"RESUBMITTED\",\n \"currency\": \"\",\n \"created_at\": \"\",\n \"last_equity\": \"\",\n \"equity\": \"\",\n \"cash\": \"\",\n \"buying_power\": \"\",\n \"regt_buying_power\": \"\",\n \"daytrading_buying_power\": \"\",\n \"cash_withdrawable\": \"\",\n \"cash_transferable\": \"\",\n \"pending_transfer_out\": \"\",\n \"portfolio_value\": \"\",\n \"pattern_day_trader\": \"\",\n \"trading_blocked\": \"\",\n \"transfers_blocked\": \"\",\n \"account_blocked\": \"\",\n \"trade_suspended_by_user\": \"\",\n \"multiplier\": \"\",\n \"shorting_enabled\": \"\",\n \"long_market_value\": \"\",\n \"short_market_value\": \"\",\n \"initial_margin\": \"\",\n \"maintenance_margin\": \"\",\n \"last_maintenance_margin\": \"\",\n \"sma\": \"\",\n \"daytrade_count\": \"\",\n \"previous_close\": \"\",\n \"last_long_market_value\": \"\",\n \"last_short_market_value\": \"\",\n \"last_cash\": \"\",\n \"last_initial_margin\": \"\",\n \"last_regt_buying_power\": \"\",\n \"last_daytrading_buying_power\": \"\",\n \"last_buying_power\": \"\",\n \"last_daytrade_count\": \"\",\n \"clearing_broker\": \"\"\n}", "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-0af09660-a6ab-49e2-baa4-ef418d5343c5" } ], "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-d766ea29-5192-4dc9-bcde-3a67b7fd06ed" } ], "id": "9fa06e8d-18d9-4650-8803-60ae13684262", "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-9fa06e8d-18d9-4650-8803-60ae13684262" } ], "id": "250a4422-cf7b-465f-88e4-5b1ca5d7b354", "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-250a4422-cf7b-465f-88e4-5b1ca5d7b354" } ], "id": "2751dd16-f42a-486a-b464-4112c5dc6c11", "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-2751dd16-f42a-486a-b464-4112c5dc6c11" } ], "id": "a8049d07-6dea-41a7-96e9-f3abc51842c7", "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-a8049d07-6dea-41a7-96e9-f3abc51842c7" }, { "name": "events", "item": [ { "name": "accounts", "item": [ { "name": "status", "item": [ { "name": "Subscribe to account status events (SSE).", "id": "bd81c6f5-6828-4291-a6a8-ef7e9b76fb90", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "text/event-stream" } ], "url": { "raw": "{{baseUrl}}/v1/events/accounts/status?since=&until=&since_id=&until_id=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "events", "accounts", "status" ], "query": [ { "description": "Format: YYYY-MM-DD", "key": "since", "value": "" }, { "description": "Format: YYYY-MM-DD", "key": "until", "value": "" }, { "key": "since_id", "value": "" }, { "key": "until_id", "value": "" } ] }, "description": "Events API provide event push as well as historical queries via SSE (server sent events).\n\nHistorical events are streamed immediately if queried, and updates are pushed as events occur.\n\nQuery Params Rules:\n- `since` required if `until` specified\n- `since_id` required if `until_id` specified\n- `since` and `since_id` can\u2019t be used at the same time\nBehavior:\n- if `since` or `since_id` not specified this will not return any historic data\n- if `until` or `until_id` reached stream will end (status 200)\n\n---\n\nNote for people using the clients generated from this OAS spec. Currently OAS-3 doesn't have full support for representing SSE style responses from an API, so if you are using a generated client and don't specify a `since` and `until` there is a good chance the generated clients will hang waiting for the response to end.\n\nIf you require the streaming capabilities we recommend not using the generated clients for this specific usecase until the OAS-3 standards come to a consensus on how to represent this correcting in OAS-3.\n" }, "response": [ { "id": "f2d2bf29-9ad8-4cb5-986a-19c25205ead9", "name": "Connected. Events will now start streaming as long as you keep the connection open.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "text/event-stream" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v1/events/accounts/status?since=&until=&since_id=&until_id=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "events", "accounts", "status" ], "query": [ { "description": "Format: YYYY-MM-DD", "key": "since", "value": "" }, { "description": "Format: YYYY-MM-DD", "key": "until", "value": "" }, { "key": "since_id", "value": "" }, { "key": "until_id", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/event-stream" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"account_id\": \"\",\n \"account_number\": \"\",\n \"status_from\": \"EDITED\",\n \"status_to\": \"EDITED\",\n \"reason\": \"\",\n \"at\": \"\",\n \"event_id\": \"\",\n \"kyc_result\": {\n \"reject\": {},\n \"accept\": {},\n \"indeterminate\": {},\n \"addidional_information\": \"\"\n }\n },\n {\n \"account_id\": \"\",\n \"account_number\": \"\",\n \"status_from\": \"SIGNED_UP\",\n \"status_to\": \"LIMITED\",\n \"reason\": \"\",\n \"at\": \"\",\n \"event_id\": \"\",\n \"kyc_result\": {\n \"reject\": {},\n \"accept\": {},\n \"indeterminate\": {},\n \"addidional_information\": \"\"\n }\n }\n]", "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-f2d2bf29-9ad8-4cb5-986a-19c25205ead9" } ], "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-bd81c6f5-6828-4291-a6a8-ef7e9b76fb90" } ], "id": "cedb8f1f-94d9-4253-b895-530cabeb6d70", "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-cedb8f1f-94d9-4253-b895-530cabeb6d70" } ], "id": "377168b8-6757-4cf2-9ab3-47626ba4836a", "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-377168b8-6757-4cf2-9ab3-47626ba4836a" } ], "id": "62b0ada5-81ef-4cdd-b3f5-193c30907737", "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-62b0ada5-81ef-4cdd-b3f5-193c30907737" } ], "id": "4f7c0f8d-045c-4664-9033-be14d9e921c6", "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-4f7c0f8d-045c-4664-9033-be14d9e921c6" }, { "name": "v2", "item": [ { "name": "account", "item": [ { "name": "Get account", "id": "ba812350-cbb3-49ee-8eac-583877e1322c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/account", "host": [ "{{baseUrl}}" ], "path": [ "v2", "account" ] }, "description": "Returns the account associated with the API key." }, "response": [ { "id": "27149ccc-376b-40f6-9e0f-dabd8c302134", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/v2/account", "host": [ "{{baseUrl}}" ], "path": [ "v2", "account" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"status\": \"ACCOUNT_UPDATED\",\n \"account_number\": \"\",\n \"currency\": \"\",\n \"cash\": \"\",\n \"portfolio_value\": \"\",\n \"pattern_day_trader\": \"\",\n \"trade_suspended_by_user\": \"\",\n \"trading_blocked\": \"\",\n \"transfers_blocked\": \"\",\n \"account_blocked\": \"\",\n \"created_at\": \"\",\n \"shorting_enabled\": \"\",\n \"long_market_value\": \"\",\n \"short_market_value\": \"\",\n \"equity\": \"\",\n \"last_equity\": \"\",\n \"multiplier\": \"\",\n \"buying_power\": \"\",\n \"initial_margin\": \"\",\n \"maintenance_margin\": \"\",\n \"sma\": \"\",\n \"daytrade_count\": \"\",\n \"last_maintenance_margin\": \"\",\n \"daytrading_buying_power\": \"\",\n \"regt_buying_power\": \"\"\n}", "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-27149ccc-376b-40f6-9e0f-dabd8c302134" } ], "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-ba812350-cbb3-49ee-8eac-583877e1322c" } ], "id": "95c5a2d7-d6da-4a4d-9a32-9d5796232ba4", "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-95c5a2d7-d6da-4a4d-9a32-9d5796232ba4" } ], "id": "b9283d5e-32bc-49ec-870f-3f1f992d34ff", "createdAt": "2026-07-28T00:30:10.000Z", "updatedAt": "2026-07-28T00:30:10.000Z", "uid": "35240-b9283d5e-32bc-49ec-870f-3f1f992d34ff" } ], "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://broker-api.sandbox.alpaca.markets" } ] }