Skip to content

Create out-of-band credential offer

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

Creates an out-of-band credential offer

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
attributes
required
Array<string>
[
{
"value": "string",
"name": "string"
}
]
isShortenUrl
required
boolean
credential
required
object
@context
required
Array<string>
type
required
Array<string>
id
required
string
issuer
required
object
id
required
object
issuanceDate
required
string
prettyVc
object
certificate
string
size
string
a4
orientation
string
landscape
expirationDate
required
string
credentialSubject
required
object
options
required
object

Responses

201

Success

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