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
Document Signer created
Bad Request. The request was malformed or missing required parameters.
Maximum number of document signer certificates reached. Please delete an existing certificate before creating a new one.
- Payload
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
{- "iacaId": "080c670a-2e90-4023-b79f-b706e55e9bc6"
}
- 201
- 400
- 409
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "iacaId": "080c670a-2e90-4023-b79f-b706e55e9bc6",
- "active": true,
- "csrPem": "-----BEGIN CERTIFICATE REQUEST-----...-----END CERTIFICATE REQUEST-----"
}
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
Document Signers retrieved
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- 200
{- "data": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "iacaId": "080c670a-2e90-4023-b79f-b706e55e9bc6",
- "active": true,
- "csrPem": "-----BEGIN CERTIFICATE REQUEST-----...-----END CERTIFICATE REQUEST-----"
}
], - "nextCursor": "string"
}
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
path Parameters
Request Body schema: application/jsonrequired
active required | 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:
|
Document Signer updated
Bad Request. The request was malformed or missing required parameters.
Not Found. The specified resource was not found.
- Payload
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
{- "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"
}
- 200
- 400
- 404
{- "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"
}
}
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
Document Signer retrieved
Not Found. The specified resource was not found.
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- 200
- 404
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "iacaId": "080c670a-2e90-4023-b79f-b706e55e9bc6",
- "active": true,
- "csrPem": "-----BEGIN CERTIFICATE REQUEST-----...-----END CERTIFICATE REQUEST-----"
}
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
Document Signer deleted
Not Found. The specified resource was not found.
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- 404
{- "code": "string",
- "message": "string",
- "details": [
- {
- "value": "string",
- "msg": "Invalid value",
- "param": "id",
- "location": "body"
}
]
}