light-mode-image
Learn
CertificatesAPI Reference

Document signers

Create a Document signer

Create a Document Signer

Creates a new Document Signer that can be used to sign new mDocs.

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

Analytic events

  • MOBILE_CREDENTIAL_DOCUMENT_SIGNER_CREATE_START
  • MOBILE_CREDENTIAL_DOCUMENT_SIGNER_CREATE_SUCCESS
  • MOBILE_CREDENTIAL_DOCUMENT_SIGNER_CREATE_FAIL
POST/v2/credentials/mobile/document-signers

Authorization

AuthorizationBearer <token>

In: header

Request Body

iacaIdstring

Internal identifier of the IACA used to sign this document signer:

  • Must be an unmanaged (external) IACA.
Formatuuid
curl -X POST "https://example.vii.au01.mattr.global/v2/credentials/mobile/document-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": true,
  "csrPem": "-----BEGIN CERTIFICATE REQUEST-----...-----END CERTIFICATE REQUEST-----"
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

Revoke a Document signer

Revoke a Document Signer

Revokes an existing Document Signer, making it unusable for signing new mDocs.

If the verifier checks the CRL referenced in the IACA certificate, it must treat revoked Document Signers and any mDocs they signed as untrusted.

Analytic events

  • MOBILE_CREDENTIAL_DOCUMENT_SIGNER_REVOKE_START
  • MOBILE_CREDENTIAL_DOCUMENT_SIGNER_REVOKE_SUCCESS
  • MOBILE_CREDENTIAL_DOCUMENT_SIGNER_REVOKE_FAIL
POST/v2/credentials/mobile/document-signers/{documentSignerId}/revoke

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

documentSignerIdstring

Document Signer identifier

Formatuuid

Request Body

Empty Object

curl -X POST "https://example.vii.au01.mattr.global/v2/credentials/mobile/document-signers/497f6eca-6276-4993-bfeb-53cbbbba6f08/revoke" \  -H "Content-Type: application/json" \  -d '{}'
{
  "revoked": true,
  "revocationDate": "2025-10-31T23:59:59Z"
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

Retrieve all Document signers

Retrieve all Document Signers

Retrieves all existing Document Signers from the tenant.

Analytic events

  • MOBILE_CREDENTIAL_DOCUMENT_SIGNER_RETRIEVE_LIST_START
  • MOBILE_CREDENTIAL_DOCUMENT_SIGNER_RETRIEVE_LIST_SUCCESS
  • MOBILE_CREDENTIAL_DOCUMENT_SIGNER_RETRIEVE_LIST_FAIL
GET/v2/credentials/mobile/document-signers

Authorization

AuthorizationBearer <token>

In: header

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

Retrieve a Document signer

Retrieve a Document Signer

Retrieves an existing Document Signer by providing its ID.

Analytic events

  • MOBILE_CREDENTIAL_DOCUMENT_SIGNER_RETRIEVE_START
  • MOBILE_CREDENTIAL_DOCUMENT_SIGNER_RETRIEVE_SUCCESS
  • MOBILE_CREDENTIAL_DOCUMENT_SIGNER_RETRIEVE_FAIL
GET/v2/credentials/mobile/document-signers/{documentSignerId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

documentSignerIdstring

Document Signer ID

Formatuuid
curl -X GET "https://example.vii.au01.mattr.global/v2/credentials/mobile/document-signers/d2c9f2aa-fc69-4fbc-9b85-0c00591d72f6"
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "iacaId": "080c670a-2e90-4023-b79f-b706e55e9bc6",
  "active": true,
  "csrPem": "-----BEGIN CERTIFICATE REQUEST-----...-----END CERTIFICATE REQUEST-----"
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

Update a Document signer

Update a Document Signer

Updates an existing Document Signer by providing its ID and active parameter.

Only available in implementations using unmanaged (external) IACAs.

Analytic events

  • MOBILE_CREDENTIAL_DOCUMENT_SIGNER_UPDATE_START
  • MOBILE_CREDENTIAL_DOCUMENT_SIGNER_UPDATE_SUCCESS
  • MOBILE_CREDENTIAL_DOCUMENT_SIGNER_UPDATE_FAIL
PUT/v2/credentials/mobile/document-signers/{documentSignerId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

documentSignerIdstring

Document Signer ID

Formatuuid

Request Body

activeboolean

This required parameter defines the status of the created Document Signer. Only active Document Signers can be used to sign mDocs.

certificatePem?string

Document Signer Certificate (DSC) in PEM format. The certificate must be:

  • Valid
  • Not expired
  • Compliant with the details provided in the Certificate Signing Request returned when the Document Signer was created Refer to Certificate requirements in the external certificates documentation for a full list of requirements detailed in the CSR.
curl -X PUT "https://example.vii.au01.mattr.global/v2/credentials/mobile/document-signers/d2c9f2aa-fc69-4fbc-9b85-0c00591d72f6" \  -H "Content-Type: application/json" \  -d '{    "active": true  }'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "iacaId": "080c670a-2e90-4023-b79f-b706e55e9bc6",
  "active": true,
  "certificatePem": "-----BEGIN CERTIFICATE-----\\r\\nMIICbzCCAhSgAwIBAgIKfS7sskyJEh+DOzAKBggqhkjOPQQDAjAiMSAwCQYDVQQG\\r\\nEwJOWjATBgNVBAMTDEV4YW1wbGUgSUFDQTAeFw0yMzA5MTEyMzM0MjJaFw0yNDA5\\r\\nMTAyMzM0MjJaMDExLzAJBgNVBAYTAk5aMCIGA1UEAxMbZXhhbXBsZS5jb20gRG9j\\r\\ndW1lbnQgU2lnbmVyMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE7fa+jv9zCtHQ\\r\\nmKn7o1dS6lBHD5thlhPqjlx7qEfqy8Im9AcQJDal2sr/fUxhHwf/G4ublS7AL04U\\r\\n73dzr/ozxaOCASEwggEdMAwGA1UdEwEB/wQCMAAwHQYDVR0OBBYEFLdNNPTmPxt0\\r\\nLqvlZnV/QL86MXOxMB8GA1UdIwQYMBaAFPc04SrKhcQIESQwxltWrvnsCSuqMA4G\\r\\nA1UdDwEB/wQEAwIAgDAeBgNVHREEFzAVhhNodHRwczovL2V4YW1wbGUuY29tMB4G\\r\\nA1UdEgQXMBWGE2h0dHBzOi8vZXhhbXBsZS5jb20waQYDVR0fBGIwYDBeoFygWoZY\\r\\naHR0cHM6Ly9leGFtcGxlLmNvbS92Mi9jcmVkZW50aWFscy9tb2JpbGUvaWFjYXMv\\r\\nMmU4OWMxNTYtMzFkNS00NzgzLWJkNTktOTA1NWI1ZjhlN2QyL2NybDASBgNVHSUE\\r\\nCzAJBgcogYxdBQECMAoGCCqGSM49BAMCA0kAMEYCIQCfgn6+QoNfDVelJANl+Jp9\\r\\ncq7X9paZylfnI6UGr1FM6gIhAIzhiyclDa8+/ZSRfu7KfgGrNRaJ8YQ6vevskJls\\r\\nIavC\\r\\n-----END CERTIFICATE-----\\r\\n",
  "certificateFingerprint": "f6cad6e579d70b3973efa60624af731a580d1a11a7579e70f2f10f059dc86172",
  "certificateData": {
    "notAfter": "2034-09-26",
    "notBefore": "2023-09-30",
    "country": "US",
    "stateOrProvinceName": "US-AL",
    "commonName": "{tenant-subdomain}.vii.mattr.global Document Signer"
  }
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

Delete a Document signer

Delete a Document Signer

Deletes an existing Document Signer by providing its ID.

Only available in implementations using unmanaged (external) IACAs.

Analytic events

  • MOBILE_CREDENTIAL_DOCUMENT_SIGNER_DELETE_START
  • MOBILE_CREDENTIAL_DOCUMENT_SIGNER_DELETE_SUCCESS
  • MOBILE_CREDENTIAL_DOCUMENT_SIGNER_DELETE_FAIL
DELETE/v2/credentials/mobile/document-signers/{documentSignerId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

documentSignerIdstring

Document Signer ID

Formatuuid
curl -X DELETE "https://example.vii.au01.mattr.global/v2/credentials/mobile/document-signers/d2c9f2aa-fc69-4fbc-9b85-0c00591d72f6"
Empty
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

How would you rate this page?

IACA

Previous Page

Issuer metadata

Next Page

On this page

Create a Document signerRevoke a Document signerRetrieve all Document signersRetrieve a Document signerUpdate a Document signerDelete a Document signer