Findy Agency Service API

Findy Agency is an open-source project for a decentralized identity agency. OP Lab developed it from 2019 to 2024. The project is no longer maintained, but the work will continue with new goals and a new mission. Follow the blog for updates.

Getting Started

Findy Agency is a collection of services (Core, Auth, Vault and Web Wallet) that provide full SSI agency along with a web wallet for individuals. To start experimenting with Findy Agency we recommend you to start with the documentation and set up the agency to your localhost environment.

• Documentation
• Instructions for starting agency in Docker containers

Project

The gRPC API v1 includes interfaces for:

• operation services: log levels, statistics, health checking, etc.
• agency services: new agent on boarding, data hooks, etc.
• cloud agent services: notifications, responses, etc.
• protocol services: starting, running, responses, etc.

More detailed documentation for each of them can be found from protoc files in idl directory. The same documentation is available in the target languages compiled from the IDL files.

Typical Findy Agency Service Setup

The current implementation of the Findy Agency has three main services:

1. findy-agent includes the protocol engine which runs Aries compatible agent protocols and cloud agents.
2. findy-agent-auth includes a standard WebAuthn server. The findy-agent-auth repo also includes a headless FIDO2 authenticator for CLIs and service agents.
3. findy-agent-vault is a service for wallet data. The current API is in GraphQL. The future versions probably include gRPC API as well.

Client Stubs And Helpers

Both findy-common-go and findy-common-ts include client stubs and some convenient helpers for the use of the API.

Service Implementations

The most of the services are implemented by the findy core agency in findy-agent.

Client Reference Implementations

• findy-common-go (golang)
• findy-agent-cli (golang)
• findy-issuer-tool (node.js)

gRPC Style Guide

We follow the style guide with the following special rules:

• treat acronyms like numbers in the style guide.

Dart Support

If you haven't installed protoc's dart plugin yet, install it with the following command:

dart pub global activate protoc_plugin

Note. Naturally you need to first install dart or just flutter that includes the dart. Installing the Flutter is very easy or very cumperson, depending on your OS. Most difficult one has been Linux/ARM64 by far (summer 2023).