Document signers

Create a Document signer

POST/v2/credentials/mobile/document-signers

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.

Roles

adminissuer

Analytics Events

MOBILE_CREDENTIAL_DOCUMENT_SIGNER_CREATE_STARTMOBILE_CREDENTIAL_DOCUMENT_SIGNER_CREATE_SUCCESSMOBILE_CREDENTIAL_DOCUMENT_SIGNER_CREATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X POST "https://example.com/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": "string"}

Revoke a Document signer

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

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.

Roles

adminissuer

Analytics Events

MOBILE_CREDENTIAL_DOCUMENT_SIGNER_REVOKE_STARTMOBILE_CREDENTIAL_DOCUMENT_SIGNER_REVOKE_SUCCESSMOBILE_CREDENTIAL_DOCUMENT_SIGNER_REVOKE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

documentSignerId*string

Document Signer identifier

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Empty request body for document signer revocation

Response Body

`application/json`

curl -X POST "https://example.com/v2/credentials/mobile/document-signers/497f6eca-6276-4993-bfeb-53cbbbba6f08/revoke" \  -H "Content-Type: application/json" \  -d '{}'

{  "revoked": true,  "revocationDate": "string"}

Retrieve all Document signers

GET/v2/credentials/mobile/document-signers

Retrieves all existing Document Signers from the tenant.

Roles

adminissuermanaged-issuer

Analytics Events

MOBILE_CREDENTIAL_DOCUMENT_SIGNER_RETRIEVE_LIST_STARTMOBILE_CREDENTIAL_DOCUMENT_SIGNER_RETRIEVE_LIST_SUCCESSMOBILE_CREDENTIAL_DOCUMENT_SIGNER_RETRIEVE_LIST_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/v2/credentials/mobile/document-signers"

{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "iacaId": "080c670a-2e90-4023-b79f-b706e55e9bc6",      "active": true,      "csrPem": "string"    }  ],  "nextCursor": "string"}

Retrieve a Document signer

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

Retrieves an existing Document Signer by providing its ID.

Roles

adminissuermanaged-issuer

Analytics Events

MOBILE_CREDENTIAL_DOCUMENT_SIGNER_RETRIEVE_STARTMOBILE_CREDENTIAL_DOCUMENT_SIGNER_RETRIEVE_SUCCESSMOBILE_CREDENTIAL_DOCUMENT_SIGNER_RETRIEVE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

documentSignerId*string

Document Signer ID

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/v2/credentials/mobile/document-signers/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "iacaId": "080c670a-2e90-4023-b79f-b706e55e9bc6",  "active": true,  "csrPem": "string"}

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/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "active": true  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "iacaId": "080c670a-2e90-4023-b79f-b706e55e9bc6",  "active": true,  "certificatePem": "string",  "certificateFingerprint": "string",  "certificateData": {    "notAfter": "2019-08-24",    "notBefore": "2019-08-24",    "country": "string",    "stateOrProvinceName": "string",    "commonName": "{tenantDomain} Document Signer"  }}

Delete a Document signer

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

Deletes an existing Document Signer by providing its ID.

Only available in implementations using unmanaged (external) IACAs.

Roles

adminissuer

Analytics Events

MOBILE_CREDENTIAL_DOCUMENT_SIGNER_DELETE_STARTMOBILE_CREDENTIAL_DOCUMENT_SIGNER_DELETE_SUCCESSMOBILE_CREDENTIAL_DOCUMENT_SIGNER_DELETE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

documentSignerId*string

Document Signer ID

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/v2/credentials/mobile/document-signers/497f6eca-6276-4993-bfeb-53cbbbba6f08"

Empty

Create a Document signer

POST/v2/credentials/mobile/document-signers

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.

Roles

adminissuer

Analytics Events

MOBILE_CREDENTIAL_DOCUMENT_SIGNER_CREATE_STARTMOBILE_CREDENTIAL_DOCUMENT_SIGNER_CREATE_SUCCESSMOBILE_CREDENTIAL_DOCUMENT_SIGNER_CREATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

iacaId*string

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

Must be an unmanaged (external) IACA.

Formatuuid

Response Body

`application/json`

curl -X POST "https://example.com/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": "string"}

Revoke a Document signer

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

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.

Roles

adminissuer

Analytics Events

MOBILE_CREDENTIAL_DOCUMENT_SIGNER_REVOKE_STARTMOBILE_CREDENTIAL_DOCUMENT_SIGNER_REVOKE_SUCCESSMOBILE_CREDENTIAL_DOCUMENT_SIGNER_REVOKE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

documentSignerId*string

Document Signer identifier

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Empty request body for document signer revocation

Response Body

`application/json`

curl -X POST "https://example.com/v2/credentials/mobile/document-signers/497f6eca-6276-4993-bfeb-53cbbbba6f08/revoke" \  -H "Content-Type: application/json" \  -d '{}'

{  "revoked": true,  "revocationDate": "string"}

Retrieve all Document signers

GET/v2/credentials/mobile/document-signers

Retrieves all existing Document Signers from the tenant.

Roles

adminissuermanaged-issuer

Analytics Events

MOBILE_CREDENTIAL_DOCUMENT_SIGNER_RETRIEVE_LIST_STARTMOBILE_CREDENTIAL_DOCUMENT_SIGNER_RETRIEVE_LIST_SUCCESSMOBILE_CREDENTIAL_DOCUMENT_SIGNER_RETRIEVE_LIST_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/v2/credentials/mobile/document-signers"

{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "iacaId": "080c670a-2e90-4023-b79f-b706e55e9bc6",      "active": true,      "csrPem": "string"    }  ],  "nextCursor": "string"}

Retrieve a Document signer

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

Retrieves an existing Document Signer by providing its ID.

Roles

adminissuermanaged-issuer

Analytics Events

MOBILE_CREDENTIAL_DOCUMENT_SIGNER_RETRIEVE_STARTMOBILE_CREDENTIAL_DOCUMENT_SIGNER_RETRIEVE_SUCCESSMOBILE_CREDENTIAL_DOCUMENT_SIGNER_RETRIEVE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

documentSignerId*string

Document Signer ID

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/v2/credentials/mobile/document-signers/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "iacaId": "080c670a-2e90-4023-b79f-b706e55e9bc6",  "active": true,  "csrPem": "string"}

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/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "active": true  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "iacaId": "080c670a-2e90-4023-b79f-b706e55e9bc6",  "active": true,  "certificatePem": "string",  "certificateFingerprint": "string",  "certificateData": {    "notAfter": "2019-08-24",    "notBefore": "2019-08-24",    "country": "string",    "stateOrProvinceName": "string",    "commonName": "{tenantDomain} Document Signer"  }}

Delete a Document signer

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

Deletes an existing Document Signer by providing its ID.

Only available in implementations using unmanaged (external) IACAs.

Roles

adminissuer

Analytics Events

MOBILE_CREDENTIAL_DOCUMENT_SIGNER_DELETE_STARTMOBILE_CREDENTIAL_DOCUMENT_SIGNER_DELETE_SUCCESSMOBILE_CREDENTIAL_DOCUMENT_SIGNER_DELETE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

documentSignerId*string

Document Signer ID

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/v2/credentials/mobile/document-signers/497f6eca-6276-4993-bfeb-53cbbbba6f08"

Empty

Roles

Analytics Events

201application/json

400application/json

409application/json

Roles

Analytics Events

200application/json

400application/json

404application/json

409application/json

Roles

Analytics Events

200application/json

Roles

Analytics Events

200application/json

404application/json

Roles

Analytics Events

200application/json

400application/json

404application/json

Roles

Analytics Events

204

404application/json

On this page

Document signers

Roles

Analytics Events

201application/json

400application/json

409application/json

Roles

Analytics Events

200application/json

400application/json

404application/json

409application/json

Roles

Analytics Events

200application/json

Roles

Analytics Events

200application/json

404application/json

Roles

Analytics Events

200application/json

400application/json

404application/json

Roles

Analytics Events

204

404application/json

On this page

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`