Credentials
This endpoint sends a credential to a user based on their profileId
Authorizations
Path parameters
profileIdstringRequired
Body
credentialany ofRequired
or
or
Responses
200
Successful response
application/json
Responsestring
400
Invalid input data
application/json
401
Authorization not provided
application/json
403
Insufficient access
application/json
500
Internal server error
application/json
post
POST /api/credential/send/{profileId} HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 786
{
"credential": {
"@context": [
"text"
],
"id": "text",
"type": [
"text"
],
"issuer": "text",
"credentialSubject": {
"id": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"refreshService": {
"id": "text",
"type": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"credentialSchema": {
"id": "text",
"type": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"issuanceDate": "text",
"expirationDate": "text",
"credentialStatus": {
"type": "text",
"id": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"name": "text",
"description": "text",
"validFrom": "text",
"validUntil": "text",
"status": {
"type": "text",
"id": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"termsOfUse": {
"type": "text",
"id": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"evidence": {
"type": "text",
"id": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}
text
This endpoint accepts a credential
Authorizations
Body
uristringRequired
Responses
200
Successful response
application/json
Responseboolean
400
Invalid input data
application/json
401
Authorization not provided
application/json
403
Insufficient access
application/json
500
Internal server error
application/json
post
POST /api/credential/accept HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 51
{
"uri": "text",
"options": {
"skipNotification": false
}
}
true
This endpoint returns the current user's received credentials
Authorizations
Query parameters
limitinteger · max: 100OptionalDefault:
25
fromstringOptional
Responses
200
Successful response
application/json
400
Invalid input data
application/json
401
Authorization not provided
application/json
403
Insufficient access
application/json
404
Not found
application/json
500
Internal server error
application/json
get
GET /api/credentials/received HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"uri": "text",
"to": "text",
"from": "text",
"sent": "2025-07-04T00:23:32.740Z",
"received": "2025-07-04T00:23:32.740Z"
}
]
This endpoint returns the current user's sent credentials
Authorizations
Query parameters
limitinteger · max: 100OptionalDefault:
25
tostringOptional
Responses
200
Successful response
application/json
400
Invalid input data
application/json
401
Authorization not provided
application/json
403
Insufficient access
application/json
404
Not found
application/json
500
Internal server error
application/json
get
GET /api/credentials/sent HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"uri": "text",
"to": "text",
"from": "text",
"sent": "2025-07-04T00:23:32.740Z",
"received": "2025-07-04T00:23:32.740Z"
}
]
This endpoint returns the current user's incoming credentials
Authorizations
Query parameters
limitinteger · max: 100OptionalDefault:
25
fromstringOptional
Responses
200
Successful response
application/json
400
Invalid input data
application/json
401
Authorization not provided
application/json
403
Insufficient access
application/json
404
Not found
application/json
500
Internal server error
application/json
get
GET /api/credentials/incoming HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"uri": "text",
"to": "text",
"from": "text",
"sent": "2025-07-04T00:23:32.740Z",
"received": "2025-07-04T00:23:32.740Z"
}
]
This endpoint deletes a credential
Authorizations
Query parameters
uristringRequired
Responses
200
Successful response
application/json
Responseboolean
400
Invalid input data
application/json
401
Authorization not provided
application/json
403
Insufficient access
application/json
404
Not found
application/json
500
Internal server error
application/json
delete
DELETE /api/credential?uri=text HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
true
Was this helpful?