Cosigners

Add cosigner

Add a new cosigner. The cosigner will be pending pairing until the API user is manually paired (see pairCosignerApiUser). Endpoint Permission: Admin and Non-Signing Admin.

post/cosigners

Request

Headers

Idempotency-Keystring

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.

Request body

apiUserIdstring uuid required

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

namestring required

The name of the cosigner

existingCosignerboolean

Whether the cosigner already exists in another workspace

Example request

{
  "apiUserId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "My Cosigner 1"
}

Response

Pending cosigner added

apiUserIdstring uuid required

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

namestring required

The name of the cosigner

existingCosignerboolean

Whether the cosigner already exists in another workspace

pendingCosignerIdstring uuid required

The unique identifier of a pending cosigner

Example response

{
  "apiUserId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "My Cosigner 1",
  "pendingCosignerId": "44fcead0-7053-4831-a53a-df7fb90d440f"
}

Changes

No recorded changes to this operation across all 1 revision of this API.