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
x-api-keystringRequired
Query parameters
status_purposestringOptional

Filter by status purpose.

Responses
200

Successfully retrieved the status list definition.

application/json
object[]Optional
get
/api/v1/status-list/defs

Post a status list definition.

post

Post a status list definition.

Authorizations
x-api-keystringRequired
Query parameters
publishbooleanOptional

If true, publish status list on creation at the did:indy provided in publication.did. False by default.

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
post
/api/v1/status-list/defs

Get a status list definition by ID.

get

Retrieve the status list.

Authorizations
x-api-keystringRequired
Path parameters
idstringRequired

Identifier of the status list definition to retrieve.

Responses
200

Successfully retrieved the status list definition.

application/json
idstringOptional

The status list definition ID.

get
/api/v1/status-list/defs/{id}

Delete a status list definition by ID.

delete

Delete the status list.

Authorizations
x-api-keystringRequired
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
idstringOptional

The status list definition ID.

Example: 1
delete
/api/v1/status-list/defs/{id}

Get a status list credential by credential exchange ID.

get

Delete the status list.

Authorizations
x-api-keystringRequired
Path parameters
credential_exchange_idstringRequired

Identifier of the credential.

Responses
200

Successfully retrieved the status list credential.

application/json
listintegerOptional

The status list number.

Example: 1
indexintegerOptional

The status list index.

Example: 1
statusstringOptional

The status bitstring.

Example: 01
assignedbooleanOptional

Status assigned.

Example: true
get
/api/v1/status-list/entries/{credential_exchange_id}

Update a status list credential's status.

patch

Update a status list credential's status.

Authorizations
x-api-keystringRequired
Path parameters
credential_exchange_idstringRequired

Identifier of the credential.

Query parameters
updatebooleanOptional

Whether to automatically update the published status list after revocation. True by default.

Body
statusstringOptional

The status bitstring.

Example: 01
Responses
200

Successfully retrieved the status list credential.

application/json
listintegerOptional

The status list number.

Example: 1
indexintegerOptional

The status list index.

Example: 1
statusstringOptional

The status bitstring.

Example: 01
assignedbooleanOptional

Status assigned.

Example: true
patch
/api/v1/status-list/entries/revoke/{credential_exchange_id}

Update multiple status list credentials' statuses at a time.

patch

Update multiple status list credentials' status at a time.

Authorizations
x-api-keystringRequired
Query parameters
updatebooleanOptional

Whether to automatically update the published status list after revocation. True by default.

Bodyobject[]
credential_exchange_idstringOptional

Identifier of the credential.

Example: string
statusstringOptional

The status bitstring.

Example: 01
Responses
200

Successfully retrieved the status list credential.

application/json
anyOptional
patch
/api/v1/status-list/entries/batch-revoke

Publish a status list definition.

put

Publish a status list definition.

Authorizations
x-api-keystringRequired
Path parameters
def_idstringRequired

Identifier of the status list definition.

Body
didstringOptional

DID.

Example: did:indy:indicio:test:JKdq87RF5kEsfv7b8BAdqs
verification_methodstringOptional

Verification method.

Example: did:indy:indicio:test:JKdq87RF5kEsfv7b8BAdqs#assert
status_typestringOptional

Status Type.

Example: w3c
Responses
200

Successfully published the status list definition.

application/json
objectOptional
put
/api/v1/status-list/defs/{def_id}/publish

Last updated

Was this helpful?