light-mode-image
Learn
CertificatesAPI Reference

Document signers

Create a Document signer

POST/v2/credentials/mobile/document-signers

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Request Body

application/json

iacaId*string

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

  • Must be an unmanaged (external) IACA.
Formatuuid

Response Body

application/json

application/json

application/json

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

POST/v2/credentials/mobile/document-signers/{documentSignerId}/revoke

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

documentSignerId*string

Document Signer identifier

Formatuuid

Request Body

application/json

Empty request body for document signer revocation

Response Body

application/json

application/json

application/json

application/json

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

GET/v2/credentials/mobile/document-signers

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Response Body

application/json

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

GET/v2/credentials/mobile/document-signers/{documentSignerId}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

documentSignerId*string

Document Signer ID

Formatuuid

Response Body

application/json

application/json

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

PUT/v2/credentials/mobile/document-signers/{documentSignerId}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

documentSignerId*string

Document Signer ID

Formatuuid

Request Body

application/json

active*boolean

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.

Response Body

application/json

application/json

application/json

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/v2/credentials/mobile/document-signers/{documentSignerId}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

documentSignerId*string

Document Signer ID

Formatuuid

Response Body

application/json

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?

Last updated on

IACA

Previous Page

Issuer metadata

Next Page

On this page

Create a Document signer
Revoke a Document signer
Retrieve all Document signers
Retrieve a Document signer
Update a Document signer
Delete a Document signer