v1

latestOpenAPI 3.1.02026-07-2685154311.7 KB

Relationships

Confirm a relationship

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.

patch/entities/{entityDID}/relationships

Path parameters

entityDIDstring did required

Decentralized Identifier (DID)

Example:did:web:vasps.id:jxnl0411:at

The DID of the entity

Query parameters

fromstring

tostring

custodianstring

Example:did:web:example.com

assetAssetIdentifier[]

Filter transfers by asset identifier

[
  "bip122:000000000019d6689c085ae165831e93/slip44:0"
]

Request body

fromstring

tostring

custodianstring

assetstring

Example request

{
  "proof": {
    "did": "did:web:example.com",
    "address": "eip155:1:0x1234567890123456789012345678901234567890"
  },
  "custodian": "did:web:example.com"
}

Response

Relationship confirmed successfully

successboolean required