BLblockaid-official
cosigner

Get Cosigner External Route

Changed on

Fetch a cosigner by ID.

get/v0/platform/cosigners/{id}

Request

Path parameters

idstring required

Response

Successful Response

tagsstring[] required
idstring required

The Cosigner's assigned unique ID.

namestring nullable required

The Cosigner name as defined upon creation.

status'pending' | 'ok' | 'error' required

The current status of the Cosigner.

  • ok - The Cosigner is active.
  • pending - The Cosigner is waiting for the final activation steps in the multisig wallet to be completed.
  • error - Something went wrong and the Cosigner is not working properly.
fallback_behavior'reject' | 'approve' | 'manual_review' required

The outcome when a transaction passes the Blockaid detection engine but no configured policy matches.

  • reject - Rejects the transaction. Default.
  • approve - Approves the transaction.
  • manual_review - Sends the transaction to the Pending Transactions queue for manual review.
errorstring nullable

If the Cosigner status is error, this field will show more information about the error.

created_atstring date-time required

The timestamp the Cosigner was created.

updated_atstring date-time required
updated_bystring nullable required

The user who last updated the Cosigner.

created_bystring required
selected_chainsstring[] nullable

Changes

  • 6941029c0ca9Revision changes
    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the // response's property type changed from string to no type for status

    • breaking

      the // response's property type changed from string to no type for status

    • breaking

      the // response's property type changed from string to no type for status

    • breaking

      the // response's property type changed from string to no type for status

    • breaking

      the // response's property type changed from string to no type for status

    • info

      added subschema #2 to the // response property anyOf list for the response status

    • info

      added subschema #2 to the // response property anyOf list for the response status

    • info

      added subschema #2 to the // response property anyOf list for the response status

    • info

      added subschema #2 to the // response property anyOf list for the response status

    • info

      added subschema #2 to the // response property anyOf list for the response status

    • info

      response property data/oneOf[subschema #1: FireblocksCosignerResponseExternal]/security_policy deprecated

    • info

      response property data/oneOf[subschema #2: FordefiCosignerResponseExternal]/security_policy deprecated

    • info

      response property data/oneOf[subschema #3: CosignerSafeResponseExternal]/security_policy deprecated

    • info

      response property data/oneOf[subschema #4: CosignerSquadsResponseExternal]/security_policy deprecated

    • info

      response property data/oneOf[subschema #5: UtilaCosignerResponseExternal]/security_policy deprecated

    • info

      removed the advanced_control_policy enum value from the // response property for the response status

    • info

      removed the advanced_control_policy enum value from the // response property for the response status

    • info

      removed the advanced_control_policy enum value from the // response property for the response status

    • info

      removed the advanced_control_policy enum value from the // response property for the response status

    • info

      removed the advanced_control_policy enum value from the // response property for the response status

    • info

      removed the blockaid_ootb_policy enum value from the // response property for the response status

    • info

      removed the blockaid_ootb_policy enum value from the // response property for the response status

    • info

      removed the blockaid_ootb_policy enum value from the // response property for the response status

    • info

      removed the blockaid_ootb_policy enum value from the // response property for the response status

    • info

      removed the blockaid_ootb_policy enum value from the // response property for the response status

    • info

      added the required property to the response with the status

  • 187d6a5259c6Revision changes
    • info

      the endpoint scheme security JWT was added to the API