Sign a JSON credential

POST/v2/credentials/web-semantic/sign

Returns a signed JSON credential generated from a provided valid payload.

Analytic events

CREDENTIAL_WEB_SEMANTIC_SIGN_START
CREDENTIAL_WEB_SEMANTIC_SIGN_SUCCESS
CREDENTIAL_WEB_SEMANTIC_SIGN_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

JSON credential payload to sign

TypeScript Definitions

Use the request body type in TypeScript.

Sign JSON credential request

payload*

proofType?string

This is an optional field which defines the cryptographic algorithm used to sign the credential. The credential Issuer's DID must contain a key that supports the corresponding signing capability. If no proofType is provided, the credential will be signed using the key that is available in the Issuer's DID:

If a Bls12381G2 key is available, the credential will be signed with a BbsSignature2022 proof. Credentials signed with this proof type support selective disclosure.
If a Bls12381G2 key is unavailable but a Ed25519 key is available, the credential will be signed with a Ed25519Signature2018 proof. Credentials signed with this proof type do not support selective disclosure.
If none of the two suitable keys are available, the request will be rejected and the credential will not be created.

Value in

"Ed25519Signature2018"
"BbsSignature2022"

tag?string

Insert a case sensitive tag to reference this credential. The gets stored as part of the credential metadata and can be used to search for it in the credential registry.

Length1 <= length <= 1024

persist?boolean

When set to true, both the credential and the credential metadata are stored in the credential registry. When set to false, only the following metadata is stored in the credential registry:

id
tag
credentialStatus
issuanceDate

Defaultfalse

revocable?boolean

When set to true, the created credential can later be revoked. When set to false, the credential cannot be revoked. When set to true, https://w3id.org/vc-revocation-list-2020/v1 is injected into the credential @context object when it is issued. This references the JSON-LD definition of the credentialStatus object.

Defaultfalse

Response Body

`application/json`

curl -X POST "https://example.com/v2/credentials/web-semantic/sign" \  -H "Content-Type: application/json" \  -d '{    "payload": {      "type": [        "string"      ],      "credentialSubject": {},      "issuer": {        "id": "string",        "name": "string"      }    }  }'

{  "id": "string",  "credential": {    "@context": [      "string"    ],    "type": [      "string"    ],    "issuer": "string",    "issuanceDate": "2019-08-24T14:15:22Z",    "credentialStatus": {      "id": "string",      "type": "string",      "revocationListIndex": 0,      "revocationListCredential": "string"    },    "credentialSubject": {      "givenName": "string",      "familyName": "string",      "alumniOf": "string"    },    "proof": {      "type": "string",      "created": "2019-08-24T14:15:22Z",      "jws": "string",      "proofPurpose": "string",      "verificationMethod": "string"    },    "name": "string",    "description": "string"  },  "tag": "string",  "credentialStatus": {    "id": "string",    "type": "string",    "revocationListIndex": 0,    "revocationListCredential": "string"  },  "issuanceDate": "string"}

Sign a JSON credential

Roles

Analytics Events

Analytic events

Authorization

Request Body

Response Body

`application/json`

`application/json`

Sign a JSON credential

Roles

Analytics Events

Analytic events

Authorization

Request Body

Response Body

200application/json

400application/json

`application/json`

`application/json`