Skip to Content
APISecurity Service APICheck Multi-Sig Security

Check Multi-Signature Security

1. Overview & Typical Use

Returns an account’s multi-signature configuration, including owner permissions, active permissions, and the addresses granted each permission type.

  • Typical use: multi-sig account security audit, permission configuration check, malicious multi-sig detection.
  • When not to use: to check approval security use “Check Account Approval Security”; for basic account information use “Get Account Details”.

2. Endpoint & Authentication

GET /api/security/sign/data

For Base URL and authentication, see Common Network & Authentication.

3. Request

ParameterTypeRequiredDefaultDescription
addressstringYesAccount address to check

4. Response

Top-level

FieldTypeRequiredDescriptionUnit/Precision
multiSignbooleanRequiredWhether multi-signature is enabled
multiSignOwnerPermissionAddressarrayRequiredAddresses granted owner permission
multiSignActivePermissionAddressarrayRequiredAddresses granted active permission
multiSignWitnessPermissionAddressarrayRequiredAddresses granted witness permission
activePermissionsarrayRequiredActive permission details; empty array when multi-sig is not enabled
ownerPermissionobjectOptionalOwner permission details; only present when multiSign: true

ownerPermission object

FieldTypeRequiredDescriptionUnit/Precision
permission_namestringRequiredPermission name
thresholdintegerRequiredSignature threshold
keysarrayRequiredAddress + weight list

activePermissions[] elements

FieldTypeRequiredDescriptionUnit/Precision
idintegerRequiredPermission ID
typestringRequiredPermission type
permission_namestringRequiredPermission name
thresholdintegerRequiredSignature threshold
operationsstringRequiredAllowed operations bitmapHexadecimal
keysarrayRequiredAddress + weight list

5. Errors

For HTTP status codes, see Common Errors. Key points for this endpoint:

  • When address does not have multi-sig enabled, multiSign returns false and all other fields are empty arrays.
Last updated on: