PolySign
AtomicNet API Server

The node-side REST interface for interacting with an AtomicNet node — registering assets and partners, publishing orders and book transfers, requesting and approving escrow and beneficiary authorizations, publishing settlements, releasing settlement and book transfer confirmations, polling status updates, minting one-time investor identifiers, canonicalization and UID utilities, data synchronization, and system health / circuit-breaker checks. Fifty-six operations secured with OAuth 2.0 client credentials.
Documentation GitHub OpenAPI
OpenAPI Specification

{"info": {"description": "The API Server as the interface to interact with AtomicNet", "license": {"name": "PolySign License", "url": "https://polysign.io/licenses/LICENSE-1.0"}, "title": "AtomicNet API Server", "version": "5ba508e7771507febd8e2056c369fffd575b4272"}, "components": {"securitySchemes": {"OAuth2": {"type": "oauth2", "description": "OAuth 2.0 with the client credentials grant flow.", "flows": {"clientCredentials": {"tokenUrl": "/v1/auth/token", "scopes": {"participant": "Grants access to participant."}}}}}, "schemas": {"OnetimeIdMap": {"type": "object", "properties": {"one_time_id": {"type": "string", "description": "The one time ID."}, "real_id": {"type": "string", "description": "The real ID."}}, "required": ["one_time_id", "real_id"], "description": "ID mapping."}, "OnetimeIdMapList": {"type": "object", "properties": {"id_maps": {"type": "array", "description": "The list of ID mappings.", "items": {"$ref": "#/components/schemas/OnetimeIdMap"}}}, "description": "List of ID mappings."}, "Metadata": {"type": "object", "properties": {"investor_ids": {"default": null, "nullable": true, "description": "The investor id mappings.", "allOf": [{"$ref": "#/components/schemas/OnetimeIdMapList"}]}, "book_operator_id": {"type": "string", "format": "uuid", "default": null, "nullable": true, "description": "Identifier for the associated Book Operator node."}, "request_id": {"type": "string", "default": null, "nullable": true, "description": "Unique identifier for the request."}, "exchange_id": {"type": "string", "format": "uuid", "default": null, "nullable": true, "description": "Identifier for the associated Exchange node."}, "status": {"type": "string", "default": null, "nullable": true, "description": "State status for the record object."}, "trade_portal_id": {"type": "string", "format": "uuid", "default": null, "nullable": true, "description": "Identifier for the associated Trade Portal node."}, "commission": {"type": "number", "default": null, "nullable": true, "description": "Order commissison."}, "real_investor_id": {"type": "string", "default": null, "nullable": true, "description": "Original identifier for the investor."}, "expired": {"type": "boolean", "default": false, "nullable": true, "description": "Expiry status for the record object."}}}, "AbcSignature": {"type": "object", "properties": {"digest_type": {"type": "string", "description": "The ABC digest type."}, "abc_account_id": {"type": "string", "description": "Identifier of the ABC account."}, "signature": {"type": "string", "description": "Signature of the digest."}, "digest": {"type": "string", "description": "The digest to be signed."}, "schema_version": {"type": "integer", "default": 1, "nullable": true, "description": "Version for the message schema."}}, "required": ["abc_account_id", "digest", "digest_type", "signature"]}, "AssetRecord": {"type": "object", "properties": {"book_operator_id": {"type": "string", "format": "uuid", "description": "Identifier of the Book Operator to process the asset."}, "exchange_id": {"type": "string", "format": "uuid", "description": "Identifier of the Exchange to process the asset."}, "status": {"type": "string", "description": "The activation status of the asset."}, "asset_id": {"type": "string", "description": "Identifier of the asset."}, "precision": {"type": "integer", "description": "Asset precision."}}, "required": ["asset_id", "book_operator_id", "exchange_id", "precision", "status"], "description": "Asset record object."}, "Asset": {"type": "object", "properties": {"metadata": {"description": "Metadata for the associated record object.", "allOf": [{"$ref": "#/components/schemas/Metadata"}]}, "partner_asset_id": {"type": "string", "default": null, "nullable": true, "description": "Partner's asset ID."}, "signature": {"default": null, "nullable": true, "description": "Signature for the associated record object.", "allOf": [{"$ref": "#/components/schemas/AbcSignature"}]}, "schema_version": {"type": "integer", "default": 1, "description": "Version for the message schema."}, "record": {"description": "Asset record.", "allOf": [{"$ref": "#/components/schemas/AssetRecord"}]}}, "required": ["record"]}, "AssetList": {"type": "object", "properties": {"assets": {"type": "array", "description": "The list of assets.", "items": {"$ref": "#/components/schemas/Asset"}}}, "required": ["assets"], "description": "List of asset registration object."}, "AssetMapping": {"type": "object", "properties": {"partner_asset_id": {"type": "string", "description": "Partner's asset ID."}, "asset_id": {"type": "string", "description": "The PolyNet CUSIP asset ID."}}, "required": ["asset_id", "partner_asset_id"]}, "OnetimeIdMap1": {"type": "object", "properties": {"one_time_id": {"type": "string", "description": "The one time ID."}, "real_id": {"type": "string", "description": "The real ID."}}, "required": ["one_time_id", "real_id"], "description": "ID mapping."}, "OnetimeIdMapList1": {"type": "object", "properties": {"id_maps": {"type": "array", "description": "The list of ID mappings.", "items": {"$ref": "#/components/schemas/OnetimeIdMap1"}}}, "description": "List of ID mappings."}, "Metadata1": {"type": "object", "properties": {"investor_ids": {"default": null, "nullable": true, "description": "The investor id mappings.", "allOf": [{"$ref": "#/components/schemas/OnetimeIdMapList1"}]}, "book_operator_id": {"type": "string", "format": "uuid", "default": null, "nullable": true, "description": "Identifier for the associated Book Operator node."}, "request_id": {"type": "string", "default": null, "nullable": true, "description": "Unique identifier for the request."}, "exchange_id": {"type": "string", "format": "uuid", "default": null, "nullable": true, "description": "Identifier for the associated Exchange node."}, "status": {"type": "string", "default": null, "nullable": true, "description": "State status for the record object."}, "trade_portal_id": {"type": "string", "format": "uuid", "default": null, "nullable": true, "description": "Identifier for the associated Trade Portal node."}, "commission": {"type": "number", "default": null, "nullable": true, "description": "Order commissison."}, "real_investor_id": {"type": "string", "default": null, "nullable": true, "description": "Original identifier for the investor."}, "expired": {"type": "boolean", "default": false, "nullable": true, "description": "Expiry status for the record object."}}}, "AbcSignature1": {"type": "object", "properties": {"digest_type": {"type": "string", "description": "The ABC digest type."}, "abc_account_id": {"type": "string", "description": "Identifier of the ABC account."}, "signature": {"type": "string", "description": "Signature of the digest."}, "digest": {"type": "string", "description": "The digest to be signed."}, "schema_version": {"type": "integer", "default": 1, "nullable": true, "description": "Version for the message schema."}}, "required": ["abc_account_id", "digest", "digest_type", "signature"]}, "EscrowAuthRecord": {"type": "object", "properties": {"expiration": {"type": "string", "format": "date-time", "description": "ISO formatted timestamp for the authorization to last."}, "investor_id": {"type": "string", "description": "Identifier of the investor that holds the asset under escrow."}, "asset_quantity": {"type": "number", "description": "Quantity of the asset being escrowed"}, "asset_id": {"type": "string", "description": "Identifier of the asset being escrowed."}, "escrow_auth_id": {"type": "string", "format": "uuid", "description": "Identifier of the escrow that holds the assets."}}, "required": ["asset_id", "asset_quantity", "escrow_auth_id", "expiration", "investor_id"], "description": "Escrow authorization record object."}, "EscrowAuth": {"type": "object", "properties": {"execution_status": {"type": "string", "default": null, "nullable": true, "description": "Execution status for the escrow authorization object."}, "metadata": {"description": "Metadata for the associated record object.", "allOf": [{"$ref": "#/components/schemas/Metadata1"}]}, "schema_version": {"type": "integer", "default": 1, "description": "Version for the message schema."}, "signature": {"default": null, "nullable": true, "description": "Signature for the associated record object.", "allOf": [{"$ref": "#/components/schemas/AbcSignature1"}]}, "remaining_quantity": {"type": "number", "default": null, "nullable": true, "description": "Unused quantity of the asset being escrowed"}, "record": {"description": "Escrow authorization record.", "allOf": [{"$ref": "#/components/schemas/EscrowAuthRecord"}]}}, "required": ["record"], "description": "Escrow authorization schema."}, "EscrowAuthList": {"type": "object", "properties": {"escrow_auths": {"type": "array", "items": {"$ref": "#/components/schemas/EscrowAuth"}}}, "required": ["escrow_auths"]}, "OnetimeIdMap2": {"type": "object", "properties": {"one_time_id": {"type": "string", "description": "The one time ID."}, "real_id": {"type": "string", "description": "The real ID."}}, "required": ["one_time_id", "real_id"], "description": "ID mapping."}, "OnetimeIdMapList2": {"type": "object", "properties": {"id_maps": {"type": "array", "description": "The list of ID mappings.", "items": {"$ref": "#/components/schemas/OnetimeIdMap2"}}}, "description": "List of ID mappings."}, "Metadata2": {"type": "object", "properties": {"investor_ids": {"default": null, "nullable": true, "description": "The investor id mappings.", "allOf": [{"$ref": "#/components/schemas/OnetimeIdMapList2"}]}, "book_operator_id": {"type": "string", "format": "uuid", "default": null, "nullable": true, "description": "Identifier for the associated Book Operator node."}, "request_id": {"type": "string", "default": null, "nullable": true, "description": "Unique identifier for the request."}, "exchange_id": {"type": "string", "format": "uuid", "default": null, "nullable": true, "description": "Identifier for the associated Exchange node."}, "status": {"type": "string", "default": null, "nullable": true, "description": "State status for the record object."}, "trade_portal_id": {"type": "string", "format": "uuid", "default": null, "nullable": true, "description": "Identifier for the associated Trade Portal node."}, "commission": {"type": "number", "default": null, "nullable": true, "description": "Order commissison."}, "real_investor_id": {"type": "string", "default": null, "nullable": true, "description": "Original identifier for the investor."}, "expired": {"type": "boolean", "default": false, "nullable": true, "description": "Expiry status for the record object."}}}, "AbcSignature2": {"type": "object", "properties": {"digest_type": {"type": "string", "description": "The ABC digest type."}, "abc_account_id": {"type": "string", "description": "Identifier of the ABC account."}, "signature": {"type": "string", "description": "Signature of the digest."}, "digest": {"type": "string", "description": "The digest to be signed."}, "schema_version": {"type": "integer", "default": 1, "nullable": true, "description": "Version for the message schema."}}, "required": ["abc_account_id", "digest", "digest_type", "signature"]}, "OrderRecord": {"type": "object", "properties": {"give_quantity": {"type": "number", "description": "Quantity of the asset being offered."}, "expiration": {"type": "string", "format": "date-time", "description": "ISO formatted timestamp for the order expiry."}, "order_id": {"type": "string", "format": "uuid", "default": null, "nullable": true, "description": "Identifier of the order."}, "investor_id": {"type": "string", "description": "Identifier of the investor that placed the order."}, "give_asset_id": {"type": "string", "description": "Identifier of the asset being offered."}, "take_quantity": {"type": "number", "description": "Quantity of the asset to receive."}, "take_asset_id": {"type": "string", "description": "Identifier of the asset to receive."}}, "required": ["expiration", "give_asset_id", "give_quantity", "investor_id", "take_asset_id", "take_quantity"]}, "Order": {"type": "object", "properties": {"give_remaining": {"type": "number", "default": null, "nullable": true, "description": "Remaining for the give quantity."}, "execution_status": {"type": "string", "default": null, "nullable": true, "description": "Execution status for the order object."}, "metadata": {"description": "Metadata for the associated record object.", "allOf": [{"$ref": "#/components/schemas/Metadata2"}]}, "schema_version": {"type": "integer", "default": 1, "description": "Version for the message schema."}, "beneficiary_auth_id": {"type": "string", "format": "uuid", "default": null, "nullable": true, "description": "Identifier of the pre-approved beneficiary authorization."}, "signature": {"default": null, "nullable": true, "description": "Signature for the associated record object.", "allOf": [{"$ref": "#/components/schemas/AbcSignature2"}]}, "record": {"description": "Order record.", "allOf": [{"$ref": "#/components/schemas/OrderRecord"}]}, "escrow_auth_id": {"type": "string", "format": "uuid", "default": null, "nullable": true, "description": "Identifier of the pre-approved escrow authorization."}}, "required": ["record"]}, "OrderList": {"type": "object", "properties": {"orders": {"type": "array", "items": {"$ref": "#/components/schemas/Order"}}}, "required": ["orders"], "description": "List of complete orders object."}, "Ping": {"type": "object", "properties": {"alive": {"type": "boolean"}}}, "Version": {"type": "object", "properties": {"version": {"type": "string"}, "build_time": {"type": "string"}}}, "DeepPing": {"type": "object", "properties": {"alive": {"type": "boolean"}, "database_reachable": {"type": "boolean"}, "schema_version": {"type": "integer", "default": 1, "description": "Version for the message schema."}}, "required": ["alive", "database_reachable"]}, "AtomicNetUID": {"type": "object", "properties": {"atomicnet_uid": {"type": "string", "format": "uuid", "description": "AtomicNet UID."}, "schema_version": {"type": "integer", "default": 1, "description": "Version for the message schema."}}, "required": ["atomicnet_uid"]}, "CanonicalizeReq": {"type": "object", "properties": {"schema_version": {"type": "integer", "default": 1, "description": "Version for the message schema."}, "message_data": {"description": "Data to be canonicalized."}}, "required": ["message_data"], "description": "Canonicalization request object."}, "CanonicalizeResp": {"type": "object", "properties": {"book_transfer_id": {"type": "string", "format": "uuid", "default": null, "nullable": true, "description": "The PolyNet generated book transfer ID."}, "order_id": {"type": "string", "format": "uuid", "default": null, "nullable": true, "description": "The PolyNet generated order ID."}, "settlement_id": {"type": "string", "format": "uuid", "default": null, "nullable": true, "description": "The PolyNet generated settlement ID."}, "digest": {"type": "string", "description": "Digest to validate serialized_message."}, "schema_version": {"type": "integer", "default": 1, "description": "Version for the message schema."}, "serialized_message": {"type": "string", "description": "Serialized message for sign."}}, "required": ["digest", "serialized_message"], "description": "Canonicalization response object."}, "OrderStatusUpdate": {"type": "object", "properties": {"order_id": {"type": "string", "format": "uuid", "description": "Identifier of the order that was updated."}, "order_status_update_id": {"type": "string", "format": "uuid", "description": "Identifier of the order status update."}, "last_updated": {"type": "string", "format": "date-time", "description": "ISO formatted timestamp for order last status update."}, "status": {"type": "string", "description": "The most recently updated order status."}}, "required": ["last_updated", "order_id", "order_status_update_id", "status"], "description": "Order status update object."}, "OrderStatusUpdateList": {"type": "object", "properties": {"order_status_updates": {"type": "array", "items": {"$ref": "#/components/schemas/OrderStatusUpdate"}}}, "required": ["order_status_updates"], "description": "List of order status update objects."}, "OnetimeIdMap3": {"type": "object", "properties": {"one_time_id": {"type": "string", "description": "The one time ID."}, "real_id": {"type": "string", "description": "The real ID."}}, "required": ["one_time_id", "real_id"], "description": "ID mapping."}, "OnetimeIdMapList3": {"type": "object", "properties": {"id_maps": {"type": "array", "description": "The list of ID mappings.", "items": {"$ref": "#/components/schemas/OnetimeIdMap3"}}}, "description": "List of ID mappings."}, "Metadata3": {"type": "object", "properties": {"investor_ids": {"default": null, "nullable": true, "description": "The investor id mappings.", "allOf": [{"$ref": "#/components/schemas/OnetimeIdMapList3"}]}, "book_operator_id": {"type": "string", "format": "uuid", "default": null, "nullable": true, "description": "Identifier for the associated Book Operator node."}, "request_id": {"type": "string", "default": null, "nullable": true, "description": "Unique identifier for the request."}, "exchange_id": {"type": "string", "format": "uuid", "default": null, "nullable": true, "description": "Identifier for the associated Exchange node."}, "status": {"type": "string", "default": null, "nullable": true, "description": "State status for the record object."}, "trade_portal_id": {"type": "string", "format": "uuid", "default": null, "nullable": true, "description": "Identifier for the associated Trade Portal node."}, "commission": {"type": "number", "default": null, "nullable": true, "description": "Order commissison."}, "real_investor_id": {"type": "string", "default": null, "nullable": true, "description": "Original identifier for the investor."}, "expired": {"type": "boolean", "default": false, "nullable": true, "description": "Expiry status for the record object."}}}, "AbcSignature3": {"type": "object", "properties": {"digest_type": {"type": "string", "description": "The ABC digest type."}, "abc_account_id": {"type": "string", "description": "Identifier of the ABC account."}, "signature": {"type": "string", "description": "Signature of the digest."}, "digest": {"type": "string", "description": "The digest to be signed."}, "schema_version": {"type": "integer", "default": 1, "nullable": true, "description": "Version for the message schema."}}, "required": ["abc_account_id", "digest", "digest_type", "signature"]}, "SettlementRecord": {"type": "object", "properties": {"left_order_id": {"type": "string", "format": "uuid", "description": "Identifier of the left order."}, "right_order_id": {"type": "string", "format": "uuid", "description": "Identifier of the right order."}, "left_order_give_quantity": {"type": "number", "description": "The quantity which the left order to give for the left order given asset."}, "right_order_commission": {"type": "number", "description": "The commission for the right order in order to execute this settlement."}, "settlement_id": {"type": "string", "format": "uuid", "default": null, "nullable": true, "description": "Identifier of the settlement."}, "left_order_commission": {"type": "number", "description": "The commission for the left order in order to execute this settlement."}, "right_order_give_quantity": {"type": "number", "description": "The quantity which the right order to give for the right order given asset."}}, "required": ["left_order_commission", "left_order_give_quantity", "left_order_id", "right_order_commission", "right_order_give_quantity", "right_order_id"]}, "Settlement": {"type": "object", "properties": {"abc_memorial_digest": {"type": "string", "default": null, "nullable": true, "description": "The digest been memorialized in ABC."}, "metadata": {"description": "Metadata for the associated record object.", "allOf": [{"$ref": "#/components/schemas/Metadata3"}]}, "schema_version": {"type": "integer", "default": 1, "description": "Version for the message schema."}, "signature": {"default": null, "nullable": true, "description": "Signature for the associated record object.", "allOf": [{"$ref": "#/components/schemas/AbcSignature3"}]}, "abc_memorialization_block": {"type": "integer", "default": null, "nullable": true, "description": "The block height the memorialization localed."}, "record": {"description": "The record object for the settlement.", "allOf": [{"$ref": "#/components/schemas/SettlementRecord"}]}}, "required": ["record"]}, "SettlementList": {"type": "object", "properties": {"settlements": {"type": "array", "items": {"$ref": "#/components/schemas/Settlement"}}}, "required": ["settlements"]}, "BeneficiaryAuthStatusUpdate": {"type": "object", "properties": {"beneficiary_auth_status_update_id": {"type": "string", "format": "uuid", "description": "Identifier of the beneficiary auth status update."}, "last_updated": {"type": "string", "format": "date-time", "description": "ISO formatted timestamp for beneficiary authorization last status update."}, "beneficiary_auth_id": {"type": "string", "format": "uuid", "description": "Identifier of the beneficiary authorization denoting permission to receive the asset."}, "status": {"type": "string", "description": "The most recently updated beneficiary auth status."}}, "required": ["beneficiary_auth_id", "beneficiary_auth_status_update_id", "last_updated", "status"], "description": "Beneficiary authorization status update object."}, "BeneficiaryAuthStatusUpdateList": {"type": "object", "properties": {"beneficiary_auth_status_updates": {"type": "array", "items": {"$ref": "#/components/schemas/BeneficiaryAuthStatusUpdate"}}}, "required": ["beneficiary_auth_status_updates"], "description": "List of beneficiary authorization status update objects."}, "OnetimeIdMap4": {"type": "object", "properties": {"one_time_id": {"type": "string", "description": "The one time ID."}, "real_id": {"type": "string", "description": "The real ID."}}, "required": ["one_time_id", "real_id"], "description": "ID mapping."}, "OnetimeIdMapList4": {"type": "object", "properties": {"id_maps": {"type": "array", "description": "The list of ID mappings.", "items": {"$ref": "#/components/schemas/OnetimeIdMap4"}}}, "description": "List of ID mappings."}, "Metadata4": {"type": "object", "properties": {"investor_ids": {"default": null, "nullable": true, "description": "The investor id mappings.", "allOf": [{"$ref": "#/components/schemas/OnetimeIdMapList4"}]}, "book_operator_id": {"type": "string", "format": "uuid", "default": null, "nullable": true, "description": "Identifier for the associated Book Operator node."}, "request_id": {"type": "string", "default": null, "nullable": true, "description": "Unique identifier for the request."}, "exchange_id": {"type": "string", "format": "uuid", "default": null, "nullable": true, "description": "Identifier for the associated Exchange node."}, "status": {"type": "string", "default": null, "nullable": true, "description": "State status for the record object."}, "trade_portal_id": {"type": "string", "format": "uuid", "default": null, "nullable": true, "description": "Identifier for the associated Trade Portal node."}, "commission": {"type": "number", "default": null, "nullable": true, "description": "Order commissison."}, "real_investor_id": {"type": "string", "default": null, "nullable": true, "description": "Original identifier for the investor."}, "expired": {"type": "boolean", "default": false, "nullable": true, "description": "Expiry status for the record object."}}}, "AbcSignature4": {"type": "object", "properties": {"digest_type": {"type": "string", "description": "The ABC digest type."}, "abc_account_id": {"type": "string", "description": "Identifier of the ABC account."}, "signature": {"type": "string", "description": "Signature of the digest."}, "digest": {"type": "string", "description": "The digest to be signed."}, "schema_version": {"type": "integer", "default": 1, "nullable": true, "description": "Version for the message schema."}}, "required": ["abc_account_id", "digest", "digest_type", "signature"]}, "BeneficiaryAuthRecord": {"type": "object", "properties": {"expiration": {"type": "string", "format": "date-time", "description": "ISO formatted timestamp for the authorization to last."}, "investor_id": {"type": "string", "description": "Identifier of the investor that is being authorized."}, "beneficiary_auth_id": {"type": "string", "format": "uuid", "description": "Identifier of the beneficiary authorization denoting permission to receive the asset."}, "asset_id": {"type": "string", "description": "Identifier of the asset being authorized."}}, "required": ["asset_id", "beneficiary_auth_id", "expiration", "investor_id"], "description": "Beneficiary authorization record object."}, "BeneficiaryAuth": {"type": "object", "properties": {"execution_status": {"type": "string", "default": null, "nullable": true, "description": "Execution status for the beneficiary authorization object."}, "metadata": {"description": "Metadata for the associated record object.", "allOf": [{"$ref": "#/components/schemas/Metadata4"}]}, "schema_version": {"type": "integer", "default": 1, "description": "Version for the message schema."}, "signature": {"default": null, "nullable": true, "description": "Signature for the associated record object.", "allOf": [{"$ref": "#/components/schemas/AbcSignature4"}]}, "record": {"description": "Beneficiary authorization record.", "allOf": [{"$ref": "#/components/schemas/BeneficiaryAuthRecord"}]}}, "required": ["record"], "description": "Beneficiary authorization schema."}, "BeneficiaryAuthList": {"type": "object", "properties": {"beneficiary_auths": {"type": "array", "items": {"$ref": "#/components/schemas/BeneficiaryAuth"}}}, "required": ["beneficiary_auths"]}, "EscrowAuthStatusUpdate": {"type": "object", "properties": {"escrow_auth_status_update_id": {"type": "string", "format": "uuid", "description": "Identifier of the escrow auth status update."}, "last_updated": {"type": "string", "format": "date-time", "description": "ISO formatted timestamp for escrow authorization last status update."}, "escrow_auth_id": {"type": "string", "format": "uuid", "description": "Identifier of the escrow authorization denoting permission to receive the asset."}, "status": {"type": "string", "description": "The most recently updated beneficiary auth status."}}, "required": ["escrow_auth_id", "escrow_auth_status_update_id", "last_updated", "status"], "description": "Escrow authorization status update object."}, "EscrowAuthStatusUpdateList": {"type": "object", "properties": {"escrow_auth_status_updates": {"type": "array", "items": {"$ref": "#/components/schemas/EscrowAuthStatusUpdate"}}}, "required": ["escrow_auth_status_updates"], "description": "List of escrow authorization status update objects."}, "OnetimeIdMap5": {"type": "object", "properties": {"one_time_id": {"type": "string", "description": "The one time ID."}, "real_id": {"type": "string", "description": "The real ID."}}, "required": ["one_time_id", "real_id"], "description": "ID mapping."}, "OnetimeIdMapList5": {"type": "object", "properties": {"id_maps": {"type": "array", "description": "The list of ID mappings.", "items": {"$ref": "#/components/schemas/OnetimeIdMap5"}}}, "description": "List of ID mappings."}, "Metadata5": {"type": "object", "properties": {"investor_ids": {"default": null, "nullable": true, "description": "The investor id mappings.", "allOf": [{"$ref": "#/components/schemas/OnetimeIdMapList5"}]}, "book_operator_id": {"type": "string", "format": "uuid", "default": null, "nullable": true, "description": "Identifier for the associated Book Operator node."}, "request_id": {"type": "string", "default": null, "nullable": true, "description": "Unique identifier for the request."}, "exchange_id": {"type": "string", "format": "uuid", "default": null, "nullable": true, "description": "Identifier for the associated Exchange node."}, "status": {"type": "string", "default": null, "nullable": true, "description": "State status for the record object."}, "trade_portal_id": {"type": "string", "format": "uuid", "default": null, "nullable": true, "description": "Identifier for the associated Trade Portal node."}, "commission": {"type": "number", "default": null, "nullable": true, "description": "Order commissison."}, "real_investor_id": {"type": "string", "default": null, "nullable": true, "description": "Original identifier for the investor."}, "expired": {"type": "boolean", "default": false, "nullable": true, "description": "Expiry status for the record object."}}}, "AbcSignature5": {"type": "object", "properties": {"digest_type": {"type": "string", "description": "The ABC digest type."}, "abc_account_id": {"type": "string", "description": "Identifier of the ABC account."}, "signature": {"type": "string", "description": "Signature of the digest."}, "digest": {"type": "string", "description": "The digest to be signed."}, "schema_version": {"type": "integer", "default": 1, "nullable": true, "description": "Version for the message schema."}}, "required": ["abc_account_id", "digest", "digest_type", "signature"]}, "SettlementConfirmationRecord": {"type": "object", "properties": {"settlement_id": {"type": "string", "format": "uuid", "description": "Identifier of the settlement this confirmation involved."}, "asset_quantity": {"type": "number", "description": "The quantity of the asset to be traded."}, "beneficiary_auth_id": {"type": "string", "format": "uuid", "description": "Identifier of the beneficiary authorization of the taken order."}, "take_order_id": {"type": "string", "format": "uuid", "description": "Identifier of the taken order."}, "give_order_id": {"type": "string", "format": "uuid", "description": "Identifier of the given order."}, "asset_id": {"type": "string", "description": "Identifier of the asset to be traded."}, "escrow_auth_id": {"type": "string", "format": "uuid", "description": "Identifier of the escrow authorization of the given order."}}, "required": ["asset_id", "asset_quantity", "beneficiary_auth_id", "escrow_auth_id", "give_order_id", "settlement_id", "take_order_id"]}, "SettlementConfirmation": {"type": "object", "properties": {"abc_memorial_digest": {"type": "string", "default": null, "nullable": true, "description": "The digest been memorialized in ABC."}, "metadata": {"description": "Metadata for the associated record object.", "allOf": [{"$ref": "#/components/schemas/Metadata5"}]}, "schema_version": {"type": "integer", "default": 1, "description": "Version for the message schema."}, "signature": {"default": null, "nullable": true, "description": "Signature for the associated record object.", "allOf": [{"$ref": "#/components/schemas/AbcSignature5"}]}, "abc_memorialization_block": {"type": "integer", "default": null, "nullable": true, "description": "The block height the memorialization localed."}, "record": {"description": "The record object for the settlement confirmation.", "allOf": [{"$ref": "#/components/schemas/SettlementConfirmationRecord"}]}}, "required": ["record"]}, "SettlementConfirmationList": {"type": "object", "properties": {"settlement_confirmations": {"type": "array", "items": {"$ref": "#/components/schemas/SettlementConfirmation"}}}, "required": ["settlement_confirmations"]}, "SettlementConfirmationStatusUpdate": {"type": "object", "properties": {"status": {"type": "string", "description": "The most recently updated settlement confirmation status."}, "settlement_confirmation_status_update_id": {"type": "string", "format": "uuid", "description": "Identifier of the settlement confirmation status update."}, "take_order_id": {"type": "string", "format": "uuid", "description": "Identifier of the order providing the credited side of the transfer"}, "give_order_id": {"type": "string", "format": "uuid", "description": "Identifier of the order providing the debited side of the transfer"}, "last_updated": {"type": "string", "format": "date-time", "description": "ISO formatted timestamp for settlement confirmation last status update."}}, "required": ["give_order_id", "last_updated", "settlement_confirmation_status_update_id", "status", "take_order_id"], "description": "Settlement confirmation status update object."}, "SettlementConfirmationStatusUpdateList": {"type": "object", "properties": {"settlement_confirmation_status_updates": {"type": "array", "items": {"$ref": "#/components/schemas/SettlementConfirmationStatusUpdate"}}}, "required": ["settlement_confirmation_status_updates"], "description": "List of settlement confirmation status update objects."}, "SettlementStatusUpdate": {"type": "object", "properties": {"settlement_id": {"type": "string", "format": "uuid", "description": "Identifier of the set

# --- truncated at 32 KB (71 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/polysign/refs/heads/main/openapi/polysign-atomicnet-api-server-openapi.json
AtomicNet API Server

Documentation

Specifications

Other Resources

OpenAPI Specification
