Skip to content
CREDEBL Logo CREDEBL Docs

Creates a out-of-band credential offer and sends them via emails

POST
/orgs/{orgId}/credentials/oob/email

Issuer creates a out-of-band credential offers and sends them to holders via emails

Authorizations

Parameters

Path Parameters

orgId
required
string

Query Parameters

credentialType
required
string
Allowed values: jsonld indy

Request Body required

object
credentialOffer
required
Array<string>
[
  {
    "emailId": "xyz@example.com",
    "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"
    }
  }
]
credentialDefinitionId
required
string
string
comment
required
string
string
protocolVersion
required
string
v1
credentialType
required
object 
jsonld
isReuseConnection
boolean
default: true

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