light-mode-image
Learn
API ReferencemDocs credential configuration

Retrieve an mDocs configuration

Roles

adminissuermanaged-issuer

Analytics Events

MOBILE_CREDENTIAL_CONFIGURATION_RETRIEVE_STARTMOBILE_CREDENTIAL_CONFIGURATION_RETRIEVE_SUCCESSMOBILE_CREDENTIAL_CONFIGURATION_RETRIEVE_FAIL
GET/v2/credentials/mobile/configurations/{id}

Retrieves an existing mDocs configuration by providing its ID.

Analytic events

  • MOBILE_CREDENTIAL_CONFIGURATION_RETRIEVE_START
  • MOBILE_CREDENTIAL_CONFIGURATION_RETRIEVE_SUCCESS
  • MOBILE_CREDENTIAL_CONFIGURATION_RETRIEVE_FAIL

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

mDocs configuration ID

Formatuuid

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v2/credentials/mobile/configurations/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "branding": {    "name": "string",    "description": "string",    "backgroundColor": "string",    "watermarkImage": "string",    "issuerLogo": "string",    "issuerIcon": "string"  },  "includeStatus": false,  "type": "string",  "claimMappings": {    "additionalProperties": {      "additionalProperties": {        "mapFrom": "string",        "type": "boolean",        "required": false,        "defaultValue": "string",        "display": [          {            "name": "string",            "locale": "string"          }        ]      }    }  },  "claimSourceId": "78e1b90c-401d-45bb-89c0-938da4d44c60",  "expiresIn": {    "years": 0,    "months": 0,    "weeks": 0,    "days": 0,    "hours": 0,    "minutes": 0,    "seconds": 0  },  "validFrom": {    "mapFrom": "string"  },  "validUntil": {    "mapFrom": "string"  }}

How would you rate this page?

Retrieve all mDocs configurations GET

Retrieves all mDocs configurations from your tenant. ### **Analytic events** * MOBILE_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_START * MOBILE_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_SUCCESS * MOBILE_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_FAIL

Update an mDocs configuration PUT

Updates an existing mDocs configuration by providing its ID. ### **Analytic events** * MOBILE_CREDENTIAL_CONFIGURATION_UPDATE_START * MOBILE_CREDENTIAL_CONFIGURATION_UPDATE_SUCCESS * MOBILE_CREDENTIAL_CONFIGURATION_UPDATE_FAIL