Create Protocol Rcp Assignment

POST /protocols/{agreement_ref}/rcp/assignments

Creates the reciprocal confirmation requirements for the identified agreement protocol.

Conventions

Authentication

All endpoints require a Bearer token. Pass it in the Authorization header as Bearer <token>. Tokens are issued from the API settings page in your workspace.

Base URL

All paths are relative to https://api.allsign.app. The spec includes full paths; strip the base when constructing requests.

Versioning

The current version is 0.1.0. Breaking changes are documented in the Changelog and announced before taking effect.

Specification

The API follows OpenAPI Specification 3.x. All documentation on this page is generated directly from the spec.

Example

Bash

curl "https://api.allsign.app/protocols/{agreement_ref}/rcp/assignments" \
  -X POST \
  -H "Authorization: Bearer {token}"

Request

Request Path

agreement_ref

Public agreement reference.

stringrequired

Responses

200 OK

Updated reciprocal confirmation context.

{
  "data": {
    "rcp": {
      "completed_count": 1,
      "incoming_requirement": {},
      "outgoing_assignment": {},
      "ready": true,
      "total_count": 1
    }
  }
}

data

objectrequired

data.rcp

Remote confirmation party context for an agreement.

objectrequired

data.rcp.completed_count

integerrequired

data.rcp.incoming_requirement

objectrequired

data.rcp.outgoing_assignment

objectrequired

data.rcp.ready

booleanrequired

data.rcp.total_count

integerrequired

401 Unauthorized

{
  "error": {
    "code": "",
    "message": "",
    "request_id": "",
    "status": 1
  }
}

error

objectrequired

error.code

stringrequired

error.message

stringrequired

error.request_id

stringrequired

error.status

integerrequired

error.fields

object[]optional

404 Not Found

{
  "error": {
    "code": "",
    "message": "",
    "request_id": "",
    "status": 1
  }
}

error

objectrequired

error.code

stringrequired

error.message

stringrequired

error.request_id

stringrequired

error.status

integerrequired

error.fields

object[]optional