Create Protocol Authentication

POST /protocols/{agreement_ref}/authentications

Creates the current signing authentication transition 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}/authentications" \
  -X POST \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  --data-raw '{}'

Request

Request Path

agreement_ref

Public agreement reference.

stringrequired

Request Body

{
  "password": ""
}

password

stringnulloptional

Responses

200 OK

Session continuation.

{
  "data": {}
}

data

objectrequired

data.session

Authenticated session continuation payload.

objectoptional

data.verification

Signature or signing authentication verification challenge.

objectoptional

data.verification.channel

stringnullrequired

data.verification.expires_at

string,null (date-time)required

data.verification.ref

Public stable resource reference.

string (uuid)required

201 Created

Refreshed authenticated session.

{
  "data": {}
}

data

objectrequired

data.session

Authenticated session continuation payload.

objectoptional

data.verification

Signature or signing authentication verification challenge.

objectoptional

data.verification.channel

stringnullrequired

data.verification.expires_at

string,null (date-time)required

data.verification.ref

Public stable resource reference.

string (uuid)required

202 Response

Verification challenge for authentication completion.

{
  "data": {}
}

data

objectrequired

data.session

Authenticated session continuation payload.

objectoptional

data.verification

Signature or signing authentication verification challenge.

objectoptional

data.verification.channel

stringnullrequired

data.verification.expires_at

string,null (date-time)required

data.verification.ref

Public stable resource reference.

string (uuid)required

400 Bad Request

{
  "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

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

422 Unprocessable Entity

{
  "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