light-mode-image
Learn
API Reference

Status List Signers

Create a Status List Signers

Create a new status list signer

Uses an existing IACA to sign a status list signer (intermediate certificate) that can be used to sign status list tokens.

  • Only available in implementations using unmanaged (external) IACAs.
  • A maximum of three Status List Signers can be created per tenant.

Analytic events

  • MOBILE_CREDENTIAL_STATUS_LIST_SIGNER_CREATE_START
  • MOBILE_CREDENTIAL_STATUS_LIST_SIGNER_CREATE_SUCCESS
  • MOBILE_CREDENTIAL_STATUS_LIST_SIGNER_CREATE_FAIL
POST/v2/credentials/mobile/status-list-signers

Authorization

AuthorizationBearer <token>

In: header

Request Body

iacaIdstring

Internal identifier of the IACA used to sign this status list signer:

  • Must be the same IACA used to sign credentials that are included in a status list signed by this status list signer.
  • Must be an unmanaged (external) IACA.
Formatuuid
curl -X POST "https://example.vii.au01.mattr.global/v2/credentials/mobile/status-list-signers" \  -H "Content-Type: application/json" \  -d '{    "iacaId": "080c670a-2e90-4023-b79f-b706e55e9bc6"  }'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "iacaId": "080c670a-2e90-4023-b79f-b706e55e9bc6",
  "active": false,
  "csrPem": "-----BEGIN CERTIFICATE REQUEST-----...-----END CERTIFICATE REQUEST-----"
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

Retrieve all Status List Signers

Retrieve all status list signers

Retrieves all existing status list signers.

Analytic events

  • MOBILE_CREDENTIAL_STATUS_LIST_SIGNER_RETRIEVE_LIST_START
  • MOBILE_CREDENTIAL_STATUS_LIST_SIGNER_RETRIEVE_LIST_SUCCESS
  • MOBILE_CREDENTIAL_STATUS_LIST_SIGNER_RETRIEVE_LIST_FAIL
GET/v2/credentials/mobile/status-list-signers

Authorization

AuthorizationBearer <token>

In: header

curl -X GET "https://example.vii.au01.mattr.global/v2/credentials/mobile/status-list-signers"
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "iacaId": "080c670a-2e90-4023-b79f-b706e55e9bc6",
      "active": false,
      "csrPem": "-----BEGIN CERTIFICATE REQUEST-----...-----END CERTIFICATE REQUEST-----"
    }
  ]
}

Retrieve a Status List Signer

Retrieve a status list signer

Retrieves an existing status list signer.

Status list signer operations are only available in implementations using unmanaged (external) IACAs.

Analytic events

  • MOBILE_CREDENTIAL_STATUS_LIST_SIGNER_RETRIEVE_START
  • MOBILE_CREDENTIAL_STATUS_LIST_SIGNER_RETRIEVE_SUCCESS
  • MOBILE_CREDENTIAL_STATUS_LIST_SIGNER_RETRIEVE_FAIL
GET/v2/credentials/mobile/status-list-signers/{statusListSignerId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

statusListSignerIdstring

Status list identifier

Formatuuid
curl -X GET "https://example.vii.au01.mattr.global/v2/credentials/mobile/status-list-signers/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "iacaId": "080c670a-2e90-4023-b79f-b706e55e9bc6",
  "active": false,
  "csrPem": "-----BEGIN CERTIFICATE REQUEST-----...-----END CERTIFICATE REQUEST-----"
}

Update a Status List Signer

Update a status list signer

Updates the status of an existing status list signer.

Only available in implementations using unmanaged (external) IACAs.

Analytic events

  • MOBILE_CREDENTIAL_STATUS_LIST_SIGNER_UPDATE_START
  • MOBILE_CREDENTIAL_STATUS_LIST_SIGNER_UPDATE_SUCCESS
  • MOBILE_CREDENTIAL_STATUS_LIST_SIGNER_UPDATE_FAIL
PUT/v2/credentials/mobile/status-list-signers/{statusListSignerId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

statusListSignerIdstring

Status list identifier

Formatuuid

Request Body

active?boolean

Status list signer status. Must be set to true for this status list signer to be available for signing status lists.

certificatePem?string

Status list signer certificate in PEM format. The certificate must be:

  • Valid
  • Not expired
  • Compliant with the details provided in the Certificate Signing Request returned when the status list signer was created
curl -X PUT "https://example.vii.au01.mattr.global/v2/credentials/mobile/status-list-signers/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "iacaId": "080c670a-2e90-4023-b79f-b706e55e9bc6",
  "active": true,
  "certificatePem": "string",
  "certificateFingerprint": "475DA948E4BA44D9B5BC31AB4B8006113FD5F538",
  "certificateData": {
    "notBefore": "2019-08-24T14:15:22Z",
    "notAfter": "2019-08-24T14:15:22Z",
    "country": "string",
    "stateOrProvinceName": "string",
    "organisationName": "string"
  }
}

Delete a Status List Signer

Delete a status list signer

Deletes an existing status list signer.

Only available in implementations using unmanaged (external) IACAs.

Analytic events

  • MOBILE_CREDENTIAL_STATUS_LIST_SIGNER_DELETE_START
  • MOBILE_CREDENTIAL_STATUS_LIST_SIGNER_DELETE_SUCCESS
  • MOBILE_CREDENTIAL_STATUS_LIST_SIGNER_DELETE_FAIL
DELETE/v2/credentials/mobile/status-list-signers/{statusListSignerId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

statusListSignerIdstring

Status list identifier

Formatuuid
curl -X DELETE "https://example.vii.au01.mattr.global/v2/credentials/mobile/status-list-signers/497f6eca-6276-4993-bfeb-53cbbbba6f08"
Empty

How would you rate this page?

Status List retrieval

Previous Page

Status update

Next Page

On this page

Create a Status List SignersRetrieve all Status List SignersRetrieve a Status List SignerUpdate a Status List SignerDelete a Status List Signer