UNPKG

@affinidi-tdk/credential-issuance-client

Version:

Affinidi TDK typescript client for Affinidi CREDENTIAL ISSUANCE

github.com/affinidi/affinidi-tdk/tree/main

affinidi/affinidi-tdk

122 lines (71 loc) • 4.17 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
# IssuanceApi All URIs are relative to *https://apse1.api.affinidi.io/cis* | Method | HTTP request | Description | | ------------------------------------------------------- | --------------------------------------------------- | ----------- | | [**issuanceState**](IssuanceApi.md#issuanceState) | **GET** /v1/{projectId}/issuance/state/{issuanceId} | | | [**issueCredentials**](IssuanceApi.md#issueCredentials) | **POST** /v1/{projectId}/credential/issue | | | [**listIssuance**](IssuanceApi.md#listIssuance) | **GET** /v1/{projectId}/issuance | | | [**startIssuance**](IssuanceApi.md#startIssuance) | **POST** /v1/{projectId}/issuance/start | | <a name="issuanceState"></a> # **issuanceState** > IssuanceStateResponse issuanceState(issuanceId, projectId) Get issuance status ### Parameters | Name | Type | Description | Notes | | -------------- | ---------- | ------------------- | ----------------- | | **issuanceId** | **String** | | [default to null] | | **projectId** | **String** | Affinidi project id | [default to null] | ### Return type [**IssuanceStateResponse**](../Models/IssuanceStateResponse.md) ### Authorization [ProjectTokenAuth](../README.md#ProjectTokenAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json <a name="issueCredentials"></a> # **issueCredentials** > CredentialResponse issueCredentials(projectId, StartIssuanceInput) Endpoint to issue credentials directly without following OID4VCI flow ### Parameters | Name | Type | Description | Notes | | ---------------------- | --------------------------------------------------------- | ------------------------------ | ----------------- | | **projectId** | **String** | Affinidi project id | [default to null] | | **StartIssuanceInput** | [**StartIssuanceInput**](../Models/StartIssuanceInput.md) | Request body to start issuance | | ### Return type [**CredentialResponse**](../Models/CredentialResponse.md) ### Authorization [ProjectTokenAuth](../README.md#ProjectTokenAuth) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json <a name="listIssuance"></a> # **listIssuance** > ListIssuanceResponse listIssuance(projectId) List all issuances for Project ### Parameters | Name | Type | Description | Notes | | ------------- | ---------- | ------------------- | ----------------- | | **projectId** | **String** | Affinidi project id | [default to null] | ### Return type [**ListIssuanceResponse**](../Models/ListIssuanceResponse.md) ### Authorization [ProjectTokenAuth](../README.md#ProjectTokenAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json <a name="startIssuance"></a> # **startIssuance** > StartIssuanceResponse startIssuance(projectId, StartIssuanceInput) Endpoint used b websites to start the issuance process ### Parameters | Name | Type | Description | Notes | | ---------------------- | --------------------------------------------------------- | ------------------------------ | ----------------- | | **projectId** | **String** | Affinidi project id | [default to null] | | **StartIssuanceInput** | [**StartIssuanceInput**](../Models/StartIssuanceInput.md) | Request body to start issuance | | ### Return type [**StartIssuanceResponse**](../Models/StartIssuanceResponse.md) ### Authorization [ProjectTokenAuth](../README.md#ProjectTokenAuth) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json