Connections

Endpoints for managing connections

Get all connections

get

This endpoint retrieves all connections.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Query parameters

sort-fieldstringOptional

The field to sort by (default updated_at).

sort-directionstringOptional

The direction to sort (ASC or DESC, default DESC).

page-sizeintegerOptional

The number of connections per page (default 20).

current-pageintegerOptional

The current page number (default 1).

item-countintegerOptional

The total number of items.

state-filterstringOptional

If provided, returns only connections with this state.

contact-idstringOptional

If provided, returns only connections for this contact_id.

Responses

200

A list of connections

application/json

401

Unauthorized.

500

Internal Server Error

application/json

get

/api/v1/connections

HTTPcURLJavaScriptPython

GET /api/v1/connections HTTP/1.1
Host: proven-4-2-test.proven.indicio.tech
x-api-key: YOUR_API_KEY
Accept: */*

{
  "params": {
    "sort": [
      [
        [
          "updated_at",
          "DESC"
        ]
      ]
    ],
    "pageSize": "1",
    "currentPage": 1,
    "pageCount": 1,
    "itemCount": 1,
    "stateFilter": null,
    "contactIdFilter": null
  },
  "rows": [
    {
      "connection_id": "bd8d1663-38ac-46c8-9314-7d26bf731c88",
      "state": "active",
      "my_did": "did:peer:4zQmaa3MtBR8sPBAzZqVmwYqpjCzm4vAEh7FPMutFq71uHNN:zX4i2p2FcjJFFGYQy3UXZd5LCnUP9t7NenynBWQnmt13wxpMsSkaqGk8rFFk63RFhrCGwgYXpb4UJukfdmWyxcKJwEMSJt2akPvrAfZ3YQ2iAQ5GUgoLsADHbcZBNpPXS2JXH7zNFeq7s1gtSiVfs1otPiSX5PxKkT7czheF9TwszcVGTvAfAGocN2UHKNF2qi77YDsmmkarjDWngKqrzfW7dumgzXyawj7Ne9eRXsAVjCm2QoqU3M5mbTysFziW5GEJwJvAHHjq9nBTgwf3SzTLqGvL86yCnmxMb4zFtKzfi369b9hzVXRiKAoPeeqtvGGQVcSESWQumdfKKgLWFhCuEJowoDpw15WFVmkgiSFsAx14CX4fuq2tUVMmmcpDgH5A6J5qWQYiqPjTNTsm7Cu7jUWDEmvS93G1LcmtM8fno5wGH2Yw5A3qtFywgXs8KeBptpzgLYo37yLe6xxh1g1Z2pn2FGrVWm6AZxgwwyDSDFQGpgbEy2ZP5jmunh3eUgrJPex9aLGUSBrtHyq5g2aN424J3Vg5zbDQ9woAmzaZ97mg3rGWkvcShpiW1gHBXVsvwHXt161xsEq6VL4VhApyy9LCjJHzr25zgDyv8MgzJ",
      "alias": "API Invitation",
      "request_id": "c9babf88-e26d-47e7-b1f8-34645e3385b1",
      "invitation_key": "G9nZtxjCA8FqrUmtyRegi5LrXpxYrsEKoyfBi4kbH5fx",
      "invitation_msg_id": "ce6b9040-09ff-4eab-80c0-c6cb934596ca",
      "invitation_mode": "once",
      "invitation_url": "https://example.com/agent?oob=eyJAdHlwZSI6ICJodHRwczovL2RpZGNvbW0ub3JnL291dC1vZi1iYW5kLzEuMS9pbnZpdGF0aW9uIiwgIkBpZCI6ICJjZTZiOTA0MC0wOWZmLTRlYWItODBjMC1jNmNiOTM0NTk2Y2EiLCAibGFiZWwiOiAiT09CIiwgImhhbmRzaGFrZV9wcm90b2NvbHMiOiBbImh0dHBzOi8vZGlkY29tbS5vCmcvZGlkZXhjaGFuZ2UvMS4xIl0sICJzZXJ2aWNlcyI6IFt7ImlkIjogIiNpbmxpbmUiLCAidHlwZSI6ICJkaWQtY29tbXVuaWNhdGlvbiIsICJyZWNpcGllbnRLZXlzIjogWyJkaWQ6a2V5Ono2TWt1YzNjVkN5ZFZma0p4eWNiZXpjWFpBdHJNUUVRR2tVZ1Z2YTdZTGljQ0pUTCN6Nk1rdWMzY1ZDeWRWZmtKeHljYmV6Y1haQXRyTVFFUUdrVWdWemE3WUxpY0NKVEwiXSwgInNlcnZpY2VFbmRwb2ludCI6ICJodHRwczovL3NpbW9uZGV2Mi56cm9rLmRldi5pbmRpY2lvdGVjaC5pby9hZ2VudCJ9XX0",
      "invitation": {
        "@type": "https://didcomm.org/out-of-band/1.1/invitation",
        "@id": "ce6b9040-09ff-4eab-80c0-c6cb934596ca",
        "label": "OOB",
        "handshake_protocols": [
          "https://didcomm.org/didexchange/1.1"
        ],
        "services": [
          {
            "id": "#inline",
            "type": "did-communication",
            "recipientKeys": [
              "did:key:z6Mkuc3cVCydVfkJxycbezcXZAtrMQEQGkUgVza7YLicCJTL#z6Mkuc3cVCydVfkJxycbezcXZAtrMQEQGkUgVza7YLicCJTL"
            ],
            "serviceEndpoint": "https://example.com/agent"
          }
        ]
      },
      "accept": "auto",
      "initiator": null,
      "their_role": "invitee",
      "their_did": "did:peer:1zQmVbupaSwiuhgBVGERqxhGqfy5pQGDd73bLQLrtiat7ygR",
      "their_public_did": null,
      "their_label": "Sim Ios",
      "routing_state": null,
      "inbound_connection_id": null,
      "error_msg": null,
      "contact_id": "4fbbe345-f38c-45b1-8d9b-c33e64ee0518",
      "transaction_role": null,
      "discovered_features": [
        {
          "pid": "https://didcomm.org/coordinate-mediation/1.0",
          "roles": [
            "RECIPIENT",
            "MEDIATOR"
          ]
        },
        {
          "pid": "https://didcomm.org/didexchange/1.1",
          "roles": [
            "requester",
            "responder"
          ]
        },
        {
          "pid": "https://didcomm.org/did-rotate/1.0",
          "roles": [
            "rotating_party",
            "observing_party"
          ]
        },
        {
          "pid": "https://didcomm.org/revocation_notification/1.0",
          "roles": [
            "holder"
          ]
        },
        {
          "pid": "https://didcomm.org/revocation_notification/2.0",
          "roles": [
            "holder"
          ]
        },
        {
          "pid": "https://didcomm.org/issue-credential/2.0",
          "roles": [
            "holder",
            "issuer"
          ]
        },
        {
          "pid": "https://didcomm.org/discover-features/1.0",
          "roles": [
            "requester",
            "responder"
          ]
        },
        {
          "pid": "https://didcomm.org/discover-features/2.0",
          "roles": [
            "requester",
            "responder"
          ]
        },
        {
          "pid": "https://didcomm.org/present-proof/2.0",
          "roles": [
            "prover",
            "verifier"
          ]
        },
        {
          "pid": "https://didcomm.org/messagepickup/1.0",
          "roles": [
            "message_holder",
            "recipient",
            "batch_sender",
            "batch_recipient"
          ]
        },
        {
          "pid": "https://didcomm.org/messagepickup/2.0",
          "roles": [
            "mediator",
            "recipient"
          ]
        },
        {
          "pid": "https://didcomm.org/basicmessage/1.0",
          "roles": [
            "sender",
            "receiver"
          ]
        },
        {
          "pid": "https://didcomm.org/out-of-band/1.1",
          "roles": [
            "sender",
            "receiver"
          ]
        }
      ],
      "wallet_id": "70b6a0d2-628a-4de6-af96-144100f74878",
      "created_at": "2025-07-08T20:51:18.856Z",
      "updated_at": "2025-07-08T21:00:21.741Z"
    }
  ],
  "count": 1
}

Get a connection by ID

get

This endpoint retrieves a connection by its id.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Path parameters

connection_idstringRequired

The connection id of the connection to retrieve.

Responses

200

Connection record retrieved successfully

application/json

connection_idstringOptional

statestringOptional

my_didstringOptional

aliasstringOptional

request_idstringOptional

invitation_keystringOptional

invitation_msg_idstringOptional

invitation_modestringOptional

invitation_urlstringOptional

acceptstringOptional

initiatorstringOptional

their_rolestringOptional

their_didstringOptional

their_public_didstringOptional

their_labelstringOptional

routing_statestringOptional

inbound_connection_idstringOptional

error_msgstringOptional

contact_idstringOptional

transaction_rolestringOptional

wallet_idstringOptional

created_atstringOptional

updated_atstringOptional

401

Unauthorized.

404

Connection not found

application/json

500

Internal Server Error

application/json

get

/api/v1/connections/{connection_id}

HTTPcURLJavaScriptPython

GET /api/v1/connections/{connection_id} HTTP/1.1
Host: proven-4-2-test.proven.indicio.tech
x-api-key: YOUR_API_KEY
Accept: */*

{
  "connection_id": "bd8d1663-38ac-46c8-9314-7d26bf731c88",
  "state": "active",
  "my_did": "did:peer:4zQmaa3MtBR8sPBAzZqVmwYqpjCzm4vAEh7FPMutFq71uHNN:zX4i2p2FcjJFFGYQy3UXZd5LCnUP9t7NenynBWQnmt13wxpMsSkaqGk8rFFk63RFhrCGwgYXpb4UJukfdmWyxcKJwEMSJt2akPvrAfZ3YQ2iAQ5GUgoLsADHbcZBNpPXS2JXH7zNFeq7s1gtSiVfs1otPiSX5PxKkT7czheF9TwszcVGTvAfAGocN2UHKNF2qi77YDsmmkarjDWngKqrzfW7dumgzXyawj7Ne9eRXsAVjCm2QoqU3M5mbTysFziW5GEJwJvAHHjq9nBTgwf3SzTLqGvL86yCnmxMb4zFtKzfi369b9hzVXRiKAoPeeqtvGGQVcSESWQumdfKKgLWFhCuEJowoDpw15WFVmkgiSFsAx14CX4fuq2tUVMmmcpDgH5A6J5qWQYiqPjTNTsm7Cu7jUWDEmvS93G1LcmtM8fno5wGH2Yw5A3qtFywgXs8KeBptpzgLYo37yLe6xxh1g1Z2pn2FGrVWm6AZxgwwyDSDFQGpgbEy2ZP5jmunh3eUgrJPex9aLGUSBrtHyq5g2aN424J3Vg5zbDQ9woAmzaZ97mg3rGWkvcShpiW1gHBXVsvwHXt161xsEq6VL4VhApyy9LCjJHzr25zgDyv8MgzJ",
  "alias": "API Invitation",
  "request_id": "c9babf88-e26d-47e7-b1f8-34645e3385b1",
  "invitation_key": "G9nZtxjCA8FqrUmtyRegi5LrXpxYrsEKoyfBi4kbH5fx",
  "invitation_msg_id": "ce6b9040-09ff-4eab-80c0-c6cb934596ca",
  "invitation_mode": "once",
  "invitation_url": "https://example.com/agent?oob=eyJAdHlwZSI6ICJodHRwczovL2RpZGNvbW0ub3JnL291dC1vZi1iYW5kLzEuMS9pbnZpdGF0aW9uIiwgIkBpZCI6ICJjZTZiOTA0MC0wOWZmLTRlYWItODBjMC1jNmNiOTM0NTk2Y2EiLCAibGFiZWwiOiAiT09CIiwgImhhbmRzaGFrZV9wcm90b2NvbHMiOiBbImh0dHBzOi8vZGlkY29tbS5vCmcvZGlkZXhjaGFuZ2UvMS4xIl0sICJzZXJ2aWNlcyI6IFt7ImlkIjogIiNpbmxpbmUiLCAidHlwZSI6ICJkaWQtY29tbXVuaWNhdGlvbiIsICJyZWNpcGllbnRLZXlzIjogWyJkaWQ6a2V5Ono2TWt1YzNjVkN5ZFZma0p4eWNiZXpjWFpBdHJNUUVRR2tVZ1Z2YTdZTGljQ0pUTCN6Nk1rdWMzY1ZDeWRWZmtKeHljYmV6Y1haQXRyTVFFUUdrVWdWemE3WUxpY0NKVEwiXSwgInNlcnZpY2VFbmRwb2ludCI6ICJodHRwczovL3NpbW9uZGV2Mi56cm9rLmRldi5pbmRpY2lvdGVjaC5pby9hZ2VudCJ9XX0",
  "invitation": {
    "@type": "https://didcomm.org/out-of-band/1.1/invitation",
    "@id": "ce6b9040-09ff-4eab-80c0-c6cb934596ca",
    "label": "OOB",
    "handshake_protocols": [
      "https://didcomm.org/didexchange/1.1"
    ],
    "services": [
      {
        "id": "#inline",
        "type": "did-communication",
        "recipientKeys": [
          "did:key:z6Mkuc3cVCydVfkJxycbezcXZAtrMQEQGkUgVza7YLicCJTL#z6Mkuc3cVCydVfkJxycbezcXZAtrMQEQGkUgVza7YLicCJTL"
        ],
        "serviceEndpoint": "https://example.com/agent"
      }
    ],
    "accept": "auto",
    "initiator": null,
    "their_role": "invitee",
    "their_did": "did:peer:1zQmVbupaSwiuhgBVGERqxhGqfy5pQGDd73bLQLrtiat7ygR",
    "their_public_did": null,
    "their_label": "Sim Ios",
    "routing_state": null,
    "inbound_connection_id": null,
    "error_msg": null,
    "contact_id": "4fbbe345-f38c-45b1-8d9b-c33e64ee0518",
    "transaction_role": null,
    "discovered_features": [
      {
        "pid": "https://didcomm.org/coordinate-mediation/1.0",
        "roles": [
          "RECIPIENT",
          "MEDIATOR"
        ]
      },
      {
        "pid": "https://didcomm.org/didexchange/1.1",
        "roles": [
          "requester",
          "responder"
        ]
      },
      {
        "pid": "https://didcomm.org/did-rotate/1.0",
        "roles": [
          "rotating_party",
          "observing_party"
        ]
      },
      {
        "pid": "https://didcomm.org/revocation_notification/1.0",
        "roles": [
          "holder"
        ]
      },
      {
        "pid": "https://didcomm.org/revocation_notification/2.0",
        "roles": [
          "holder"
        ]
      },
      {
        "pid": "https://didcomm.org/issue-credential/2.0",
        "roles": [
          "holder",
          "issuer"
        ]
      },
      {
        "pid": "https://didcomm.org/discover-features/1.0",
        "roles": [
          "requester",
          "responder"
        ]
      },
      {
        "pid": "https://didcomm.org/discover-features/2.0",
        "roles": [
          "requester",
          "responder"
        ]
      },
      {
        "pid": "https://didcomm.org/present-proof/2.0",
        "roles": [
          "prover",
          "verifier"
        ]
      },
      {
        "pid": "https://didcomm.org/messagepickup/1.0",
        "roles": [
          "message_holder",
          "recipient",
          "batch_sender",
          "batch_recipient"
        ]
      },
      {
        "pid": "https://didcomm.org/messagepickup/2.0",
        "roles": [
          "mediator",
          "recipient"
        ]
      },
      {
        "pid": "https://didcomm.org/basicmessage/1.0",
        "roles": [
          "sender",
          "receiver"
        ]
      },
      {
        "pid": "https://didcomm.org/out-of-band/1.1",
        "roles": [
          "sender",
          "receiver"
        ]
      }
    ],
    "wallet_id": "70b6a0d2-628a-4de6-af96-144100f74878",
    "created_at": "2025-07-08T20:51:18.856Z",
    "updated_at": "2025-07-08T21:00:21.741Z"
  }
}