Issuer Component - POST create credential

[jjeroch]

Summary

Endpoint to create a credential based on the input received from the FE application - note when receiving the requests, any previous validations are already executed (e.g. validation of presentation).

Important - Request url encoded

Details

Endpoint: /createCredentialxxxxxx (bpn)

Method: POST

Request Body:

 {
  "holder": "{didDocumentLocation}",
  "businessPartnerNumber": ".....",
  "technicalUserDetails": {
       "clientId": "{clientID}",
       "clientSecret": "{secret}"
     }
   }

Response:

201 created
400 in case didDocumentLocation not found
400 in case BPNL does not follow the official pattern (16characters; start with "BPN" and only letters and digits) not found

Note: we decided to add the BPN field inside the request body. Reason: each company can have multiple BPNs (especially when it comes to BPNSs and BPNAs. To be flexible for the future; we decided to have a own property for the BPN attribute.

---

Endpoint: /createCredentialxxxxxx (membership)

Method: POST

Request Body:

 {
  "holder": "{didDocumentLocation}",
  "memberOf": ".....",
  "technicalUserDetails": {
       "clientId": "{clientID}",
       "clientSecret": "{secret}"
     }
   }

Response:

201 created
400 in case didDocumentLocation not found
400 in case memberOf not existing

---

Endpoint: /createCredentialxxxxxx (frameWork)

Method: POST

Request Body:

 {
  "holder": "{didDocumentLocation}",
  "useCaseFrameworkID": "{uuid}",
  "technicalUserDetails": {
       "clientId": "{clientID}",
       "clientSecret": "{secret}"
     }
   }

Response:

201 created
400 in case didDocumentLocation not found
400 in case useCaseFrameworkID not existing

Explanation:

• The API endpoint /createCredentialxxxxx is used to create a new credential.
• The request method is POST since we are creating a new resource.
• The response is only a success/error information since further processes are running assynchron
• the technical user details are optional in case those are not entered; the process will proceed (reason without technical user details we are not able to push the credential into the holder wallet BUT thats ok; we will offer the customer to download the credential and place it inside the holder wallet by himself)
• Note: the newly created credential is supposed to get stored as .json file inside the ssi-credential-issuer.documents table with the status "Active"; Type: Credential; user id: tech user; timestamp as of today
• The POST endpoints should be implemented as x-www-form-urlencoded

[jjeroch]

Refinement with @Phil91 done; ticket moved to "Backlog"

[jjeroch]

@Phil91 please note that I added at the bottom of the ticket the following bullet point:

• Note: the newly created credential is supposed to get stored as .json file inside the ssi-credential-issuer.documents table with the status "Active"; Type: Credential; user id: tech user; timestamp as of today