Status List

Endpoints for managing status lists

Query status list definitions.

get

Retrieves the status lists, filtered by supported credential ID or status purpose.

Authorizations

Query parameters

status_purposestringOptional

Filter by status purpose.

Responses

200

Successfully retrieved the status list definition.

application/json

Responseobject[]

404

Status list definitions not found

500

Internal server error

get

HTTPcURLJavaScriptPython

GET /api/v1/status-list/defs HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Accept: */*

[
  {}
]

Post a status list definition.

post

Post a status list definition.

Authorizations

Body

status_purposestringOptional

The purpose of the status. Defaults to "revocation".

Example: revocation

status_sizeintegerOptional

The size of the status in bits.

Example: 1

shard_sizeintegerOptional

The size of a shard, between 1 and list_size.

Example: 1024

list_sizeintegerOptional

Number of entries in status list, minimum 131072

Example: 131072

Responses

200

Successfully created a status list definition.

application/json

Responseobject

500

Internal server error

post

HTTPcURLJavaScriptPython

POST /api/v1/status-list/defs HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 140

{
  "status_purpose": "revocation",
  "status_message": [
    {
      "status": "0x00",
      "message": "active"
    }
  ],
  "status_size": 1,
  "shard_size": 1024,
  "list_size": 131072
}

{}

Get a status list definition by ID.

get

Retrieve the status list.

Authorizations

Path parameters

idstringRequired

Identifier of the status list definition to retrieve.

Responses

200

Successfully retrieved the status list definition.

application/json

404

Status list not found

500

Internal server error

get

HTTPcURLJavaScriptPython

GET /api/v1/status-list/defs/{id} HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Accept: */*

[
  {
    "id": "1"
  }
]

Delete a status list definition by ID.

delete

Delete the status list.

Authorizations

Path parameters

idstringRequired

Identifier of the status list definition to delete.

Body

recursive_deletebooleanOptional

Delete all underlying status list and entries recursively.

Example: true

Responses

200

Successfully removed the status list definition.

application/json

404

Status list not found

500

Internal server error

delete

HTTPcURLJavaScriptPython

DELETE /api/v1/status-list/defs/{id} HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "recursive_delete": true
}

[
  {
    "id": "1"
  }
]

Get a status list credential by credential exchange ID.

get

Delete the status list.

Authorizations

Path parameters

credential_exchange_idstringRequired

Identifier of the credential.

Responses

200

Successfully retrieved the status list credential.

application/json

404

Credential not found

500

Internal server error

get

HTTPcURLJavaScriptPython

GET /api/v1/status-list/entries/{credential_exchange_id} HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Accept: */*

{
  "list": 1,
  "index": 1,
  "status": "01",
  "assigned": true
}

Update a status list credential's status.

patch

Update a status list credential's status.

Authorizations

Path parameters

credential_exchange_idstringRequired

Identifier of the credential.

Body

statusstringOptional

The status bitstring.

Example: 01

Responses

200

Successfully retrieved the status list credential.

application/json

404

Credential not found

500

Internal server error

patch

HTTPcURLJavaScriptPython

PATCH /api/v1/status-list/entries/revoke/{credential_exchange_id} HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "status": "01"
}

{
  "list": 1,
  "index": 1,
  "status": "01",
  "assigned": true
}

Publish a status list definition.

put

Publish a status list definition.

Authorizations

Path parameters

def_idstringRequired

Identifier of the status list definition.

Body

didstringOptional

DID.

Example: did:indy:indicio:test:W3v5casouvLGCwVx6KGgYG

verification_methodstringOptional

Verification method.

Example: did:indy:indicio:test:W3v5casouvLGCwVx6KGgYG#assert

status_typestringOptional

Status Type.

Example: w3c

Responses

200

Successfully published a status list definition.

application/json

500

Internal server error

put

HTTPcURLJavaScriptPython

PUT /api/v1/status-list/defs/{def_id}/publish HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 150

{
  "did": "did:indy:indicio:test:W3v5casouvLGCwVx6KGgYG",
  "verification_method": "did:indy:indicio:test:W3v5casouvLGCwVx6KGgYG#assert",
  "status_type": "w3c"
}

{
  "published": true,
  "error": "text",
  "definition_id": "w3c",
  "status_lists": [
    "text"
  ]
}