Skip to main content
New to Corsair? See API access, authentication, and error handling.

Credentials

delete

credentials.delete Delete a credential metadata record; this does not revoke the credential Risk: destructive · Irreversible
Input Deletes the metadata record only. The credential itself stays valid, so use credentials.revoke first. Output: object \| undefined

get

credentials.get Read one credential metadata, and its contents when it was persisted Risk: read
Input Output

issue

credentials.issue Issue and sign a verifiable credential, optionally distributing it to a holder, persisting it, or making it revocable Risk: destructive
Input The issuer must be a DID the account controls. persist needs password, and distribute needs a recipient; both are checked before the request.
Output

list

credentials.list List the credential metadata on the account, with offset paging Risk: read
Input Output: object[]

revoke

credentials.revoke Revoke a credential, which makes every verification of it fail Risk: destructive
Input Makes every verification of the credential fail. It can be undone with credentials.unrevoke only when the registry was created with add_only: false; in an add-only registry (the default) the revocation is permanent. Output: empty object

unrevoke

credentials.unrevoke Unrevoke a credential, which restores it as valid Risk: destructive
Input Output: empty object

Dids

create

dids.create Create a DID with its keys, optionally with a DIDComm service endpoint Risk: destructive
Input A DID with a DIDComm service endpoint needs didcomm_service_url. Deleting a DID leaves credentials signed with it unverifiable against that DID. Output

delete

dids.delete Delete a DID and its keys; credentials signed with it can no longer be verified against it Risk: destructive · Irreversible
Input Output: empty object

get

dids.get Resolve one DID and read its document Risk: read
Input Output

getMetadata

dids.getMetadata Read one DID resolution metadata: controller, versions and deactivation Risk: read
Input Output

list

dids.list List the DIDs the account controls Risk: read
Input Output: object[]

Jobs

get

jobs.get Read an async job that issuance or a registry write returned instead of a finished resource Risk: read
Input Output

Profiles

create

profiles.create Create a profile for a DID the account controls Risk: write
Input Output

delete

profiles.delete Delete a profile; the DID itself remains Risk: destructive · Irreversible
Input Output: object \| undefined

get

profiles.get Read one profile by its DID Risk: read
Input Output

list

profiles.list List the issuer profiles on the account Risk: read
Input Output: object[]

update

profiles.update Change a profile’s name, description, logo or contact details Risk: write
Input Output

Registries

create

registries.create Create a revocation registry Risk: destructive
Input
Output

delete

registries.delete Delete a revocation registry, which removes every credential status it held Risk: destructive · Irreversible
Input Removes the status of every credential in the registry, so revocations recorded there are lost. Output: empty object

get

registries.get Read one revocation registry Risk: read
Input Output

list

registries.list List the revocation registries on the account Risk: read
Input Output: object[]

revocationStatus

registries.revocationStatus Read whether one credential in a registry is revoked Risk: read
Input Output

revoke

registries.revoke Revoke or unrevoke several credentials in one registry in one call Risk: destructive
Input Applies one action to several credentials in one call. credential_ids are the registry indices. Output: empty object

Schemas

create

schemas.create Create a JSON credential schema that a credential type and subject follow Risk: destructive
Input Output

delete

schemas.delete Delete a schema; credentials already issued against it stay valid Risk: destructive · Irreversible
Input Credentials already issued against the schema stay valid; only the schema entry is removed. Output: empty object

get

schemas.get Read one schema by its id Risk: read
Input Output

list

schemas.list List the credential schemas on the account Risk: read
Input Output: object[]

Verify

verify

verify.verify Verify a credential or presentation and read the reasons when it fails Risk: read
Input A failed verification answers 200 with verified: false and the reasons in errors; it is not an error. Output