🔒Certify

Getting started with Archipels' Back Office

Getting started without BO (with Archipels' permission)

Certify a proof

Getting started with Archipels Back Office

How to start using Certify when you're onboarding with the Archipels Back OfficeHere is the URL of the Archipels Back Office : https://certify.archipels.io/​It needed to login or signin to the Archipels Back Office to use the Archipels Certify solution. Once you're on the Archipels Back Office, follow the instructions. After having registering yourself as a Trusted Source, you can go to the How to Certify ? page to certify proof.

If you want to get started without Archipels Back Office - ask the Archipels team and wait for their authorization - and follow the instructions below

1) Set up an the environment to authenticate to our registry

In a .env file or with environment variables, you must set the following variables in order to make requests to the Trust Registry.

• TRUST_REGISTRY_URL: The URL of the Trust Registry API

  • Sandbox: https://api.archipels.io/sandbox/trust-registry/v1/
  • Production: https://api.archipels.io/trust-registry/v1/
• TRUST_REGISTRY_API_KEY: The API key to access the Trust Registry API

Now you can run the SDK API in a container (using a .env file):

docker run --env-file .env -p 3000:3000 registry.gitlab.com/archipels-managed/trust-registry-sdk/api:<version>

The version is provided when given the TRUST_REGISTRY_API_KEY.

Once the container has started, the Open API interactive documentation is accessible on http://localhost:3000/docs.

2) Create your key pair (public/private)

This operation is done without any communication with Trust Registry API.

The algorithm can be EDDSA or ECDSA.

GET /keys
Host : "<yourLocalApiInstanceUrl>"

This operation will return this type of json :

3) Complete your environment

In an .env file or directly in your run environment, you need to add the following variables in order to create or register your identity :

• PUBLIC_KEY: public key used to sign data, cf. 1.a.i.2https://www.notion.so/archipels/Documentation-technique-16657e86376d4368874c5be64f57a12d#48558e34443146e6a9a1f9e309cd64ce0
• PRIVATE_KEY: private key used to sign data, cf. 1.a.i.2https://www.notion.so/archipels/Documentation-technique-16657e86376d4368874c5be64f57a12d#48558e34443146e6a9a1f9e309d64ce0
• ALGORITHM: signature algorithm used EDDSAor ECDSA

# .env
TRUST_REGISTRY_URL="<https://api.archipels.io/trust-registry/v1/>",
TRUST_REGISTRY_API_KEY="e867be7d-55g2-45f9-80f1-ae776f868754",
PUBLIC_KEY="VNxEdrOol/bnpB3irOCjP7gwanynqJDvUPp6PvI9zOw=",
PRIVATE_KEY="UaBBJVneNEe2q967GHAroXS2tNkoYgr7ZHFjoTlEvMs172Dtq9XaHP4gN9PehiKNotZPPQYfWv9NkzgoTnbWsw==",
ALGORITHM="EDDSA"

4) Register you identity in the Trust Registry

WARNING : When deploying the Certify solution in production, you cannot create your own identity, Archipels will provide your ISSUER_ID on demand. So you may skip this step.

There are the instructions for the sandbox deployment.

To create your identity, you need three environment variables : the TRUST_REGISTRY_URL, the TRUST_REGISTRY_API_KEY and the SDK_API_URL: where the API SDK is deployed.

To execute the command you need :

• one mandatory argument : the "pub_key" :"<PUBLIC_KEY>"

• two optionals arguments : the metadata including the name "name" of your identity (we recommend to associatemetadata) and its description"description"

• your issuer_id if you want to choose one especially. If you don’t, it will create an issuer_id for you. You need to save it from the response, since it will be used to identify you.

To register your identity in the Trust Registry use this code:

POST /dids -H 'Content-Type: application/json' --data '{ "pub_key": "Ne9g7avV2hz+IDfT3oYijaLWTz0GH1r/TZM4KE521rM=", "metadata": { "name": "Certification Company SAS", "description": "Lorem..." }, "issuer_id": "<your_issuer_id>", "algorithm": "EDDSA" }'
Host : "<yourLocalApiInstanceUrl>"

If you get the error connect ECONNREFUSED, check if you have the TRUST_REGISTRY_URL set.

The returned json will be like:

{
  "pub_key": "VNxEdrOol/bnpB3irOCjP7gwanynqJDvUPp6PvI9zOw=",
  "metadata": {
    "name": "Certification Company SAS",
    "description": "Lorem..."
  },
  "issuer_id": "518f623212217689f0b0ab91157454847aa034f41219829abcd6ea3b898790a6",
  "did_version": null,
  "algorithm": "EDDSA"
}

5) Finalize your environment

Now you have all the elements you need to complete your .env file. You must add the issuer_id you just created to your environment so that you have ISSUER_ID = "<issuer_id>"

Here is an example of a complete .env file :

# .env
TRUST_REGISTRY_URL="<https://api.archipels.io/trust-registry/v1/>",
TRUST_REGISTRY_API_KEY="e867be7d-55g2-45f9-80f1-ae776f868754",
ISSUER_ID = "518f623212217689f0b0ab91157454847aa034f41219829abcd6ea3b898790a6"
PUBLIC_KEY="VNxEdrOol/bnpB3irOCjP7gwanynqJDvUPp6PvI9zOw=",
PRIVATE_KEY="UaBBJVneNEe2q967GHAroXS2tNkoYgr7ZHFjoTlEvMs172Dtq9XaHP4gN9PehiKNotZPPQYfWv9NkzgoTnbWsw==",
ALGORITHM="EDDSA"

Once completed, you are able to certify schemas and proofs on Archipels thanks to the How to Certify ? page.