Skip to content

Issuer create a credential offer

POST
/orgs/{orgId}/credentials/offer

Issuer creates a credential offer and sends it to the holder

Authorizations

Parameters

Path Parameters

orgId
required
string

Query Parameters

credentialType
required
string
Allowed values: jsonld indy

Request Body required

object
credentialDefinitionId
required
string
string
comment
required
string
string
protocolVersion
string
v1
goalCode
string
parentThreadId
string
willConfirm
boolean
label
string
imageUrl
string
autoAcceptCredential
string
credentialType
required
object
jsonld
reuseConnection
boolean
default: true
credentialData
required
Array<string>
[
{
"connectionId": "string",
"attributes": [
{
"value": "string",
"name": "string"
}
],
"credential": {
"@context": [
"https://www.w3.org/2018/credentials/v1",
"https://www.w3.org/2018/credentials/examples/v1"
],
"type": [
"VerifiableCredential",
"UniversityDegreeCredential"
],
"issuer": {
"id": "did:key:z6Mkn72LVp3mq1fWSefkSMh5V7qrmGfCV4KH3K6SoTM21ouM"
},
"issuanceDate": "2019-10-12T07:20:50.52Z",
"credentialSubject": {
"id": "did:key:z6Mkn72LVp3mq1fWSefkSMh5V7qrmGfCV4KH3K6SoTM21ouM",
"degree": {
"type": "BachelorDegree",
"name": "Bachelor of Science and Arts"
}
}
},
"options": {
"proofType": "Ed25519Signature2018",
"proofPurpose": "assertionMethod"
}
}
]
isShortenUrl
required
boolean

Responses

201

Created

object
message
required
string
Success
success
required
boolean
data
required
object
statusCode
required
number
200

401

Unauthorized

object
statusCode
required
number
401
error
required
string
Unauthorized

403

Forbidden

object
statusCode
required
number
403
error
required
string
Forbidden