Onboarding
ebsi onboarding issue-vc
ebsi onboarding insert-did-document
ebsi onboarding add-verification-method
ebsi onboarding add-verification-relationship --relationship <name>
ebsi onboarding onboard
Issues and uses the VerifiableAuthorisationToOnboard VC needed to onboard a new DID with the did-registry:invite scope. There is no HTTP endpoint for issuing this VC: it is signed locally by an issuer of the trust chain already registered in the Issuers Registry: a TI, a TAO or, with VCDM 1.1, a Root TAO. With VCDM 2.0 a Root TAO only accredits, so the issuer is the Support Office (through its seed record), a TAO or a TI.
Registering a DID takes several on-chain steps: insertDidDocument, addVerificationMethod, and addVerificationRelationship once per relationship (typically authentication and assertionMethod). Each step is a command, and onboard runs them all.
| Command | Description |
|---|---|
onboarding issue-vc | Sign a VerifiableAuthorisationToOnboard VC for a holder DID and key |
onboarding insert-did-document | Issue (or load) the VC, exchange it for a did-registry:invite token and insert the DID document |
onboarding add-verification-method | Add a verification method to a registered DID |
onboarding add-verification-relationship | Add a verification relationship for a method. Run once per relationship |
onboarding onboard | One-shot command that runs the steps above |
| Option | Description |
|---|---|
--issuer-did <did> | DID of the trusted issuer. Also EBSI_ISSUER_DID |
--issuer-es256-key <hex> | P-256 key of the issuer, signs the VC with ES256. Also EBSI_ISSUER_ES256_PRIVATE_KEY |
--issuer-es256k-key <hex> | secp256k1 key of the issuer, signs the VC with ES256K. Optional when --issuer-es256-key is set. Also EBSI_ISSUER_ES256K_PRIVATE_KEY |
--issuer-attribute-id <hex> | Id of the issuer's accreditation in the Issuers Registry. Also EBSI_ISSUER_ATTRIBUTE_ID |
--root-authorisation <uri> | VCDM 2.0 only: ebsi: URI of the Root TAO authorisation. Resolved from the registry when omitted. Also EBSI_ROOT_AUTHORISATION |
--holder-did <did> | issue-vc only. DID of the credential subject. Defaults to the wallet's DID |
--holder-thumbprint <tp> | issue-vc only. JWK thumbprint to embed. Defaults to the thumbprint of the wallet's secp256k1 key |
--out <file> | issue-vc only. Also write the signed VC to this file |
--vc <file> | insert-did-document and onboard. Use an existing VC instead of issuing one |
--to <address> | Write commands. DID Registry contract address. Defaults to DID_REGISTRY_CONTRACT_ADDRESS |
--not-before <epoch> / --not-after <epoch> | Validity window. Default 0 / 9999999999 |
--public-key <hex> / --vmethod-id <id> | add-verification-method only. Key and method id to register. Defaults to the configured P-256 key |
--is-secp256k1 | add-verification-method only. Register the key as secp256k1 |
--relationship <name> | add-verification-relationship only, required. For example authentication or assertionMethod |
--register-es256-key | onboard only. Also register the configured P-256 key as a verification method |
The global --es256k-key and --es256-key options are the holder's keys. onboard always signs with the secp256k1 key, because it is the key registered in the DID document.
Which key signs the VC. The VC is signed with ES256 when --issuer-es256-key is given, and with ES256K otherwise. Both ES256 and ES256K are accepted for the credential. The DID document of the issuer must contain the matching verification method with an assertionMethod relationship.
# Issue an ES256-signed onboarding VC for the configured wallet
ebsi onboarding issue-vc \
--issuer-did did:ebsi:zIssuer... --issuer-es256-key <p256-hex> --issuer-attribute-id 0x... \
--out ./onboarding-vc.jwt
# Onboard in one command, with an existing VC
ebsi wallet create --save
ebsi onboarding onboard --vc ./onboarding-vc.jwt
# Then get a write token
ebsi auth token --scope did-registry:write --save