Update a Document Signer

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

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

Only available in implementations using unmanaged (external) IACAs.

Roles

adminissuer

Analytics Events

MOBILE_CREDENTIAL_DOCUMENT_SIGNER_UPDATE_STARTMOBILE_CREDENTIAL_DOCUMENT_SIGNER_UPDATE_SUCCESSMOBILE_CREDENTIAL_DOCUMENT_SIGNER_UPDATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

documentSignerId*string

Document Signer ID

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X PUT "https://example.com/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-26T00:00:00.000Z",    "notBefore": "2023-09-30T00:00:00.000Z",    "country": "US",    "stateOrProvinceName": "US-AL",    "commonName": "{tenant-subdomain}.vii.mattr.global Document Signer"  }}

Update a Document Signer

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

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

Only available in implementations using unmanaged (external) IACAs.

Roles

adminissuer

Analytics Events

MOBILE_CREDENTIAL_DOCUMENT_SIGNER_UPDATE_STARTMOBILE_CREDENTIAL_DOCUMENT_SIGNER_UPDATE_SUCCESSMOBILE_CREDENTIAL_DOCUMENT_SIGNER_UPDATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

documentSignerId*string

Document Signer ID

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

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`

curl -X PUT "https://example.com/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-26T00:00:00.000Z",    "notBefore": "2023-09-30T00:00:00.000Z",    "country": "US",    "stateOrProvinceName": "US-AL",    "commonName": "{tenant-subdomain}.vii.mattr.global Document Signer"  }}

How would you rate this page?

Update a Document Signer

Roles

Analytics Events

200application/json

400application/json

404application/json

Update a Document Signer

Roles

Analytics Events

200application/json

400application/json

404application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`