Credentials

Endpoints for issuing and retrieving credentials

Issue JSON-LD credentials

post

This endpoint issues JSON-LD credentials.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Query parameters

timeoutintegerOptional

The timeout for the credential issuance (seconds).

Example: 30

Body

application/json

invitation_idnumber · nullableOptional

The invitation ID.

Example: 1

contact_idstring · nullableOptional

The contact ID.

revocation_def_idstring · nullableOptional

The ID of status list definition to enable revocation

proofTypestringOptional

The proofType for the credential issuance

Example: Ed25519Signature2020

rulestringOptional

The rule for the credential issuance.

Example: string

Responses

200

JSON-LD credential issued successfully

application/json

recordobjectOptional

400

Bad Request

application/json

401

Unauthorized.

422

Unprocessable Entity.

application/json

500

Internal Server Error

application/json

post

/api/v1/credentials/json-ld

HTTPcURLJavaScriptPython

POST /api/v1/credentials/json-ld HTTP/1.1
Host: proven-4-2-test.proven.indicio.tech
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1251

{
  "invitation_id": 1,
  "contact_id": "",
  "revocation_def_id": "",
  "credential": {
    "@context": [
      "https://purl.imsglobal.org/spec/ob/v3p0/context-3.0.3.json",
      "https://www.w3.org/ns/credentials/status/v1"
    ],
    "issuanceDate": "2024-11-29T21:07:11Z",
    "validFrom": "2024-11-29T11:34:20Z",
    "awardedDate": "2024-11-29T21:07:11Z",
    "expirationDate": "2030-11-29T11:34:20Z",
    "validUntil": "2030-11-29T11:34:20Z",
    "type": [
      "OpenBadgeCredential"
    ],
    "description": "Awesome Credential Description",
    "name": "New Awesome JSON-LD Credential",
    "issuer": {
      "id": "did:indy:<namespace>:5uF3EGLPkBccqMhEfX2JS8",
      "type": [
        "Profile"
      ],
      "name": "Awesome Issuer Name",
      "description": "An awesome Issuer who Issues awesome credentials.",
      "url": "https://www.awesome-issuer-url.com",
      "email": "[email protected]",
      "image": {
        "id": "https://www.awesome-issuer-url.com/images/issuer-logo.png",
        "type": "Image",
        "caption": "Awesome Issuer Logo"
      }
    },
    "credentialSubject": {
      "type": [
        "AchievementSubject"
      ],
      "achievement": {
        "id": "https://example.org/achievements/degree",
        "name": "Your name",
        "description": "Your description",
        "criteria": {
          "type": "Criteria",
          "narrative": "Your narrative"
        },
        "image": {
          "id": "https://example.org/achievements/image.png",
          "type": "Image"
        },
        "type": [
          "Achievement"
        ]
      }
    }
  },
  "proofType": "Ed25519Signature2020",
  "rule": "string"
}

JSON-LD issuance with revocation disabledJSON-LD issuance with revocation enabled

{
  "request_id": 1,
  "connection_id": "1c50d6e1-5a43-48d8-837e-be3cbc815469",
  "contact_id": "",
  "invitation_id": 1,
  "credential": {
    "name": "New Awesome JSON-LD Credential",
    "type": [
      "OpenBadgeCredential"
    ],
    "issuer": {
      "id": "did:indy:<namespace>:5uF3EGLPkBccqMhEfX2JS8",
      "url": "https://www.awesome-issuer-url.com",
      "name": "Awesome Issuer Name",
      "type": [
        "Profile"
      ],
      "email": "[email protected]",
      "image": {
        "id": "https://www.awesome-issuer-url.com/images/issuer-logo.png",
        "type": "Image",
        "caption": "Awesome Issuer Logo"
      },
      "description": "An awesome Issuer who Issues awesome credentials."
    },
    "@context": [
      "https://purl.imsglobal.org/spec/ob/v3p0/context-3.0.3.json",
      "https://www.w3.org/ns/credentials/status/v1"
    ],
    "validFrom": "2024-11-29T11:34:20Z",
    "validUntil": "2030-11-29T11:34:20Z",
    "awardedDate": "2024-11-29T21:07:11Z",
    "description": "Awesome Credential Description",
    "issuanceDate": "2024-11-29T21:07:11Z",
    "expirationDate": "2030-11-29T11:34:20Z",
    "credentialSubject": {
      "type": [
        "AchievementSubject"
      ],
      "achievement": {
        "id": "https://example.org/achievements/degree",
        "name": "Your name",
        "type": [
          "Achievement"
        ],
        "image": {
          "id": "https://example.org/achievements/image.png",
          "type": "Image"
        },
        "criteria": {
          "type": "Criteria",
          "narrative": "Your narrative"
        },
        "description": "Your description"
      }
    },
    "rule": "string",
    "wallet_id": "19fa3524-2859-43e2-ac48-2136c9d8a199",
    "meta_data": null,
    "state": "offer-sent",
    "complete": false,
    "result": false,
    "result_string": "Pending",
    "credential_exchange_id": [
      "885b1487-479a-4071-8585-12580b1b0db1"
    ],
    "error": "",
    "proof_type": "Ed25519Signature2020",
    "created_at": "2025-07-09T19:28:02.633Z",
    "updated_at": "2025-07-09T19:28:04.774Z",
    "credential_status": {
      "id": "https://example.com/jsonld-status-list/tenants/19fa3524-2859-43e2-ac48-2136c9d8a199/w3c/status/0#81407",
      "type": "BitstringStatusListEntry",
      "statusPurpose": "revocation",
      "statusListIndex": 81407,
      "statusListCredential": "https://example.com/jsonld-status-list/tenants/19fa3524-2859-43e2-ac48-2136c9d8a199/w3c/status/0"
    }
  }
}

Retrieve a JSON-LD credential by ID

get

This endpoint retrieves a JSON-LD credential by its ID using the provided API key.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Path parameters

request_idstringRequired

The ID of the credential.

Example: 1

Responses

200

JSON-LD credential retrieved successfully

application/json

recordobjectOptional

The retrieved JSON-LD credential record.

400

Bad Request

application/json

401

Unauthorized.

404

JSON-LD credential record not found

application/json

500

Internal Server Error

application/json

get

/api/v1/credentials/json-ld/{request_id}

HTTPcURLJavaScriptPython

GET /api/v1/credentials/json-ld/{request_id} HTTP/1.1
Host: proven-4-2-test.proven.indicio.tech
x-api-key: YOUR_API_KEY
Accept: */*

{
  "request_id": 1,
  "connection_id": "1c50d6e1-5a43-48d8-837e-be3cbc815469",
  "contact_id": "",
  "invitation_id": 1,
  "credential": {
    "name": "New Awesome JSON-LD Credential",
    "type": [
      "OpenBadgeCredential"
    ],
    "issuer": {
      "id": "did:indy:<namespace>:5uF3EGLPkBccqMhEfX2JS8",
      "url": "https://www.awesome-issuer-url.com",
      "name": "Awesome Issuer Name",
      "type": [
        "Profile"
      ],
      "email": "[email protected]",
      "image": {
        "id": "https://www.awesome-issuer-url.com/images/issuer-logo.png",
        "type": "Image",
        "caption": "Awesome Issuer Logo"
      },
      "description": "An awesome Issuer who Issues awesome credentials."
    },
    "@context": [
      "https://purl.imsglobal.org/spec/ob/v3p0/context-3.0.3.json",
      "https://www.w3.org/ns/credentials/status/v1"
    ],
    "validFrom": "2024-11-29T11:34:20Z",
    "validUntil": "2030-11-29T11:34:20Z",
    "awardedDate": "2024-11-29T21:07:11Z",
    "description": "Awesome Credential Description",
    "issuanceDate": "2024-11-29T21:07:11Z",
    "expirationDate": "2030-11-29T11:34:20Z",
    "credentialSubject": {
      "type": [
        "AchievementSubject"
      ],
      "achievement": {
        "id": "https://example.org/achievements/degree",
        "name": "Your name",
        "type": [
          "Achievement"
        ],
        "image": {
          "id": "https://example.org/achievements/image.png",
          "type": "Image"
        },
        "criteria": {
          "type": "Criteria",
          "narrative": "Your narrative"
        },
        "description": "Your description"
      }
    }
  },
  "rule": "string",
  "wallet_id": "19fa3524-2859-43e2-ac48-2136c9d8a199",
  "meta_data": null,
  "state": "offer-sent",
  "complete": false,
  "result": false,
  "result_string": "Pending",
  "credential_exchange_id": [
    "885b1487-479a-4071-8585-12580b1b0db1"
  ],
  "error": "",
  "proof_type": "Ed25519Signature2020",
  "created_at": "2025-07-09T19:28:02.633Z",
  "updated_at": "2025-07-09T19:28:04.774Z",
  "credential_status": {
    "id": "https://example.com/jsonld-status-list/tenants/19fa3524-2859-43e2-ac48-2136c9d8a199/w3c/status/0#81407",
    "type": "BitstringStatusListEntry",
    "statusPurpose": "revocation",
    "statusListIndex": 81407,
    "statusListCredential": "https://example.com/jsonld-status-list/tenants/19fa3524-2859-43e2-ac48-2136c9d8a199/w3c/status/0"
  }
}

Retrieve all credentials

get

This endpoint retrieves all credentials associated with the provided API.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Query parameters

sort-fieldstringOptional

The field to sort by (default updated_at).

sort-directionstringOptional

The direction to sort (ASC or DESC, default DESC).

page-sizeintegerOptional

The number of credentials per page (default 20).

current-pageintegerOptional

The current page number (default 1).

item-countintegerOptional

The total number of items.

state-filterstringOptional

If provided, returns only credentials with this state.

contact-idstringOptional

If provided, returns only credentials for this contact_id.

Responses

200

A paginated list of credentials

application/json

rowsobject[]Optional

countintegerOptional

401

Unauthorized.

500

Internal Server Error

application/json

get

/api/v1/credentials

HTTPcURLJavaScriptPython

GET /api/v1/credentials HTTP/1.1
Host: proven-4-2-test.proven.indicio.tech
x-api-key: YOUR_API_KEY
Accept: */*

{
  "params": {
    "sort": [
      [
        "created_at",
        "DESC"
      ]
    ],
    "pageSize": 20,
    "currentPage": 1,
    "pageCount": 1,
    "itemCount": 1,
    "stateFilter": null,
    "contactIdFilter": null
  },
  "rows": [
    {
      "credential_exchange_id": "02189932-52ac-4f9d-bf84-1fcfb7c67fa1",
      "wallet_id": "6b4ae41c-9c8a-49fd-9efa-fa0436d40b5c",
      "credential_id": null,
      "revocation_id": null,
      "connection_id": "0ecc0b3c-4d15-4660-b8da-15d0feeded59",
      "state": "offer-sent",
      "thread_id": "73d4b64f-f570-4970-9603-3381ed9cd440",
      "parent_thread_id": null,
      "schema_id": "E8BS9Fcg3cu2m9Dwaa3hVG:2:Email:1.0",
      "credential_definition_id": "Efgh86CGr29yoQKXHQraHD:3:CL:151:default",
      "revoc_reg_id": null,
      "revoked": null,
      "created_at": "2025-06-26T22:01:05.543Z",
      "updated_at": "2025-06-26T22:01:05.543Z",
      "attributes": null
    }
  ],
  "count": 1
}

Issue a new AnonCred credential

post

This endpoint allows you to add a new credential request.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Query parameters

timeoutintegerOptional

The timeout for the credential issuance (seconds).

Example: 30

Body

application/json

invitation_idintegerOptional

The ID of the invitation.

contact_idstringOptional

The ID of the contact.

schema_idstringOptional

The ID of the schema.

rulestringOptional

The rule for the credential issuance.

Responses

200

AnonCred credential issuance record was created

application/json

recordobjectOptional

400

Bad Request

application/json

401

Unauthorized.

422

Unprocessable Entity.

application/json

500

Internal Server Error

application/json

post

/api/v1/credentials

HTTPcURLJavaScriptPython

POST /api/v1/credentials HTTP/1.1
Host: proven-4-2-test.proven.indicio.tech
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 285

{
  "invitation_id": 1,
  "contact_id": "",
  "schema_id": "E8BS9Fcg3cu2m9Dwaa3hVG:2:Email:1.0",
  "attributes": [
    {
      "name": "local_part",
      "value": "timmy"
    },
    {
      "name": "domain",
      "value": "example.com"
    },
    {
      "name": "address",
      "value": "[email protected]"
    },
    {
      "name": "verified_at",
      "value": "1670296277"
    }
  ],
  "rule": "no rule"
}

{
  "request_id": 1,
  "connection_id": "bd8d1663-38ac-46c8-9314-7d26bf731c88",
  "contact_id": "",
  "invitation_id": 1,
  "schema_id": "E8BS9Fcg3cu2m9Dwaa3hVG:2:Email:1.0",
  "attributes": [
    {
      "name": "local_part",
      "value": "timmy"
    },
    {
      "name": "domain",
      "value": "example.com"
    },
    {
      "name": "address",
      "value": "[email protected]"
    },
    {
      "name": "verified_at",
      "value": "1670296277"
    }
  ],
  "wallet_id": "70b6a0d2-628a-4de6-af96-144100f74878",
  "rule": "no rule",
  "meta_data": null,
  "state": "offer-sent",
  "complete": false,
  "result": false,
  "result_string": "Pending",
  "credential_exchange_id": [
    "4e49277d-aa3f-4647-9bff-91d9dca8b0c8"
  ],
  "error": "",
  "created_at": "2025-07-08T21:14:59.117Z",
  "updated_at": "2025-07-08T21:15:03.835Z"
}

Retrieve a credential by its credential definition ID

get

This endpoint retrieves a specific credential by its credential exchange ID.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Path parameters

credential_exchange_idstringRequired

The credential exchange ID.

Example: 1

Responses

200

A credential object

application/json

credentialobjectOptional

401

Unauthorized.

404

Credential record not found

application/json

500

Internal Server Error

application/json

get

/api/v1/credentials/{credential_exchange_id}

HTTPcURLJavaScriptPython

GET /api/v1/credentials/{credential_exchange_id} HTTP/1.1
Host: proven-4-2-test.proven.indicio.tech
x-api-key: YOUR_API_KEY
Accept: */*

{
  "credential_exchange_id": "02189932-52ac-4f9d-bf84-1fcfb7c67fa1",
  "wallet_id": "6b4ae41c-9c8a-49fd-9efa-fa0436d40b5c",
  "credential_id": null,
  "revocation_id": null,
  "connection_id": "0ecc0b3c-4d15-4660-b8da-15d0feeded59",
  "state": "offer-sent",
  "thread_id": "73d4b64f-f570-4970-9603-3381ed9cd440",
  "parent_thread_id": null,
  "schema_id": "E8BS9Fcg3cu2m9Dwaa3hVG:2:Email:1.0",
  "credential_definition_id": "Efgh86CGr29yoQKXHQraHD:3:CL:151:default",
  "revoc_reg_id": null,
  "revoked": null,
  "created_at": "2025-06-26T22:01:05.543Z",
  "updated_at": "2025-06-26T22:01:05.543Z",
  "attributes": null
}

Remove PII from a credential

post

This endpoint manually removes PII from a credential record.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Path parameters

credential_exchange_idstringRequired

The credential exchange ID.

Example: 02189932-52ac-4f9d-bf84-1fcfb7c67fa1

Responses

200

PII removed successfully

application/json

messagestringOptionalExample: Credential PII removed

401

Unauthorized.

404

Credential record not found

application/json

500

Internal Server Error

application/json

post

/api/v1/credentials/{credential_exchange_id}/pii

HTTPcURLJavaScriptPython

POST /api/v1/credentials/{credential_exchange_id}/pii HTTP/1.1
Host: proven-4-2-test.proven.indicio.tech
x-api-key: YOUR_API_KEY
Accept: */*

{
  "message": "Credential PII removed"
}

Retrieve an AnonCred credential record by ID

get

This endpoint retrieves an AnonCred credential record by its ID using the provided API key.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Path parameters

request_idstringRequired

The ID of the credential record.

Example: 1

Responses

200

Credential record retrieved successfully

application/json

recordobjectOptional

The retrieved AnonCred credential record.

401

Unauthorized.

404

AnonCred credential record not found

application/json

500

Internal Server Error

application/json

get

/api/v1/credential-records/{request_id}

HTTPcURLJavaScriptPython

GET /api/v1/credential-records/{request_id} HTTP/1.1
Host: proven-4-2-test.proven.indicio.tech
x-api-key: YOUR_API_KEY
Accept: */*

{
  "record": {
    "request_id": 1,
    "connection_id": "0ecc0b3c-4d15-4660-b8da-15d0feeded59",
    "contact_id": "8dba10d6-00d5-4f3a-ac8f-834211c9cbb9",
    "invitation_id": 1,
    "schema_id": "E8BS9Fcg3cu2m9Dwaa3hVG:2:Email:1.0",
    "attributes": [
      {
        "name": "local_part",
        "value": "timmy"
      },
      {
        "name": "domain",
        "value": "example.com"
      },
      {
        "name": "address",
        "value": "[email protected]"
      },
      {
        "name": "verified_at",
        "value": "1670296277"
      }
    ],
    "wallet_id": "6b4ae41c-9c8a-49fd-9efa-fa0436d40b5c",
    "rule": "no rule",
    "meta_data": null,
    "state": "offer-sent",
    "complete": false,
    "result": false,
    "result_string": "Pending",
    "credential_exchange_id": [
      "02189932-52ac-4f9d-bf84-1fcfb7c67fa1"
    ],
    "error": "",
    "created_at": "2025-06-26T22:01:02.677Z",
    "updated_at": "2025-06-26T22:01:05.594Z"
  }
}

Revoke an issued AnonCred credential

post

This endpoint allows you to revoke a credential by providing the connection and credential exchange IDs.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Body

application/json

connection_idstringOptional

The connection ID associated with the credential.

credential_exchange_idstringOptional

The credential exchange ID of the credential to revoke.

Responses

200

Credential revocation request accepted or already revoked

application/json

successbooleanOptional

messagestringOptional

400

Bad Request

application/json

401

Unauthorized

422

Unprocessable Entity

application/json

500

Internal Server Error

application/json

post

/api/v1/credentials/anoncreds/revoke

HTTPcURLJavaScriptPython

POST /api/v1/credentials/anoncreds/revoke HTTP/1.1
Host: proven-4-2-test.proven.indicio.tech
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 99

{
  "connection_id": "example-connection_id",
  "credential_exchange_id": "example-credential_exchange_id"
}

{
  "message": "Revocation request processed successfully."
}