API ReferencemDocs credential configuration
Retrieve all mDocs configurations
GET
/v2/credentials/mobile/configurationsRetrieves all mDocs configurations from your tenant.
Roles
adminissuermanaged-issuer
Analytics Events
MOBILE_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_STARTMOBILE_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_SUCCESSMOBILE_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_FAIL
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Query Parameters
limit?number
Range size of returned list.
Range
1 <= value <= 1000Default
100cursor?string
Starting point for the list of entries.
type?string
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" } } ]}How would you rate this page?
Create an mDocs configuration POST
Creates 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.
Retrieve an mDocs configuration GET
Retrieves an existing mDocs configuration by providing its ID.