Get credential schema details

Returns details on a credential schema.

Function

React Native

getCredentialSchema(credentialSchemaId: CredentialSchema["id"]): Promise<CredentialSchemaDetail>

iOS

func getCredentialSchema(credentialSchemaId: String) throws  -> CredentialSchemaDetailBindingDto

Android

fun `getCredentialSchema`(`credentialSchemaId`: kotlin.String): CredentialSchemaDetailBindingDto

Parameters

• credentialSchemaId - UUID of credential schema.

Return value

React Native

export interface CredentialSchemaDetail {
  id: string;
  createdDate: string;
  lastModified: string;
  name: string;
  format: string;
  revocationMethod: string;
  claims: ClaimSchema[],
  walletStorageType?: WalletStorageType;
  schemaId: string;
  schemaType: CredentialSchemaType;
  layoutType?: LayoutType;
  layoutProperties?: CredentialSchemaLayoutProperties;
}

export interface ClaimSchema {
    id: string;
    createdDate: string;
    lastModified: string;
    key: string;
    datatype: string;
    required: boolean;
    array?: boolean;
    claims: ClaimSchema[];
}

iOS

public struct CredentialSchemaDetailBindingDto {
    public var id: String
    public var createdDate: String
    public var lastModified: String
    public var name: String
    public var format: String
    public var revocationMethod: String
    public var claims: [CredentialClaimSchemaBindingDto]
    public var walletStorageType: WalletStorageTypeBindingEnum?
    public var schemaId: String
    public var schemaType: CredentialSchemaTypeBindingEnum
    public var layoutType: LayoutTypeBindingEnum?
    public var layoutProperties: CredentialSchemaLayoutPropertiesBindingDto?
}

public struct CredentialClaimSchemaBindingDto {
    public var id: String
    public var createdDate: String
    public var lastModified: String
    public var required: Bool
    public var key: String
    public var array: Bool
    public var datatype: String
    public var claims: [CredentialClaimSchemaBindingDto]
}

Android

data class CredentialSchemaDetailBindingDto (
    var `id`: kotlin.String,
    var `createdDate`: kotlin.String,
    var `lastModified`: kotlin.String,
    var `name`: kotlin.String,
    var `format`: kotlin.String,
    var `revocationMethod`: kotlin.String,
    var `claims`: List<CredentialClaimSchemaBindingDto>,
    var `walletStorageType`: WalletStorageTypeBindingEnum?,
    var `schemaId`: kotlin.String,
    var `schemaType`: CredentialSchemaTypeBindingEnum,
    var `layoutType`: LayoutTypeBindingEnum?,
    var `layoutProperties`: CredentialSchemaLayoutPropertiesBindingDto?
)

data class CredentialClaimSchemaBindingDto (
    var `id`: kotlin.String,
    var `createdDate`: kotlin.String,
    var `lastModified`: kotlin.String,
    var `required`: kotlin.Boolean,
    var `key`: kotlin.String,
    var `array`: kotlin.Boolean,
    var `datatype`: kotlin.String,
    var `claims`: List<CredentialClaimSchemaBindingDto>
)

Fields

• format - Credential format of the credentials issued using this schema.

• revocationMethod - Revocation method of credentials issued using this schema, if any.

• claims - The set of claims being asserted when using this credential schema.

• walletStorageType - Wallet storage type requested by the verifier, if any. See the wallet storage type guide.

  • [HARDWARE, SOFTWARE]

• schemaId - The identifier of the credential schema used to issue this credential.

• schemaType - Specifies the structure of the data in the credential. See the credentialSchema property guide.

• layoutType - Represents the visual structure of the credential in the wallet. The details of the design of the credential (for credentials issued by Procivis One) are found in the CredentialSchemaDetail of the get credential details function. For more information on the display properties of Procivis One credentials, see the credentials designer guide.

  • [CARD, DOCUMENT, SINGLE_ATTRIBUTE]

• layoutProperties for layoutType CARD - Intended visual design of the credential.

  • background - Background image

  • logo -

  • primaryAttribute - Attribute which should be prioritized visually.

  • secondaryAttribute - Secondary attribute to prioritize visually.

  • pictureAttribute - Specified picture attribute to display.

  • code - Specified attribute to encode and display as a code. Note that this encoding is not verifiable.

    • Supported code types: [BARCODE, MRZ, QR_CODE]