Request credential via OID4VCI

POST 
/api/oid4vci/holder/request

Requests a new credential via the OID4VCI Pre-authorized-code flow.

Request

Responses

200

application/json

Schema

Schema

idstringrequired
targetDidstringrequired

credential

object

required

@contextstring[]required

typestring[]required

idstring

credentialSubject

object

required

oneOf

DefaultCredentialSubjectDto

idstringrequired

MOD2

Array [

idstringrequired

]

issuerstringrequired

expirationDatedate-time

issuanceDatedate-timerequired

evidenceobject

proof

object

required

oneOf

MOD1

oneOf

DataIntegrityProofDto

idstring

typestringrequired

proofPurposestringrequired

verificationMethodstring

cryptosuitestringrequired

createdstring

expiresstring

domain

object

oneOf

MOD1

string

MOD2

Array [

string

]

challengestring

proofValuestringrequired

previousProof

object

oneOf

MOD1

string

MOD2

Array [

string

]

noncestring

JsonWebSignature2020Dto

typestringrequired

createddate-timerequired

proofPurposestringrequired

jwsstringrequired

verificationMethodstringrequired

MOD2

Array [

oneOf

DataIntegrityProofDto

idstring

typestringrequired

proofPurposestringrequired

verificationMethodstring

cryptosuitestringrequired

createdstring

expiresstring

domain

object

oneOf

MOD1

string

MOD2

Array [

string

]

challengestring

proofValuestringrequired

previousProof

object

oneOf

MOD1

string

MOD2

Array [

string

]

noncestring

JsonWebSignature2020Dto

typestringrequired

createddate-timerequired

proofPurposestringrequired

jwsstringrequired

verificationMethodstringrequired

]

selfIssuedbooleanrequired
createddate-timerequired
modifieddate-timerequired
deleteddate-time

Example (from schema)

{
  "id": "string",
  "targetDid": "string",
  "credential": {
    "@context": [
      "string"
    ],
    "type": [
      "string"
    ],
    "id": "string",
    "credentialSubject": {},
    "issuer": "string",
    "expirationDate": "2024-07-29T15:51:28.071Z",
    "issuanceDate": "2024-07-29T15:51:28.071Z",
    "evidence": {}
  },
  "selfIssued": true,
  "created": "2024-07-29T15:51:28.071Z",
  "modified": "2024-07-29T15:51:28.071Z",
  "deleted": "2024-07-29T15:51:28.071Z"
}

400

Malformed request

application/json

Schema

Schema

namestringrequired
statusstringrequired
codenumberrequired
messageobject
errorstring

Example (from schema)

{
  "name": "string",
  "status": "string",
  "code": 0,
  "message": {},
  "error": "string"
}

403

Forbidden

application/json

Schema

Schema

namestringrequired
statusstringrequired
codenumberrequired
messageobject
errorstring

Example (from schema)

{
  "name": "string",
  "status": "string",
  "code": 0,
  "message": {},
  "error": "string"
}