v1

latestOpenAPI 3.1.02026-07-2685154311.7 KB

Relationships

Create a new relationship

Creates a new relationship between an address and an entity. Relationships establish ownership or control over blockchain addresses. Optionally includes an ownership proof for verification.

post/entities/{entityDID}/relationships

Path parameters

entityDIDstring did required

Decentralized Identifier (DID)

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

The DID of the entity

Request body

fromstring

tostring required

custodianstring

assetstring

Example request

{
  "from": "did:pkh:eip155:1:0x1234567890123456789012345678901234567890",
  "to": "did:web:destination.example.com"
}

Response

Relationship created successfully

Example response

{
  "relationship": {
    "@id": "relationship-123",
    "@type": "Relationship",
    "from": "did:web:source.example.com",
    "to": "did:web:destination.example.com",
    "status": "CONFIRMED",
    "createdTime": "2024-01-01T00:00:00Z"
  }
}