Request compliance credential

POST 
/api/management/credentials/gaiax/compliance

Request a compliance credential from a Gaia-X Digital Clearing House based on existing credentials within this wallet

Request

application/json

Body

required

vcIdstringrequired
clearingHousestringrequired

credentials

object[]required

Array [

@contextstring[]required

typestring[]required

idstring

credentialSubject

object

required

oneOf

DefaultCredentialSubjectDto

idstringrequired

MOD2

Array [

idstringrequired

]

issuerstringrequired

expirationDatedate-time

issuanceDatedate-timerequired

evidenceobject

proof

object

required

typestringrequired

createddate-timerequired

proofPurposestringrequired

jwsstringrequired

verificationMethodstringrequired

]

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

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": {},
    "proof": {
      "type": "string",
      "created": "2024-07-29T15:51:28.071Z",
      "proofPurpose": "string",
      "jws": "string",
      "verificationMethod": "string"
    }
  },
  "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"
}