mDocs Credentials
Create an mDocs Credential configuration
/v2/credentials/mobile/configurationsCreates a new mDocs configuration, a specific set of rules and parameters that are used to create and validate a particular type of verifiable credential. These rules and parameters define how the credential is structured and what data it contains when issued.
Roles
Analytics Events
Authorization
bearerAuth In: header
Request Body
application/json
The mDocs configuration payload
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://example.com/v2/credentials/mobile/configurations" \ -H "Content-Type: application/json" \ -d '{}'{ "id": "983c0a86-204f-4431-9371-f5a22e506599", "branding": { "name": "Credential name", "description": "Credential Description", "backgroundColor": "#FFFFFF", "watermarkImage": "data:image/png;base64,{image-data}", "issuerLogo": "data:image/png;base64,{image-data}", "issuerIcon": "data:image/svg+xml;base64,{image-data}" }, "includeStatus": true, "type": "org.iso.18013.5.1.mDL", "claimMappings": { "org.iso.18013.5.1": { "given_name": { "mapFrom": "claims.given_name", "required": true, "type": "string", "display": [ { "name": "Given Name", "locale": "en-US" }, { "name": "Vorname", "locale": "de-DE" } ] }, "birth_date": { "mapFrom": "claims.date_of_birth", "required": true, "type": "dateTime" } } }, "claimSourceId": "78e1b90c-401d-45bb-89c0-938da4d44c60", "expiresIn": { "years": 0, "months": 1, "weeks": 0, "days": 0, "hours": 0, "minutes": 0, "seconds": 0 }, "validFrom": { "mapFrom": "string" }, "validUntil": { "mapFrom": "string" }}Retrieve all mDocs Credential configurations
/v2/credentials/mobile/configurationsRetrieves all mDocs configurations from your tenant.
Roles
Analytics Events
Authorization
bearerAuth In: header
Query Parameters
Range size of returned list.
1 <= value <= 1000100Starting point for the list of entries.
Optional credential type to filter on
Response Body
application/json
application/json
curl -X GET "https://example.com/v2/credentials/mobile/configurations"{ "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM", "data": [ { "id": "983c0a86-204f-4431-9371-f5a22e506599", "branding": { "name": "Credential name", "description": "Credential Description", "backgroundColor": "#FFFFFF", "watermarkImage": "data:image/png;base64,{image-data}", "issuerLogo": "data:image/png;base64,{image-data}", "issuerIcon": "data:image/svg+xml;base64,{image-data}" }, "includeStatus": true, "type": "org.iso.18013.5.1.mDL", "claimMappings": { "org.iso.18013.5.1": { "given_name": { "mapFrom": "claims.given_name", "required": true, "type": "string", "display": [ { "name": "Given Name", "locale": "en-US" }, { "name": "Vorname", "locale": "de-DE" } ] }, "birth_date": { "mapFrom": "claims.date_of_birth", "required": true, "type": "dateTime" } } }, "claimSourceId": "78e1b90c-401d-45bb-89c0-938da4d44c60", "expiresIn": { "years": 0, "months": 1, "weeks": 0, "days": 0, "hours": 0, "minutes": 0, "seconds": 0 }, "validFrom": { "mapFrom": "string" }, "validUntil": { "mapFrom": "string" } } ]}Retrieve an mDocs Credential configuration
/v2/credentials/mobile/configurations/{id}Retrieves an existing mDocs configuration by providing its ID.
Roles
Analytics Events
Authorization
bearerAuth In: header
Path Parameters
mDocs configuration ID
uuidResponse Body
application/json
application/json
application/json
curl -X GET "https://example.com/v2/credentials/mobile/configurations/3948c40e-6e19-4ffc-933c-91f643f24264"{ "id": "983c0a86-204f-4431-9371-f5a22e506599", "branding": { "name": "Credential name", "description": "Credential Description", "backgroundColor": "#FFFFFF", "watermarkImage": "data:image/png;base64,{image-data}", "issuerLogo": "data:image/png;base64,{image-data}", "issuerIcon": "data:image/svg+xml;base64,{image-data}" }, "includeStatus": true, "type": "org.iso.18013.5.1.mDL", "claimMappings": { "org.iso.18013.5.1": { "given_name": { "mapFrom": "claims.given_name", "required": true, "type": "string", "display": [ { "name": "Given Name", "locale": "en-US" }, { "name": "Vorname", "locale": "de-DE" } ] }, "birth_date": { "mapFrom": "claims.date_of_birth", "required": true, "type": "dateTime" } } }, "claimSourceId": "78e1b90c-401d-45bb-89c0-938da4d44c60", "expiresIn": { "years": 0, "months": 1, "weeks": 0, "days": 0, "hours": 0, "minutes": 0, "seconds": 0 }, "validFrom": { "mapFrom": "string" }, "validUntil": { "mapFrom": "string" }}Update an mDocs Credential configuration
/v2/credentials/mobile/configurations/{id}Updates an existing mDocs configuration by providing its ID.
Roles
Analytics Events
Authorization
bearerAuth In: header
Path Parameters
mDocs configuration ID
uuidRequest Body
application/json
Update an mDocs configuration
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/configurations/3948c40e-6e19-4ffc-933c-91f643f24264" \ -H "Content-Type: application/json" \ -d '{}'{ "id": "983c0a86-204f-4431-9371-f5a22e506599", "branding": { "name": "Credential name", "description": "Credential Description", "backgroundColor": "#FFFFFF", "watermarkImage": "data:image/png;base64,{image-data}", "issuerLogo": "data:image/png;base64,{image-data}", "issuerIcon": "data:image/svg+xml;base64,{image-data}" }, "includeStatus": true, "type": "org.iso.18013.5.1.mDL", "claimMappings": { "org.iso.18013.5.1": { "given_name": { "mapFrom": "claims.given_name", "required": true, "type": "string", "display": [ { "name": "Given Name", "locale": "en-US" }, { "name": "Vorname", "locale": "de-DE" } ] }, "birth_date": { "mapFrom": "claims.date_of_birth", "required": true, "type": "dateTime" } } }, "claimSourceId": "78e1b90c-401d-45bb-89c0-938da4d44c60", "expiresIn": { "years": 0, "months": 1, "weeks": 0, "days": 0, "hours": 0, "minutes": 0, "seconds": 0 }, "validFrom": { "mapFrom": "string" }, "validUntil": { "mapFrom": "string" }}Delete an mDocs Credential configuration
/v2/credentials/mobile/configurations/{id}Deletes an existing mDocs configuration by providing its ID.
Roles
Analytics Events
Authorization
bearerAuth In: header
Path Parameters
mDocs configuration ID
uuidResponse Body
application/json
application/json
curl -X DELETE "https://example.com/v2/credentials/mobile/configurations/3948c40e-6e19-4ffc-933c-91f643f24264"How would you rate this page?
Last updated on