Request credential via OID4VCI

POST 
/api/management/issuance/request/oid4vci

Requests a new credential via the OpenID 4 Verifiable Credential Issuance protocol.

Request

application/json

Bodyrequired

issuerUrlstringrequired
Example: https://issuer.example.com
preAuthorizedCodestring
Example: pre-auth-code-xyz
authorized object
accessTokenstringrequired
Example: access-token
credentialIdentifierstringrequired
Example: credential-type
additionalRequestParamsobject

Responses

200

application/json

Schema

Schema

idstringrequired
Unique identifier of the credential record
Example: b86483f3-3792-4a54-b11e-f1c6face9935
targetDidstringrequired
Target decentralized identifier
Example: did:example:456
credential object
The verifiable credential object
@contextstring[]required
Possible values: [https://www.w3.org/2018/credentials/v1, https://www.w3.org/ns/credentials/v2, https://w3id.org/security/suites/jws-2020/v1, https://w3id.org/security/data-integrity/v2, string]
Example: ["https://www.w3.org/2018/credentials/v1"]
typestring[]required
Example: ["VerifiableCredential","TestCredential"]
idstring
Example: http://example.edu/credentials/1872
credentialSubject objectrequired
idstringrequired
Example: did:example:subject-1
property name*any
Example: {"id":"did:example:subject-1","customProp":"value"}
issuerstringrequired
Example: did:example:issuer
issuanceDatestring
Example: 2020-01-01T00:00:00Z
expirationDatestring
Example: 2030-01-01T00:00:00Z
validFromstring
Example: 2020-01-01T00:00:00Z
validUntilstring
Example: 2030-01-01T00:00:00Z
evidence object
property name*any
Example: {"type":"DocumentVerification","verifier":"did:example:verifier"}
credentialStatus object
oneOf
CredentialStatus
@contextstring[]required
Example: ["https://w3id.org/dspace-dcp/v1.0/dcp.jsonld"]
typestringrequired
Example: CredentialStatus
issuerPidstringrequired
holderPidstringrequired
statusstringrequired
Possible values: [RECEIVED, REJECTED, ISSUED]
MOD2
Array [
@contextstring[]required
Example: ["https://w3id.org/dspace-dcp/v1.0/dcp.jsonld"]
typestringrequired
Example: CredentialStatus
issuerPidstringrequired
holderPidstringrequired
statusstringrequired
Possible values: [RECEIVED, REJECTED, ISSUED]
]
proof object[]required
Array [
typestringrequired
Possible values: [JsonWebSignature2020, DataIntegrityProof]
Example: JsonWebSignature2020
proofPurposestringrequired
Example: assertionMethod
]
selfIssuedbooleanrequired
If the credential is self issued
Example: true
revokedbooleanrequired
Indicates if the credential has been revoked
Example: false
statusListIndexnumber
Optional status list index
Example: 0
createdDatedate-timerequired
Creation timestamp
Example: 2023-10-01T00:00:00Z
modifiedDatedate-timerequired
Modification timestamp
Example: 2023-10-02T00:00:00Z
deletedDatedate-time
Optional deletion timestamp
Example: 2023-10-03T00:00:00Z

Example (auto)

{
  "id": "b86483f3-3792-4a54-b11e-f1c6face9935",
  "targetDid": "did:example:456",
  "credential": {
    "@context": [
      "https://www.w3.org/2018/credentials/v1"
    ],
    "type": [
      "VerifiableCredential",
      "DataSpaceCredential"
    ],
    "issuer": "did:example:issuer",
    "issuanceDate": "2023-10-01T00:00:00Z",
    "credentialSubject": {
      "id": "did:example:subject"
    }
  },
  "selfIssued": true,
  "revoked": false,
  "statusListIndex": 0,
  "createdDate": "2023-10-01T00:00:00Z",
  "modifiedDate": "2023-10-02T00:00:00Z",
  "deletedDate": "2023-10-03T00:00:00Z"
}

403

Forbidden

application/json

Schema

Schema

namestringrequired
Example: ResourceNotFound
statusstringrequired
Example: 404 Not Found
codenumberrequired
Example: 404
messageobject
Example: The requested resource does not exist.
errorstring
Example: Not Found

Example (auto)

{
  "name": "ResourceNotFound",
  "status": "404 Not Found",
  "code": 404,
  "message": "The requested resource does not exist.",
  "error": "Not Found"
}

• curl
• http

• CURL

curl -L 'https://tsg.dataspac.es/api/management/issuance/request/oid4vci' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
  "issuerUrl": "https://issuer.example.com",
  "preAuthorizedCode": "pre-auth-code-xyz",
  "authorized": {
    "accessToken": "access-token",
    "credentialIdentifier": "credential-type",
    "additionalRequestParams": {}
  }
}'

Request Collapse all

Body required

{
  "issuerUrl": "https://issuer.example.com",
  "preAuthorizedCode": "pre-auth-code-xyz",
  "authorized": {
    "accessToken": "access-token",
    "credentialIdentifier": "credential-type",
    "additionalRequestParams": {}
  }
}