Confirm a relationship

patch

https://api.eu1.notabene.id/entities/{entityDID}/relationships

Confirms a relationship between an address and an entity. Creates the relationship if it doesn't exist (upsert behavior). Optionally includes an ownership proof for verification.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

entityDID

string

required

^did:([a-z0-9]+):((?:(?:[a-zA-Z0-9._-]|(?:%[0-9a-fA-F]{2}))*:)*(?:[a-zA-Z0-9._-]|(?:%[0-9a-fA-F]{2}))+)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(/[^#?]*)?([?][^#]*)?(#.*)?$

The DID of the entity

Query Params

from

string

length between 3 and 255

string

length between 3 and 255

custodian

string

length between 3 and 255

^did:([a-z0-9]+):((?:(?:[a-zA-Z0-9._@-]|(?:%[0-9a-fA-F]{2}))*:)*((?:[a-zA-Z0-9._@-]|(?:%[0-9a-fA-F]{2}))+))((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\/[^#?]*)?([?][^#]*)?(#.*)?$

asset

array of objects

Filter transfers by asset identifier

asset

Body Params

proof

object

from

string

length between 3 and 255

string

length between 3 and 255

custodian

string

length between 3 and 255

^did:([a-z0-9]+):((?:(?:[a-zA-Z0-9._@-]|(?:%[0-9a-fA-F]{2}))*:)*((?:[a-zA-Z0-9._@-]|(?:%[0-9a-fA-F]{2}))+))((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\/[^#?]*)?([?][^#]*)?(#.*)?$

asset

string

Responses

201Relationship confirmed successfully

400Bad Request - The server could not process the request due to a client error.

401Unauthorized - Authentication information is missing or invalid.

403Forbidden - The server understood the request but refuses to authorize it.

404Not Found - The requested resource could not be found.

409Conflict - The request could not be completed due to a conflict with the current state of the resource.

500Internal Server Error - An unexpected condition was encountered on the server.