Receive a delegation request or offer

POST

/delegation/v1/requests

curl --request POST \
  --url https://example.com/delegation/v1/requests \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

Another connector sends a DelegationRequest: a rights holder asks us to deliver a dataset (with its control plane), or a supplier offers to deliver one of ours (with its data plane). The same request again gets the same answer.

Authorizations

• dcp

Parameters

Header Parameters

BL-Evidence

string | null

The sender’s signature over the body, recorded as evidence.

Request Body^required

A DelegationRequest (JSON-LD).

Media typeapplication/json

object

Example ^generated

{}

Responses

201

Created.

Media typeapplication/json

What the other connector gets back: the state of the delegation.

object

@context

required

https://w3id.org/buildinglinks/v1/delegation.

string

@type

required

Delegation.

string

@id

required

string

state

required

string

Example ^generated

{
  "@context": "example",
  "@type": "example",
  "@id": "example",
  "state": "example"
}

400

The request is not valid.

Media typeapplication/json

The body of every failed call to a management API.

object

error

required

object

code

required

Stable, machine-readable: invalid_request, unauthenticated, forbidden, not_found, conflict, upstream_unavailable, unavailable, internal, or a more specific code of the operation.

string

message

required

For people; may change between versions.

string

Example

{
  "error": {
    "code": "not_found",
    "message": "unknown negotiation"
  }
}

401

No valid DCP token or signature.

403

The sender is not the delegator or delegate, or not an active member.

Media typeapplication/json

The body of every failed call to a management API.

object

error

required

object

code

required

Stable, machine-readable: invalid_request, unauthenticated, forbidden, not_found, conflict, upstream_unavailable, unavailable, internal, or a more specific code of the operation.

string

message

required

For people; may change between versions.

string

Example

{
  "error": {
    "code": "not_found",
    "message": "unknown negotiation"
  }
}

409

The id is in use.

Media typeapplication/json

The body of every failed call to a management API.

object

error

required

object

code

required

Stable, machine-readable: invalid_request, unauthenticated, forbidden, not_found, conflict, upstream_unavailable, unavailable, internal, or a more specific code of the operation.

string

message

required

For people; may change between versions.

string

Example

{
  "error": {
    "code": "not_found",
    "message": "unknown negotiation"
  }
}