ConnectionRecordDto

idstringrequired

Unique connection identifier

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

statestringrequired

Current state of the DID exchange

Possible values: [start, invitation-sent, invitation-received, request-sent, request-received, response-sent, response-received, abandoned, completed]

rolestringrequired

Role in the DID exchange

Possible values: [requester, responder]

didstring

My DID for this connection

Example: did:webvh:QmaZYZF4aaHUTWzaKu23TowgvsX7JWfCRgQZX488EAssPQ:agent.example.com

theirDidstring

DID of the peer

Example: did:webvh:QmbfsYcjFS2bnouwXBSoZZ65jREEgZGSPdcatcwY7i1Gq2:peer.example.com

theirLabelstring

Human-readable label of the peer

Example: Alice

aliasstring

Local alias for this connection

Example: Work Chat

threadIdstring

DIDComm thread identifier

Example: thread-abc-123

imageUrlstring

Avatar URL advertised by the peer

outOfBandIdstringnullablerequired

Out-of-Band identifier this connection started from, or null when it has none

parentConnectionIdstringnullablerequired

Connection on which the agent sent the invitation that produced this connection, or null for every other connection

invitationDidstring

DID of the invitation this connection started from

didcommVersionstring

DIDComm version negotiated for this connection. Set only for connections established through the v2 out-of-band flow; absent otherwise.

Possible values: [v1, v2]

mediatorIdstring

Mediator that routes messages for this connection

previousDidsstring[]

Prior values of did after rotations

previousTheirDidsstring[]

Prior values of theirDid after rotations

createdAtstring<date-time>required

When the connection was created

updatedAtstring<date-time>required

When the connection was last updated

ConnectionRecordDto

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "state": "start",
  "role": "requester",
  "did": "did:webvh:QmaZYZF4aaHUTWzaKu23TowgvsX7JWfCRgQZX488EAssPQ:agent.example.com",
  "theirDid": "did:webvh:QmbfsYcjFS2bnouwXBSoZZ65jREEgZGSPdcatcwY7i1Gq2:peer.example.com",
  "theirLabel": "Alice",
  "alias": "Work Chat",
  "threadId": "thread-abc-123",
  "imageUrl": "string",
  "outOfBandId": "string",
  "parentConnectionId": "string",
  "invitationDid": "string",
  "didcommVersion": "v1",
  "mediatorId": "string",
  "previousDids": [
    "string"
  ],
  "previousTheirDids": [
    "string"
  ],
  "createdAt": "2024-07-29T15:51:28.071Z",
  "updatedAt": "2024-07-29T15:51:28.071Z"
}