Credentials

Send a Credential

post

This endpoint sends a credential to a user based on their profileId

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

profileIdstringRequired

Body

application/json

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

/credential/send/{profileId}

HTTPcURLJavaScriptPython

POST /api/credential/send/{profileId} HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 925

{
  "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": {
      "id": "text",
      "type": [
        "text"
      ],
      "name": "text",
      "narrative": "text",
      "description": "text",
      "genre": "text",
      "audience": "text",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

text

Accept a Credential

post

This endpoint accepts a credential

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

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

/credential/accept

HTTPcURLJavaScriptPython

POST /api/credential/accept HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 101

{
  "uri": "text",
  "options": {
    "skipNotification": false,
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
}

true

Get received credentials

get

This endpoint returns the current user's received credentials

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

limitintegerOptionalDefault: 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

/credentials/received

HTTPcURLJavaScriptPython

GET /api/credentials/received HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "uri": "text",
    "to": "text",
    "from": "text",
    "sent": "2025-12-21T04:41:25.850Z",
    "received": "2025-12-21T04:41:25.850Z",
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
]

Get sent credentials

get

This endpoint returns the current user's sent credentials

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

limitintegerOptionalDefault: 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

/credentials/sent

HTTPcURLJavaScriptPython

GET /api/credentials/sent HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "uri": "text",
    "to": "text",
    "from": "text",
    "sent": "2025-12-21T04:41:25.850Z",
    "received": "2025-12-21T04:41:25.850Z",
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
]

Get incoming credentials

get

This endpoint returns the current user's incoming credentials

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

limitintegerOptionalDefault: 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

/credentials/incoming

HTTPcURLJavaScriptPython

GET /api/credentials/incoming HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "uri": "text",
    "to": "text",
    "from": "text",
    "sent": "2025-12-21T04:41:25.850Z",
    "received": "2025-12-21T04:41:25.850Z",
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
]

Delete a credential

delete

This endpoint deletes a credential

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

/credential

HTTPcURLJavaScriptPython

DELETE /api/credential?uri=text HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true