You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: documentation/docs/quick-start.md
+71-54
Original file line number
Diff line number
Diff line change
@@ -148,7 +148,7 @@ API_KEY_ENABLED disables API Key authentication. This should **not** be used bey
148
148
### Agent configuration
149
149
150
150
#### Creating LongForm PrismDID
151
-
1. Run the following API request against your Issuer API to create a PRISM DID:
151
+
1. Run the following API request against your Issuer API to create a PRISM DID, this gives you the `longFormDID`:
152
152
153
153
:::note
154
154
@@ -177,16 +177,14 @@ curl --location \
177
177
}'
178
178
```
179
179
180
-
2. Publish the DID by replacing `{didRef}` with the `longFormDid`output value from the previous step.
180
+
2. Publish the DID by replacing `{longFormDID}` with the output value from the previous step. This returns the DID in its short form, `publishedPrismDID`
181
181
182
182
```bash
183
183
curl --location \
184
-
--request POST 'http://localhost:8000/cloud-agent/did-registrar/dids/{didRef}/publications' \
184
+
--request POST 'http://localhost:8000/cloud-agent/did-registrar/dids/{longFormDID}/publications' \
185
185
--header 'Accept: application/json'
186
186
```
187
187
188
-
3. The short version of the DID is the publishedPrismDID.
189
-
190
188
:::info
191
189
192
190
📖Learn more about PRISM DIDs and why it is necessary to publish specific DIDs [here](https://staging-docs.atalaprism.io/tutorials/dids/publish).
@@ -616,26 +614,27 @@ The Issuer can create a credential offer in two ways:
616
614
Please replace the following variables in the example request before sending:
617
615
618
616
-`connectionId`: The ID of the connection previously established between agent and holder. This is part of the response of the POST message from the agent when calling the `cloud-agent/connections` endpoint. It is returned in the `connectionId` attribute. There is a unique connection ID for the relationship between issuer and holder and verifier and holder. In this example, please use the `connectionId` returned when creating the connection between issuer and holder
619
-
-`publishedPrismDID`: The short form of the PRISM DID created when setting up the Issuer agent
620
-
621
-
The `connectionId` is just the ID of the connection we previously established with the issuer.
622
-
623
-
The Issuing DID is the published PRISM DID in its short version which was also used to create and publish the credential schema.
624
-
625
-
- ``
617
+
-`issuingDID`: The Issuing DID is the `publishedPrismDID` created when [configuring the Issuer](#agent-configuration), which is the `longFormPrismDID` in its short form version.
626
618
627
619
:::
628
620
629
621
```bash
630
622
curl --location --request POST 'http://localhost:8000/cloud-agent/issue-credentials/credential-offers' \
### Create a Credential Offer as Invitation for connectionless issuance **Issuer Agent**
@@ -646,25 +645,27 @@ curl --location --request POST 'http://localhost:8000/cloud-agent/issue-credenti
646
645
647
646
Please replace the following variables in the example request before sending:
648
647
649
-
-`goalCode`: OPTIONAL A self-attested code the receiver may want to display to the user or use in automatically deciding what to do with the out-of-band message,
648
+
-`goalCode`: OPTIONAL A self-attested string code the receiver may want to display to the user or use in automatically deciding what to do with the out-of-band message,
650
649
-`goal`: OPTIONAL. A self-attested string that the receiver may want to display to the user about the context-specific goal of the out-of-band message.
651
-
-`publishedPrismDID`: The short form of the PRISM DID created when setting up the Issuer agent
652
-
653
-
The Issuing DID is the published PRISM DID in its short version which was also used to create and publish the credential schema.
654
-
655
-
- ``
650
+
-`issuingDID`: The Issuing DID is the `publishedPrismDID` created when [configuring the Issuer](#agent-configuration), which is the `longFormPrismDID` in its short form version.
656
651
657
652
:::
658
653
659
654
```bash
660
655
curl --location --request POST 'http://localhost:8000/cloud-agent/issue-credentials/credential-offers/invitation' \
automaticIssuance is optional. It can also be manually triggered and confirmed by the Holder.```
738
+
`automaticIssuance` is optional. It can also be manually triggered and confirmed by the Holder.
738
739
739
740
:::
740
741
@@ -758,30 +759,37 @@ automaticIssuance is optional. It can also be manually triggered and confirmed b
758
759
</Tabs>
759
760
760
761
761
-
<summary>Code examples</summary>
762
+
#### Code examples
762
763
763
-
5. The exchange between CredentialOffer and CredentialRequest is demonstrated through more advanced code samples below, showcasing how different platforms handle it.
764
+
5. The exchange between `CredentialOffer` and `CredentialRequest` is demonstrated through more advanced code samples below, showcasing how different platforms handle it.
0 commit comments