CertificatesAPI Reference
Document signers
Create a Document signer
POST
/v2/credentials/mobile/document-signersAuthorization
bearerAuth AuthorizationBearer <token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
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}/revokeAuthorization
bearerAuth AuthorizationBearer <token>
In: header
Path Parameters
documentSignerId*string
Document Signer identifier
Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Empty request body for document signer revocation
Response Body
application/json
application/json
application/json
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-signersAuthorization
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}Authorization
bearerAuth AuthorizationBearer <token>
In: header
Path Parameters
documentSignerId*string
Document Signer ID
Format
uuidResponse Body
application/json
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}Authorization
bearerAuth AuthorizationBearer <token>
In: header
Path Parameters
documentSignerId*string
Document Signer ID
Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
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}Authorization
bearerAuth AuthorizationBearer <token>
In: header
Path Parameters
documentSignerId*string
Document Signer ID
Format
uuidResponse Body
application/json
curl -X DELETE "https://example.com/v2/credentials/mobile/document-signers/497f6eca-6276-4993-bfeb-53cbbbba6f08"Empty
How would you rate this page?
Last updated on