Verifiable Credential

Import credential

post

Import an existing credential from a known format into a Wallet.

Depending on how key binding is performed, the import process associates the credential with the given did and/or kid if managed by the wallet:

• did: The DID used for binding a DID to the credential.

• kid: The key ID used for binding the key to the credential.

If the did or kid is not managed by the wallet, fields are ignored. They can later be updated with PATCH /wallets/{walletId}/credentials/{credentialId}.

Authorizations

bearerAuthmutualTLS

AuthorizationstringOptional

Bearer authentication header of the form Bearer <token>.

Path parameters

walletIdstringRequired

Body

application/json

credentialstringRequired

The encoded string representation of the credential to be imported.

For jwt_vc_json and dc+sd-jwt credential formats, the string is expected to be a compact JWT.

For mso_mdoc the expected string value is the base64url-encoded representation of the CBOR-encoded IssuerSigned structure, as defined in [ISO.18013-5] Supports the following docTypes:

• org.iso.18013.5.mDL

Example: LUpixVCWJk0eOt4CXQe1NXK....WZwmhmn9OQp6YxX0a2L

formatstring · enumOptional

Credential format identifier. When not provided, credential will be assumed to be a compact JWT.

Possible values:

Responses

201

Credential imported

application/json

400Error

application/json

404Error

application/json

post/wallets/{walletId}/credentials/import

HTTPcURLJavaScriptPython

POST /wallets/{walletId}/credentials/import HTTP/1.1
Host: zyfla-wallet-sandbox.meeco.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 210

{
  "credential": "LUpixVCWJk0eOt4CXQe1NXK....WZwmhmn9OQp6YxX0a2L",
  "format": "dc+sd-jwt",
  "meta": {
    "did": "did:key:z6MkipmTzRNjTHKujEEAhG5JR5zHd578uUYNTnWaYMALRDUs",
    "kid": "lA5y6IC-aLCpHtf-NytvSbYGZWqAfbrgAoGn3F3l0NI"
  }
}

{
  "credential": {
    "created_at": "2024-01-09T12:00:00Z",
    "credential": "LUpixVCWJk0eOt4CXQe1NXK....WZwmhmn9OQp6YxX0a2L",
    "format": "dc+sd-jwt",
    "id": "urn:uuid:df9a133c-0fca-4db1-8892-2f881aa44109",
    "meta": {
      "claims": {
        "ANY_ADDITIONAL_PROPERTY": {
          "display": [
            {
              "locale": "text",
              "name": "text"
            }
          ],
          "mandatory": true
        }
      },
      "order": [
        "text"
      ],
      "credential_definition": {
        "credentialSubject": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "type": [
          "text"
        ]
      },
      "did": "did:key:z6MkipmTzRNjTHKujEEAhG5JR5zHd578uUYNTnWaYMALRDUs",
      "display": [
        {
          "name": "text",
          "locale": "text",
          "background_color": "text",
          "text_color": "text",
          "logo": {
            "alt_text": "text",
            "uri": "https://example.com"
          }
        }
      ],
      "issuer_display": [
        {
          "locale": "text",
          "name": "text"
        }
      ],
      "kid": "lA5y6IC-aLCpHtf-NytvSbYGZWqAfbrgAoGn3F3l0NI",
      "vct": "text",
      "doctype": "text"
    }
  }
}

Get credentials

get

Fetch a paginated list of credentials stored inside the Wallet.

Authorizations

bearerAuthmutualTLS

AuthorizationstringOptional

Bearer authentication header of the form Bearer <token>.

Path parameters

walletIdstringRequired

Query parameters

orderstring · enumOptional

Issuance state response order. Default ordering: DESC (Supported: ASC, DESC)

Example: DESCPossible values:

order_bystring · enumOptional

Order Issuance state by an attribute, defaults to: created_at (Supported: created_at)

Example: created_atPossible values:

per_pageinteger · min: 1 · max: 50Optional

Number of records per page

Example: 10

pageinteger · min: 1Optional

Page number (starting from 1)

Example: 1

Responses

200

Wallet credentials successfully loaded

application/json

400Error

application/json

404Error

application/json

500Error

application/json

get/wallets/{walletId}/credentials

HTTPcURLJavaScriptPython

GET /wallets/{walletId}/credentials HTTP/1.1
Host: zyfla-wallet-sandbox.meeco.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "credentials": [
    {
      "created_at": "2024-01-09T12:00:00Z",
      "credential": "LUpixVCWJk0eOt4CXQe1NXK....WZwmhmn9OQp6YxX0a2L",
      "format": "dc+sd-jwt",
      "id": "urn:uuid:df9a133c-0fca-4db1-8892-2f881aa44109",
      "meta": {
        "claims": {
          "ANY_ADDITIONAL_PROPERTY": {
            "display": [
              {
                "locale": "text",
                "name": "text"
              }
            ],
            "mandatory": true
          }
        },
        "order": [
          "text"
        ],
        "credential_definition": {
          "credentialSubject": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "type": [
            "text"
          ]
        },
        "did": "did:key:z6MkipmTzRNjTHKujEEAhG5JR5zHd578uUYNTnWaYMALRDUs",
        "display": [
          {
            "name": "text",
            "locale": "text",
            "background_color": "text",
            "text_color": "text",
            "logo": {
              "alt_text": "text",
              "uri": "https://example.com"
            }
          }
        ],
        "issuer_display": [
          {
            "locale": "text",
            "name": "text"
          }
        ],
        "kid": "lA5y6IC-aLCpHtf-NytvSbYGZWqAfbrgAoGn3F3l0NI",
        "vct": "text",
        "doctype": "text"
      }
    }
  ],
  "meta": {
    "order": "asc",
    "per_page": 20
  }
}

Get credential by ID

get

Fetch credential information by ID stored inside the Wallet

Authorizations

bearerAuthmutualTLS

AuthorizationstringOptional

Bearer authentication header of the form Bearer <token>.

Path parameters

walletIdstringRequired

vcIdstringRequired

Responses

200

Wallet credential by ID successfully loaded

application/json

400Error

application/json

404Error

application/json

500Error

application/json

get/wallets/{walletId}/credentials/{vcId}

HTTPcURLJavaScriptPython

GET /wallets/{walletId}/credentials/{vcId} HTTP/1.1
Host: zyfla-wallet-sandbox.meeco.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "credential": {
    "created_at": "2024-01-09T12:00:00Z",
    "credential": "LUpixVCWJk0eOt4CXQe1NXK....WZwmhmn9OQp6YxX0a2L",
    "format": "dc+sd-jwt",
    "id": "urn:uuid:df9a133c-0fca-4db1-8892-2f881aa44109",
    "meta": {
      "claims": {
        "ANY_ADDITIONAL_PROPERTY": {
          "display": [
            {
              "locale": "text",
              "name": "text"
            }
          ],
          "mandatory": true
        }
      },
      "order": [
        "text"
      ],
      "credential_definition": {
        "credentialSubject": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "type": [
          "text"
        ]
      },
      "did": "did:key:z6MkipmTzRNjTHKujEEAhG5JR5zHd578uUYNTnWaYMALRDUs",
      "display": [
        {
          "name": "text",
          "locale": "text",
          "background_color": "text",
          "text_color": "text",
          "logo": {
            "alt_text": "text",
            "uri": "https://example.com"
          }
        }
      ],
      "issuer_display": [
        {
          "locale": "text",
          "name": "text"
        }
      ],
      "kid": "lA5y6IC-aLCpHtf-NytvSbYGZWqAfbrgAoGn3F3l0NI",
      "vct": "text",
      "doctype": "text"
    }
  }
}

Delete credential by ID

delete

Deletes credential by ID stored inside the Wallet

Authorizations

bearerAuthmutualTLS

AuthorizationstringOptional

Bearer authentication header of the form Bearer <token>.

Path parameters

walletIdstringRequired

vcIdstringRequired

Responses

204

Wallet credential by ID successfuly removed

No content

400Error

application/json

404Error

application/json

500Error

application/json

delete/wallets/{walletId}/credentials/{vcId}

HTTPcURLJavaScriptPython

DELETE /wallets/{walletId}/credentials/{vcId} HTTP/1.1
Host: zyfla-wallet-sandbox.meeco.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Patch credential by ID

patch

Patches credential stored inside a Wallet.

Used to update did and kid fields in the meta data of the credential. Note that the did and kid need to reference an existing DID and Key Id. This is used to associate an (existing) Key and/or DID controlled by the wallet with the credential to make it easier to reference that Key and/or DID when presenting credentials for example.

Authorizations

bearerAuthmutualTLS

AuthorizationstringOptional

Bearer authentication header of the form Bearer <token>.

Path parameters

walletIdstringRequired

vcIdstringRequired

Body

application/json

Responses

204

Wallet credential successfully patched

No content

404

Not found

application/json

500Error

application/json

patch/wallets/{walletId}/credentials/{vcId}

HTTPcURLJavaScriptPython

PATCH /wallets/{walletId}/credentials/{vcId} HTTP/1.1
Host: zyfla-wallet-sandbox.meeco.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 127

{
  "meta": {
    "did": "did:key:z6MkipmTzRNjTHKujEEAhG5JR5zHd578uUYNTnWaYMALRDUs",
    "kid": "lA5y6IC-aLCpHtf-NytvSbYGZWqAfbrgAoGn3F3l0NI"
  }
}

No content

Verify credential by ID

get

Verify a credential by ID stored inside the Wallet. The verification process checks the validity of the credential and returns a list of errors and warnings if any.

Checks performed:

• format.

• signature.

• expiration date is validated when the expirationDate attribute is present.

• issued at date is validated when the iat attribute is present.

• The dc+sd-jwt format also supports URL instead of DID as the value for the issuer attribute. URL will be used to construct .well-known endpoint to retrieve the public key.

• Verifiable credential schema if present.

• Verifiable credential revocation list status and its validity if present

  Credential schema and revocation status related checks are not considered critical and will be returned under warnings attribute. It is up for the client application to decide how these should be handled. All other failed checks will be served under errors attribute.

  Verification options

  You can optionally specify checks for the provided credential. If specified, only these checks will run. By default, format, signature, expiration checks are mandatory and can not be taken out from checks list. No further checks will be performed if credential is imposible to parse.

  GET wallets/{walletId}/credentials/{vcId}/verify?checks=format,signature,expiration,revocation_status

  failed_to_verify_jwt and failed_to_verify_mso_mdoc error might appear in both: errors and warnings list. In case of dc+sd-jwt it wraps any error that @meeco/sd-jwt-vc might throw. In case of jwt_vc_json it wraps any error that did-jwt-vc might throw. In case of mso_mdoc it wraps any error that @owf/mdoc might report.

Authorizations

bearerAuthmutualTLS

AuthorizationstringOptional

Bearer authentication header of the form Bearer <token>.

Path parameters

walletIdstringRequired

vcIdstringRequired

Query parameters

Responses

200

Credential verification complete

application/json

idstringRequired

400Error

application/json

404Error

application/json

500Error

application/json

get/wallets/{walletId}/credentials/{vcId}/verify

HTTPcURLJavaScriptPython

GET /wallets/{walletId}/credentials/{vcId}/verify HTTP/1.1
Host: zyfla-wallet-sandbox.meeco.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "checks": [
    "format"
  ],
  "errors": [
    {
      "error": "text",
      "extra_info": {},
      "message": "text"
    }
  ],
  "id": "text",
  "warnings": [
    {
      "error": "text",
      "extra_info": {},
      "message": "text"
    }
  ]
}