Import credential schema

Imports a shared credential schema to a mobile verifier. These schemas can be used to create proof schemas.

Make an HTTP request on the URL retrieved from the shared credential schema to preview the schema. To import, pass the schema along with the organization ID of the mobile verifier.

Function

React Native

importCredentialSchema(request: ImportCredentialSchemaRequest): Promise<CredentialSchema["id"]>

iOS

func importCredentialSchema(request: ImportCredentialSchemaRequestBindingDto) throws  -> String

Android

fun `importCredentialSchema`(`request`: ImportCredentialSchemaRequestBindingDto): kotlin.String

Parameters

React Native

export interface ImportCredentialSchemaRequest {
  organisationId: string,
  schema: ImportCredentialSchemaRequestSchema
}

export interface ImportCredentialSchemaRequestSchema {
  id: string;
  createdDate: string;
  lastModified: string;
  name: string;
  format: string;
  revocationMethod: string;
  organisationId: string;
  importedSourceUrl: string;
  claims: ImportCredentialSchemaClaimSchema[];
  walletStorageType?: WalletStorageType;
  schemaId: string;
  schemaType: CredentialSchemaType;
  layoutType?: LayoutType;
  layoutProperties?: ImportCredentialSchemaLayoutProperties;
  allowSuspension?: boolean;
}

iOS

public struct ImportCredentialSchemaRequestBindingDto {
    public var organisationId: String
    public var schema: ImportCredentialSchemaRequestSchemaBindingDto
}

public struct ImportCredentialSchemaRequestSchemaBindingDto {
    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 organisationId: String
    public var importedSourceUrl: String
    public var claims: [ImportCredentialSchemaClaimSchemaBindingDto]
    public var walletStorageType: WalletStorageTypeBindingEnum?
    public var schemaId: String
    public var schemaType: CredentialSchemaTypeBindingEnum
    public var layoutType: LayoutTypeBindingEnum?
    public var layoutProperties: ImportCredentialSchemaLayoutPropertiesBindingDto?
    public var allowSuspension: Bool?
}

Android

data class ImportCredentialSchemaRequestBindingDto (
    var `organisationId`: kotlin.String,
    var `schema`: ImportCredentialSchemaRequestSchemaBindingDto
)

data class ImportCredentialSchemaRequestSchemaBindingDto (
    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 `organisationId`: kotlin.String,
    var `importedSourceUrl`: kotlin.String,
    var `claims`: List<ImportCredentialSchemaClaimSchemaBindingDto>,
    var `walletStorageType`: WalletStorageTypeBindingEnum?,
    var `schemaId`: kotlin.String,
    var `schemaType`: CredentialSchemaTypeBindingEnum,
    var `layoutType`: LayoutTypeBindingEnum?,
    var `layoutProperties`: ImportCredentialSchemaLayoutPropertiesBindingDto?,
    var `allowSuspension`: kotlin.Boolean?
)

Fields

• url - URL of the shared proof schema, typically from a QR code.

• organisationId - The organization ID of the mobile verifier.

Return value

The uuid of the imported credential schema is returned.