Programmatically Issue a Credential
General steps to implement based on events in applications and onchain
Programmatically Issue Verifiable Credentials (VCs)
Issue Verifiable Credentials (VCs) programmatically when certain events occur, such as when a user completes specific actions, swaps a token, completes a level in a game, or mints an NFT. VCs can be issued to a user's ETH address or DID. The options are endless and only bound by your imagination!
Prerequisite
Generate a did:web to ensure credentials are signed with keys that you control
How it works
Select event(s) that will result in credential issuance
Leverage our API endpoint and set up logic in your platform to issue credentials
Determine conditions for issuing credentials to a users
Send POST requests to the API to issue the credentials
User receives credentials
API Endpoint
Generate and return a signed Credential. This will also write the Credential the recipient's data backpack in Disco's Verifiable Data Registry. The JSON body should contain required Credential values for the schema type used. Available schemas and their specifications can be found at https://github.com/discoxyz/disco-schemas.
The URL of the verifiable crednetial schema. Available schemas can be found at https://github.com/discoxyz/disco-schemas
https://raw.githubusercontent.com/discoxyz/disco-schemas/main/json/MembershipCredential/1-0-0.json
The DID address of the credential's claimant
did:3:Example987xyz
The fields and values for the credential (based on its schema)
{ "memberId": "Goldstar Member", "membershipDescription": "Demo membership to showcase Disco API", "membershipLevel": "Permanent", "membershipType": "Developer", "organization": "Disco.xyz" }
The date for the credential to expire for the claimant. Leave empty if there's no expiration.
Optional - supported values are "JWT" and "712".
The DID address of the credential's issuer.
did:web:api.disco.xyz/v1/disco
To sign or not to sign - hint you should sign! Either leave out or assign false.
false
POST /v1/credential HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 499
{
"schemaUrl": "https://raw.githubusercontent.com/discoxyz/disco-schemas/main/json/MembershipCredential/1-0-0.json",
"recipientDID": "did:3:Example987xyz",
"subjectData": "{\n \"memberId\": \"Goldstar Member\",\n \"membershipDescription\": \"Demo membership to showcase Disco API\",\n \"membershipLevel\": \"Permanent\",\n \"membershipType\": \"Developer\",\n \"organization\": \"Disco.xyz\"\n }",
"expirationDate": "",
"suite": "",
"issuer": "did:web:api.disco.xyz/v1/disco",
"skipSign": "false"
}
{
"_id": "text",
"vc": "See https://www.w3.org/TR/vc-data-model/#example-a-simple-example-of-a-verifiable-credential",
"jwt": "eyJhbGciOiJIUzI1N........",
"isPublic": "true",
"issuer": "",
"recipient": "text",
"subject": "text",
"schema": "https://raw.githubusercontent.com/discoxyz/disco-schemas/main/json/MembershipCredential/1-0-0.json",
"genId": "text",
"updatedAt": "text",
"isDeleted": true,
"history": []
}
Usage example
curl --location 'https://api.disco.xyz/v1/credential' \
--header 'Content-Type: application/json' \
--header 'Accept: */*' \
--header 'Authorization: Bearer <your Disco API key>' \
--data '{
"issuer": "did:3:123abcexample",
"schemaUrl": "https://raw.githubusercontent.com/discoxyz/disco-schemas/main/json/MembershipCredential/1-0-0.json",
"recipientDID": "did:3:456defexample",
"subjectData": {
"memberId": "123XYZ",
"membershipDescription": "Demo membership to showcase Disco API",
"membershipLevel": "Permanent",
"membershipType": "Developer",
"organization": "Disco.xyz"
},
"expirationDate": ""
}'
Last updated