Skip to main content
POST
/
cosigners
TypeScript
const response: Promise<FireblocksResponse<AddCosignerResponse>> = fireblocks.cosignersBeta.addCosigner(cosignersBetaApiAddCosignerRequest);
{
  "apiKeyId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "My Cosigner 1",
  "pendingCosignerId": "44fcead0-7053-4831-a53a-df7fb90d440f",
  "existingCosigner": false
}

Headers

​
Idempotency-Key
string

A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.

Body

application/json
​
apiKeyId
string<uuid>
required

The id of the API key to be paired with the cosigner

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
name
string
required

The name of the cosigner

Minimum string length: 1
Example:

"My Cosigner 1"

​
existingCosigner
boolean
default:false

Whether the cosigner already exists in another workspace

Example:

false

Response

Pending cosigner added

​
apiKeyId
string<uuid>
required

The id of the API key to be paired with the cosigner

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
name
string
required

The name of the cosigner

Minimum string length: 1
Example:

"My Cosigner 1"

​
pendingCosignerId
string<uuid>
required

The unique identifier of a pending cosigner

Example:

"44fcead0-7053-4831-a53a-df7fb90d440f"

​
existingCosigner
boolean
default:false

Whether the cosigner already exists in another workspace

Example:

false