{"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 settlement."}, "last_updated": {"type": "string", "format": "date-time", "description": "ISO formatted timestamp for settlement last status update."}, "settlement_status_update_id": {"type": "string", "format": "uuid", "description": "Identifier of the settlement status update."}, "status": {"type": "string", "description": "The most recently updated settlement status."}}, "required": ["last_updated", "settlement_id", "settlement_status_update_id", "status"], "description": "Settlement status update object."}, "SettlementStatusUpdateList": {"type": "object", "properties": {"settlement_status_updates": {"type": "array", "items": {"$ref": "#/components/schemas/SettlementStatusUpdate"}}}, "required": ["settlement_status_updates"], "description": "List of settlement status update objects."}, "Investor": {"type": "object", "properties": {"real_investor_id": {"type": "string", "description": "The real identifier of the investor."}, "one_time_investor_ids": {"type": "array", "description": "The list of one time identifier of the investor.", "items": {"type": "string"}}, "schema_version": {"type": "integer", "default": 1, "description": "Version for the message schema."}}, "required": ["one_time_investor_ids", "real_investor_id"], "description": "Investor object."}, "OnetimeIdMap6": {"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."}, "Partner": {"type": "object", "properties": {"role": {"type": "string", "default": null, "nullable": true, "description": "Partner ABC account role."}, "private_key": {"type": "string", "default": null, "nullable": true, "description": "Partner ABC account private key."}, "public_key": {"type": "string", "default": null, "nullable": true, "description": "Partner ABC account piblic key."}, "status": {"type": "string", "default": null, "nullable": true, "description": "Partner status."}, "abc_account_id": {"type": "string", "default": null, "nullable": true, "description": "Partner ABC account ID."}, "atomicnet_id": {"type": "string", "format": "uuid", "description": "Identifier of the partner."}, "partner_name": {"type": "string", "default": null, "nullable": true, "description": "Partner name."}, "schema_version": {"type": "integer", "default": 1, "description": "Version for the message schema."}}, "required": ["atomicnet_id"], "description": "Partner object."}, "PartnerList": {"type": "object", "properties": {"partners": {"type": "array", "description": "The list of partners.", "items": {"$ref": "#/components/schemas/Partner"}}}, "required": ["partners"], "description": "List of partner registration object."}, "OnetimeIdMap7": {"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."}, "OnetimeIdMapList6": {"type": "object", "properties": {"id_maps": {"type": "array", "description": "The list of ID mappings.", "items": {"$ref": "#/components/schemas/OnetimeIdMap7"}}}, "description": "List of ID mappings."}, "Metadata6": {"type": "object", "properties": {"investor_ids": {"default": null, "nullable": true, "description": "The investor id mappings.", "allOf": [{"$ref": "#/components/schemas/OnetimeIdMapList6"}]}, "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."}}}, "AbcSignature6": {"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"]}, "BookTransferRecord": {"type": "object", "properties": {"book_transfer_id": {"type": "string", "format": "uuid", "default": null, "nullable": true, "description": "Identifier of the book_transfer."}, "quantity": {"type": "number", "description": "Quantity of the asset to transfer."}, "take_investor_id": {"type": "string", "description": "Identifier of the investor taking the asset."}, "asset_id": {"type": "string", "description": "Identifier of the asset to transfer."}, "give_investor_id": {"type": "string", "description": "Identifier of the investor giving the asset."}}, "required": ["asset_id", "give_investor_id", "quantity", "take_investor_id"]}, "BookTransfer": {"type": "object", "properties": {"execution_status": {"type": "string", "default": null, "nullable": true, "description": "Execution status for the book_transfer object."}, "metadata": {"description": "Metadata for the associated record object.", "allOf": [{"$ref": "#/components/schemas/Metadata6"}]}, "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/AbcSignature6"}]}, "record": {"description": "BookTransfer record.", "allOf": [{"$ref": "#/components/schemas/BookTransferRecord"}]}, "escrow_auth_id": {"type": "string", "format": "uuid", "default": null, "nullable": true, "description": "Identifier of the pre-approved escrow authorization."}}, "required": ["record"]}, "BookTransferList": {"type": "object", "properties": {"book_transfers": {"type": "array", "items": {"$ref": "#/components/schemas/BookTransfer"}}}, "required": ["book_transfers"], "description": "List of complete book_transfers object."}, "OnetimeIdMap8": {"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."}, "OnetimeIdMapList7": {"type": "object", "properties": {"id_maps": {"type": "array", "description": "The list of ID mappings.", "items": {"$ref": "#/components/schemas/OnetimeIdMap8"}}}, "description": "List of ID mappings."}, "Metadata7": {"type": "object", "properties": {"investor_ids": {"default": null, "nullable": true, "description": "The investor id mappings.", "allOf": [{"$ref": "#/components/schemas/OnetimeIdMapList7"}]}, "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."}}}, "AbcSignature7": {"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"]}, "BookTransferConfirmationRecord": {"type": "object", "properties": {"book_transfer_id": {"type": "string", "format": "uuid", "description": "Identifier of the book_transfer 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."}, "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", "book_transfer_id", "escrow_auth_id"]}, "BookTransferConfirmation": {"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/Metadata7"}]}, "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/AbcSignature7"}]}, "abc_memorialization_block": {"type": "integer", "default": null, "nullable": true, "description": "The block height the memorialization localed."}, "record": {"description": "The record object for the book_transfer confirmation.", "allOf": [{"$ref": "#/components/schemas/BookTransferConfirmationRecord"}]}}, "required": ["record"]}, "BookTransferConfirmationList": {"type": "object", "properties": {"book_transfer_confirmations": {"type": "array", "items": {"$ref": "#/components/schemas/BookTransferConfirmation"}}}, "required": ["book_transfer_confirmations"]}, "DataSyncOptions": {"type": "object", "properties": {"priority": {"type": "integer", "default": null, "nullable": true, "description": "The priority for the node to provide synchronization service."}, "formats": {"type": "array", "default": null, "nullable": true, "description": "The list of formats for data synchronization.", "items": {"type": "string"}}, "time_range_end": {"type": "string", "format": "date-time", "default": null, "nullable": true, "description": "The end time for data synchronization in ISO format."}, "time_range_start": {"type": "string", "format": "date-time", "default": null, "nullable": true, "description": "The start time for data synchronization in ISO format."}, "schema_version": {"type": "integer", "default": 1, "description": "Version for the message schema."}}}, "DataSyncViewRequest": {"type": "object", "properties": {"target_types": {"type": "array", "description": "The list of types to sync.", "items": {"type": "string"}}, "schema_version": {"type": "integer", "default": 1, "description": "Version for the message schema."}, "options": {"description": "The options corresponding to this request.", "allOf": [{"$ref": "#/components/schemas/DataSyncOptions"}]}}, "required": ["options", "target_types"]}, "DataSyncViewResponse": {"type": "object", "properties": {"request_id": {"type": "string", "format": "uuid", "description": "The identifier for this request."}, "schema_version": {"type": "integer", "default": 1, "description": "Version for the message schema."}}, "required": ["request_id"]}, "DataSyncEntityStatus": {"type": "object", "properties": {"entity": {"type": "string", "description": "Sync target."}, "status": {"type": "string", "description": "Sync status for this entity."}, "source_node": {"type": "string", "format": "uuid", "description": "The UUID of the data source node."}}, "required": ["entity", "source_node", "status"]}, "DataSyncRequestStatus": {"type": "object", "properties": {"request_id": {"type": "string", "format": "uuid", "description": "The identifier for this request."}, "status": {"type": "string", "description": "Overall sync status for this request."}, "destination_node": {"type": "string", "format": "uuid", "description": "The node's UUID who asks the sync."}, "target_types": {"type": "array", "description": "The list of types reqeusted for sync.", "items": {"type": "string"}}, "options": {"description": "The options corresponding to this request.", "allOf": [{"$ref": "#/components/schemas/DataSyncOptions"}]}}, "required": ["destination_node", "options", "request_id", "status", "target_types"]}, "DataSyncStatus": {"type": "object", "properties": {"entities": {"type": "array", "items": {"$ref": "#/components/schemas/DataSyncEntityStatus"}}, "sync_request": {"description": "The sync request.", "allOf": [{"$ref": "#/components/schemas/DataSyncRequestStatus"}]}, "schema_version": {"type": "integer", "default": 1, "description": "Version for the message schema."}}, "required": ["entities", "sync_request"]}, "DataSyncStatusList": {"type": "object", "properties": {"requests": {"type": "array", "items": {"$ref": "#/components/schemas/DataSyncRequestStatus"}}}, "required": ["requests"], "description": "List of data sync."}}}, "security": [{"OAuth2": ["participant"]}], "paths": {"/v1/auth/token": {"post": {"tags": ["authentication"], "summary": "Get access token.", "parameters": [{"in": "header", "name": "authorization", "description": "Base64 encode the client ID and secret.", "schema": {"type": "string"}, "required": true, "example": "Basic <Base64 encoded 'client_id:secret'>"}, {"in": "header", "name": "accept", "description": "Response format.", "schema": {"type": "string"}, "example": "application/json"}, {"in": "header", "name": "cache-control", "description": "Cache or not.", "schema": {"type": "string"}, "example": "no-cache"}], "requestBody": {"content": {"application/x-www-form-urlencoded": {"schema": {"type": "object", "required": ["grant_type", "scope"], "properties": {"grant_type": {"description": "Grant type", "type": "string", "example": "client_credentials"}, "scope": {"description": "At least one custom scope", "type": "string", "example": "participant"}}, "example": "grant_type=client_credentials&scope=participant"}}}}, "responses": {"200": {"description": "The access token.", "content": {"application/json": {"schema": {"type": "object", "required": ["access_token", "token_type", "expires_in", "scope"], "properties": {"access_token": {"type": "string"}, "token_type": {"type": "string"}, "expires_in": {"type": "integer"}, "scope": {"type": "string"}, "refresh_token": {"type": "string"}, "id_token": {"type": "string"}}}}}}, "401": {"description": "HTTP 401 Unauthorized.", "content": {"application/json;charset=UTF-8": {"schema": {"type": "object", "required": ["error", "error_description"], "properties": {"error": {"type": "string"}, "error_description": {"type": "string"}}}}}}}}}, "/v1/assets/{asset_id}": {"get": {"summary": "Get the detail of the registered asset on AtomicNet by its id.", "tags": ["asset"], "parameters": [{"name": "asset_id", "in": "path", "description": "The identifier of the asset.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "The registered asset.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Asset"}}}}}}}, "/v1/assets/list": {"get": {"summary": "Get the detail of all registered assets on AtomicNet.", "tags": ["asset"], "responses": {"200": {"description": "A list of registered assets.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/AssetList"}}}}}}, "put": {"summary": "Register a list of new assets and publish to the AtomicNet.", "tags": ["asset"], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/AssetList"}}}}, "responses": {"200": {"description": "Empty"}}}}, "/v1/assets/": {"put": {"summary": "Register a new asset and publish to the AtomicNet.", "tags": ["asset"], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Asset"}}}}, "responses": {"200": {"description": "Empty"}}}}, "/v1/assets/update_asset_mapping": {"put": {"summary": "Update the partner asset id mapping on this node for a single asset.", "tags": ["asset"], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/AssetMapping"}}}}, "responses": {"200": {"description": "Empty"}}}}, "/v1/escrow_authorizations/{escrow_auth_id}": {"get": {"summary": "Get the detail of a escrow authorization on AtomicNet by its id.", "tags": ["escrow authorization"], "parameters": [{"name": "escrow_auth_id", "in": "path", "description": "The identifier of the escrow authorization.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "The escrow authorization.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/EscrowAuth"}}}}}}}, "/v1/escrow_authorizations/list": {"get": {"summary": "Get the detail of all escrow authorizations on AtomicNet.", "tags": ["escrow authorization"], "parameters": [{"name": "status", "in": "query", "description": "The specified status to be filtered on.", "example": "pending", "schema": {"type": "string"}}], "responses": {"200": {"description": "A list of escrow authorizations.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/EscrowAuthList"}}}}}}}, "/v1/escrow_authorizations/list/local": {"get": {"summary": "Get the detail of all escrow authorizations involved by this node.", "tags": ["escrow authorization"], "parameters": [{"name": "status", "in": "query", "description": "The specified status to be filtered on.", "example": "pending", "schema": {"type": "string"}}], "responses": {"200": {"description": "A list of escrow authorizations.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/EscrowAuthList"}}}}}}}, "/v1/escrow_authorizations/request": {"post": {"summary": "Request a new escrow authorization.", "tags": ["escrow authorization"], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/EscrowAuth"}}}}, "responses": {"200": {"description": "The escrow authorization.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/EscrowAuth"}}}}}}}, "/v1/escrow_authorizations/": {"put": {"summary": "Approve an escrow authorization.", "tags": ["escrow authorization"], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/EscrowAuth"}}}}, "responses": {"200": {"description": "The escrow authorization.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/EscrowAuth"}}}}}}}, "/v1/orders/{order_id}": {"get": {"summary": "Get the detail of an order on AtomicNet by its id.", "tags": ["order"], "parameters": [{"name": "order_id", "in": "path", "description": "The identifier of the order.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "The order.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Order"}}}}}}}, "/v1/orders/list": {"get": {"summary": "Get the detail of all order on AtomicNet.", "tags": ["order"], "parameters": [{"name": "status", "in": "query", "description": "The specified status to be filtered on.", "example": "pending", "schema": {"type": "string"}}, {"name": "role", "in": "query", "description": "The specified role to be filtered on.\nAtomicNet node will determine if an order is local by the role it is\nplaying.\n", "example": "exchange", "schema": {"type": "string"}}], "responses": {"200": {"description": "A list of orders.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/OrderList"}}}}}}}, "/v1/orders/": {"put": {"summary": "Publish a new order to AtomicNet.\nThe authorizations will be acquired if not provided before publishing.\n", "tags": ["order"], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Order"}}}}, "responses": {"200": {"description": "The order.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Order"}}}}}}}, "/v1/system/circuit_breakers": {"get": {"summary": "Get the status of all circuit breakers on the server.", "tags": ["system"], "responses": {"200": {"description": "Map of breakers to their statuses", "content": {"application/json": {"schema": {"type": "object"}}}}}}}, "/v1/system/ping": {"get": {"summary": "Basic health check.", "tags": ["system"], "responses": {"200": {"description": "System status", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Ping"}}}}}}}, "/v1/system/version": {"get": {"summary": "Get the version of the server.", "tags": ["system"], "responses": {"200": {"description": "Version", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Version"}}}}}}}, "/v1/system/deep_ping": {"get": {"summary": "Deep health check.", "tags": ["system"], "responses": {"200": {"description": "Deep system status.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/DeepPing"}}}}}}}, "/v1/utils/atomicnet_uid": {"get": {"summary": "Get an AtomicNet UID.", "tags": ["utility"], "responses": {"200": {"description": "AtomicNet UID.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/AtomicNetUID"}}}}}}}, "/v1/utils/canonicalize": {"get": {"summary": "Canonicalize a AtomicNet object record.", "tags": ["utility"], "requestBody": {"description": "Requests must describe the relevant schema in the message type field.\nSupported schemas:\n  OrderRecord\n  BeneficiaryAuthRecord\n  EscrowAuthRecord\n  SettlementConfirmationRecord\n  SettlementRecord\n  AssetRecord\n  BookTransferRecord\n  BookTransferConfirmationRecord\n", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CanonicalizeReq"}}}}, "responses": {"200": {"description": "The serialized data in json-formatted string, and it's digest.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CanonicalizeResp"}}}}}}}, "/v1/order_status_updates/{order_id}": {"get": {"summary": "Get all status updates associated with an order by its id.", "tags": ["order"], "parameters": [{"name": "order_id", "in": "path", "description": "The identifier of the order.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "A list of order status updates.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/OrderStatusUpdateList"}}}}}}}, "/v1/settlements/": {"put": {"summary": "Publish a settlement to AtomicNet after being memorialized on ABC.", "tags": ["settlement"], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Settlement"}}}}, "responses": {"200": {"description": "The settlement.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Settlement"}}}}}}}, "/v1/settlements/{settlement_id}": {"get": {"summary": "Get the detail of a settlement on AtomicNet by its id.", "tags": ["settlement"], "parameters": [{"name": "settlement_id", "in": "path", "description": "The identifier of the settlement.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "The settlement.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Settlement"}}}}}}}, "/v1/settlements/list": {"get": {"summary": "Get The detail of all settlements on AtomicNet.", "tags": ["settlement"], "parameters": [{"name": "status", "in": "query", "description": "The specified status to be filtered on.", "example": "pending", "schema": {"type": "string"}}], "responses": {"200": {"description": "A list of settlements.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/SettlementList"}}}}}}}, "/v1/settlements/order/{order_id}": {"get": {"summary": "Get The detail of all settlements for an order on AtomicNet.", "tags": ["settlement"], "parameters": [{"name": "order_id", "in": "path", "description": "The identifier of the order.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "A list of settlements.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/SettlementList"}}}}}}}, "/v1/beneficiary_status_updates/{beneficiary_auth_id}": {"get": {"summary": "Get all status updates associated with a beneficiary authorization by its id.\n", "tags": ["beneficiary authorization"], "parameters": [{"name": "beneficiary_auth_id", "in": "path", "description": "The identifier of the beneficiary authorization.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "A list of beneficiary authorization status updates.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BeneficiaryAuthStatusUpdateList"}}}}}}}, "/v1/beneficiary_authorizations/{beneficiary_auth_id}": {"get": {"summary": "Get the details of a beneficiary authorization on AtomicNet by its id.", "tags": ["beneficiary authorization"], "parameters": [{"name": "beneficiary_auth_id", "in": "path", "description": "The identifier of the beneficiary authorization.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "The beneficiary authorization.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BeneficiaryAuth"}}}}}}}, "/v1/beneficiary_authorizations/list": {"get": {"summary": "Get the detail of all beneficiary authorizations on AtomicNet.", "tags": ["beneficiary authorization"], "parameters": [{"name": "status", "in": "query", "description": "The specified status to be filtered on.", "example": "pending", "schema": {"type": "string"}}], "responses": {"200": {"description": "A list of beneficiary authorizations.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BeneficiaryAuthList"}}}}}}}, "/v1/beneficiary_authorizations/list/local": {"get": {"summary": "Get the detail of all beneficiary authorizations involved by this node.", "tags": ["beneficiary authorization"], "parameters": [{"name": "status", "in": "query", "description": "The specified status to be filtered on.", "example": "pending", "schema": {"type": "string"}}], "responses": {"200": {"description": "A list of beneficiary authorizations.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BeneficiaryAuthList"}}}}}}}, "/v1/beneficiary_authorizations/request": {"post": {"summary": "Request a new beneficiary authorization.", "tags": ["beneficiary authorization"], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/BeneficiaryAuth"}}}}, "responses": {"200": {"description": "The beneficiary authorization.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BeneficiaryAuth"}}}}}}}, "/v1/beneficiary_authorizations/": {"put": {"summary": "Approve a beneficiary authorization.", "tags": ["beneficiary authorization"], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/BeneficiaryAuth"}}}}, "responses": {"200": {"description": "The beneficiary authorization.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BeneficiaryAuth"}}}}}}}, "/v1/escrow_status_updates/{escrow_auth_id}": {"get": {"summary": "Get all status updates associated with an escrow authorization by its id.", "tags": ["escrow authorization"], "parameters": [{"name": "escrow_auth_id", "in": "path", "description": "The identifier of the escrow authorization.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "A list of escrow authorization status updates.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/EscrowAuthStatusUpdateList"}}}}}}}, "/v1/settlement_confirmations/{settlement_id}": {"get": {"summary": "Get all settlement confirmations for a settlement_id in AtomicNet.", "tags": ["settlement confirmation"], "parameters": [{"name": "settlement_id", "in": "path", "description": "The identifier of the settlement.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "The settlement confirmations.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/SettlementConfirmationList"}}}}}}}, "/v1/settlement_confirmations/{give_order_id}/{take_order_id}": {"get": {"summary": "Get the detail of a settlement confirmation on AtomicNet.", "tags": ["settlement confirmation"], "parameters": [{"name": "give_order_id", "in": "path", "description": "The identifier of the give order.", "required": true, "schema": {"type": "string"}}, {"name": "take_order_id", "in": "path", "description": "The identifier of the take order.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "The settlement confirmation.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/SettlementConfirmation"}}}}}}}, "/v1/settlement_confirmations/list": {"get": {"summary": "Get the detail of all settlement confirmations on AtomicNet.", "tags": ["settlement confirmation"], "parameters": [{"name": "status", "in": "query", "description": "The specified status to be filtered on.", "example": "pending", "schema": {"type": "string"}}], "responses": {"200": {"description": "A list of settlement confirmations.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/SettlementConfirmationList"}}}}}}}, "/v1/settlement_confirmations/list/local": {"get": {"summary": "Get the detail of all settlement confirmations involved by this node on\nAtomicNet.\n", "tags": ["settlement confirmation"], "parameters": [{"name": "status", "in": "query", "description": "The specified status to be filtered on.", "example": "pending", "schema": {"type": "string"}}], "responses": {"200": {"description": "A list of settlement confirmations.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/SettlementConfirmationList"}}}}}}}, "/v1/settlement_confirmations/": {"put": {"summary": "Release a settlement confirmation on execution after being memorialized on ABC.\n", "tags": ["settlement confirmation"], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/SettlementConfirmation"}}}}, "responses": {"200": {"description": "The settlement confirmation.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/SettlementConfirmation"}}}}}}}, "/v1/settlement_confirmation_status_updates/{give_order_id}/{take_order_id}": {"get": {"summary": "Get all status updates associated with a settlement confirmation by its id.\n", "tags": ["settlement confirmation"], "parameters": [{"name": "give_order_id", "in": "path", "description": "The identifier of the give order.", "required": true, "schema": {"type": "string"}}, {"name": "take_order_id", "in": "path", "description": "The identifier of the take order.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "A list of settlement confirmation status updates.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/SettlementConfirmationStatusUpdateList"}}}}}}}, "/v1/settlement_status_updates/{settlement_id}": {"get": {"summary": "Get all status updates associated with a settlement by its id.", "tags": ["settlement"], "parameters": [{"name": "settlement_id", "in": "path", "description": "The identifier of the settlement.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "A list of settlement status updates.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/SettlementStatusUpdateList"}}}}}}}, "/v1/investors/real_investor_id/{real_investor_id}": {"get": {"summary": "Generate a one time investor ID for the real investor ID.", "tags": ["investor"], "parameters": [{"name": "real_investor_id", "in": "path", "description": "The real investor ID of the investor.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "The mapping of the investor ID.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/OnetimeIdMap6"}}}}}}}, "/v1/investors/one_time_investor_id/{one_time_investor_id}": {"get": {"summary": "Get the detail of an investor involved by this node by its one time investor id.\n", "tags": ["investor"], "parameters": [{"name": "one_time_investor_id", "in": "path", "description": "The one time identifier of the investor.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "The investor.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Investor"}}}}}}}, "/v1/partners/{atomicnet_id}": {"get": {"summary": "Get the detail of a partner registered on this node by its id.", "tags": ["partner"], "parameters": [{"name": "atomicnet_id", "in": "path", "description": "The identifier of the partner.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "The partner.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Partner"}}}}}}}, "/v1/partners/list": {"get": {"summary": "Get the detail of all partners registered on this node.", "tags": ["partner"], "responses": {"200": {"description": "The partners.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/PartnerList"}}}}}}, "put": {"summary": "Register a list of new partners to this node.", "tags": ["partner"], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/PartnerList"}}}}, "responses": {"200": {"description": "Empty"}}}}, "/v1/partners/": {"put": {"summary": "Register a new partner to this node.", "tags": ["partner"], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Partner"}}}}, "responses": {"200": {"description": "Empty"}}}}, "/v1/partners/update": {}, "/v1/book_transfers/": {"put": {"summary": "Publish a new book transfer to AtomicNet.\nThe authorizations will be acquired if not provided before publishing.\n", "tags": ["book transfer"], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/BookTransfer"}}}}, "responses": {"200": {"description": "The book transfer.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BookTransfer"}}}}}}}, "/v1/book_transfers/{book_transfer_id}": {"get": {"summary": "Get the detail of a book transfer on AtomicNet by its id.", "tags": ["book transfer"], "parameters": [{"name": "book_transfer_id", "in": "path", "description": "The identifier of the book transfer.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "The book transfer.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BookTransfer"}}}}}}}, "/v1/book_transfers/list": {"get": {"summary": "Get the detail of all book transfers on AtomicNet.", "tags": ["book transfer"], "parameters": [{"name": "status", "in": "query", "description": "The specified status to be filtered on.", "example": "pending", "schema": {"type": "string"}}, {"name": "role", "in": "query", "description": "The specified role to be filtered on.\nAtomicNet node will determine if a book transfer is local by the role it is\nplaying.\n", "example": "trade_portal", "schema": {"type": "string"}}], "responses": {"200": {"description": "A list of book transfers.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BookTransferList"}}}}}}}, "/v1/book_transfers/list/local": {"get": {"summary": "Get the detail of all book transfers involved by this node on\nAtomicNet.\n", "tags": ["book transfer"], "parameters": [{"name": "status", "in": "query", "description": "The specified status to be filtered on.", "example": "pending", "schema": {"type": "string"}}], "responses": {"200": {"description": "A list of book transfers.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BookTransferList"}}}}}}}, "/v1/book_transfer_confirmations/{book_transfer_id}": {"get": {"summary": "Get the detail of a book transfer confirmation on AtomicNet.", "tags": ["book transfer confirmation"], "parameters": [{"name": "book_transfer_id", "in": "path", "description": "The identifier of the book transfer.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "The book transfer confirmation.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BookTransferConfirmation"}}}}}}}, "/v1/book_transfer_confirmations/list": {"get": {"summary": "Get the detail of all book transfer confirmations on AtomicNet.", "tags": ["book transfer confirmation"], "parameters": [{"name": "status", "in": "query", "description": "The specified status to be filtered on.", "example": "pending", "schema": {"type": "string"}}], "responses": {"200": {"description": "A list of book transfer confirmations.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BookTransferConfirmationList"}}}}}}}, "/v1/book_transfer_confirmations/list/local": {"get": {"summary": "Get the detail of all book transfer confirmations involved by this node on\nAtomicNet.\n", "tags": ["book transfer confirmation"], "parameters": [{"name": "status", "in": "query", "description": "The specified status to be filtered on.", "example": "pending", "schema": {"type": "string"}}], "responses": {"200": {"description": "A list of book transfer confirmations.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BookTransferConfirmationList"}}}}}}}, "/v1/book_transfer_confirmations/": {"put": {"summary": "Release a book transfer confirmation on execution after\nbeing memorialized on ABC.\n", "tags": ["book transfer confirmation"], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/BookTransferConfirmation"}}}}, "responses": {"200": {"description": "The book transfer confirmation.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BookTransferConfirmation"}}}}}}}, "/v1/data_sync/": {"put": {"summary": "Trigger the data synchronization.", "tags": ["utility"], "requestBody": {"description": "The response body.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/DataSyncViewRequest"}}}}, "responses": {"200": {"description": "The response body.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/DataSyncViewResponse"}}}}}}}, "/v1/data_sync/{request_id}": {"get": {"summary": "Get the status details of sync request by its id.", "tags": ["utility"], "parameters": [{"name": "request_id", "in": "path", "description": "The identifier of the data sync request.", "required": true, "schema": {"type": "string"}}], "responses": {"200": {"description": "The requests details.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/DataSyncStatus"}}}}}}}, "/v1/data_sync/list": {"get": {"summary": "Get the list of data sync requests.", "tags": ["utility"], "parameters": [{"name": "status", "in": "query", "description": "The specified status to be filtered on.", "example": "open", "schema": {"type": "string"}}], "responses": {"200": {"description": "A list of sync request status objects.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/DataSyncStatusList"}}}}}}}}, "openapi": "3.0.3"}