# CredentialTypes

Artifact: [androidx.credentials.providerevents:providerevents](https://developer.android.com/jetpack/androidx/releases/credentials-providerevents) [View Source](https://cs.android.com/search?q=file:androidx/credentials/providerevents/transfer/CredentialTypes.kt+class:androidx.credentials.providerevents.transfer.CredentialTypes) Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/credentials-providerevents#1.0.0-beta01)

*** ** * ** ***


```
public static class CredentialTypes
```

<br />

*** ** * ** ***

The credential types that can be transferred as part of the FIDO Credential Exchange Format (CXF) protocol. More about these types can found [here](https://fidoalliance.org/specs/cx/cxf-v1.0-rd-20250313.html#credentialtype). The constants defined in this file list the frequently used credential types in CXF, and are not intended to be the exhaustive list.

## Summary

| ### Constants |
|---|---|
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/credentials/providerevents/transfer/CredentialTypes#CREDENTIAL_TYPE_ADDRESS()` An address credential provides information for autofilling address forms. |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/credentials/providerevents/transfer/CredentialTypes#CREDENTIAL_TYPE_API_KEY()` A APIKey credential contains information to interact with an Application's Programming Interface (API). |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/credentials/providerevents/transfer/CredentialTypes#CREDENTIAL_TYPE_BASIC_AUTH()` A username/password login credential |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/credentials/providerevents/transfer/CredentialTypes#CREDENTIAL_TYPE_CREDIT_CARD()` A CreditCard credential contains information about a credit or debit card. |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/credentials/providerevents/transfer/CredentialTypes#CREDENTIAL_TYPE_CUSTOM_FIELDS()` This credential allows the user to add additional information to the item organized as a grouping that MAY have a label. |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/credentials/providerevents/transfer/CredentialTypes#CREDENTIAL_TYPE_DRIVERS_LICENSE()` A DriversLicense credential contains information about a person's driver's license. |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/credentials/providerevents/transfer/CredentialTypes#CREDENTIAL_TYPE_FILE()` A file credential acts as a placeholder to an arbitrary binary file holding its associated metadata. |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/credentials/providerevents/transfer/CredentialTypes#CREDENTIAL_TYPE_GENERATED_PASSWORD()` A GeneratedPassword credential type represents a credential consisting of a machine-generated password. |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/credentials/providerevents/transfer/CredentialTypes#CREDENTIAL_TYPE_IDENTITY_DOCUMENT()` An IdentityDocument credential is for any document, card, or number identifying a person or entity. |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/credentials/providerevents/transfer/CredentialTypes#CREDENTIAL_TYPE_ITEM_REFERENCE()` An ItemReference credential is a pointer to another Item, denoting that the two items MAY be logically linked together. |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/credentials/providerevents/transfer/CredentialTypes#CREDENTIAL_TYPE_NOTE()` A note credential is a user-defined value encoded as a UTF-8 string |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/credentials/providerevents/transfer/CredentialTypes#CREDENTIAL_TYPE_PASSPORT()` A Passport credential contains the details of a person's passport. |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/credentials/providerevents/transfer/CredentialTypes#CREDENTIAL_TYPE_PERSON_NAME()` A PersonName credential represents a person's name. |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/credentials/providerevents/transfer/CredentialTypes#CREDENTIAL_TYPE_PUBLIC_KEY()` A public key credential |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/credentials/providerevents/transfer/CredentialTypes#CREDENTIAL_TYPE_SSH_KEY()` An SSHKey credential represents an SSH (Secure Shell) key pair. |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/credentials/providerevents/transfer/CredentialTypes#CREDENTIAL_TYPE_TOTP()` A TOTP is a time-based one-time password |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/credentials/providerevents/transfer/CredentialTypes#CREDENTIAL_TYPE_WIFI()` A wifi credential provides the necessary information to connect to a Wi-Fi network. |

| ### Public fields |
|---|---|
| `static @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/credentials/providerevents/transfer/CredentialTypes` | `https://developer.android.com/reference/androidx/credentials/providerevents/transfer/CredentialTypes#INSTANCE()` |

## Constants

### CREDENTIAL_TYPE_ADDRESS

Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/credentials-providerevents#1.0.0-beta01)

```
public static final @NonNull String CREDENTIAL_TYPE_ADDRESS
```

An address credential provides information for autofilling address forms.

### CREDENTIAL_TYPE_API_KEY

Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/credentials-providerevents#1.0.0-beta01)

```
public static final @NonNull String CREDENTIAL_TYPE_API_KEY
```

A APIKey credential contains information to interact with an Application's Programming Interface (API).

### CREDENTIAL_TYPE_BASIC_AUTH

Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/credentials-providerevents#1.0.0-beta01)

```
public static final @NonNull String CREDENTIAL_TYPE_BASIC_AUTH
```

A username/password login credential

### CREDENTIAL_TYPE_CREDIT_CARD

Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/credentials-providerevents#1.0.0-beta01)

```
public static final @NonNull String CREDENTIAL_TYPE_CREDIT_CARD
```

A CreditCard credential contains information about a credit or debit card.

### CREDENTIAL_TYPE_CUSTOM_FIELDS

Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/credentials-providerevents#1.0.0-beta01)

```
public static final @NonNull String CREDENTIAL_TYPE_CUSTOM_FIELDS
```

This credential allows the user to add additional information to the item organized as a grouping that MAY have a label. If the exporting provider allows custom fields to be added to items but does not have a grouping concept, it SHOULD use this object without setting the label or id fields.

### CREDENTIAL_TYPE_DRIVERS_LICENSE

Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/credentials-providerevents#1.0.0-beta01)

```
public static final @NonNull String CREDENTIAL_TYPE_DRIVERS_LICENSE
```

A DriversLicense credential contains information about a person's driver's license.

### CREDENTIAL_TYPE_FILE

Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/credentials-providerevents#1.0.0-beta01)

```
public static final @NonNull String CREDENTIAL_TYPE_FILE
```

A file credential acts as a placeholder to an arbitrary binary file holding its associated metadata.

### CREDENTIAL_TYPE_GENERATED_PASSWORD

Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/credentials-providerevents#1.0.0-beta01)

```
public static final @NonNull String CREDENTIAL_TYPE_GENERATED_PASSWORD
```

A GeneratedPassword credential type represents a credential consisting of a machine-generated password.

### CREDENTIAL_TYPE_IDENTITY_DOCUMENT

Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/credentials-providerevents#1.0.0-beta01)

```
public static final @NonNull String CREDENTIAL_TYPE_IDENTITY_DOCUMENT
```

An IdentityDocument credential is for any document, card, or number identifying a person or entity. Examples include national ID cards, Social Security Numbers (SSN), Tax Identification Numbers (TIN), health insurance cards, or Value-Added Tax (VAT) numbers.

### CREDENTIAL_TYPE_ITEM_REFERENCE

Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/credentials-providerevents#1.0.0-beta01)

```
public static final @NonNull String CREDENTIAL_TYPE_ITEM_REFERENCE
```

An ItemReference credential is a pointer to another Item, denoting that the two items MAY be logically linked together.

### CREDENTIAL_TYPE_NOTE

Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/credentials-providerevents#1.0.0-beta01)

```
public static final @NonNull String CREDENTIAL_TYPE_NOTE
```

A note credential is a user-defined value encoded as a UTF-8 string

### CREDENTIAL_TYPE_PASSPORT

Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/credentials-providerevents#1.0.0-beta01)

```
public static final @NonNull String CREDENTIAL_TYPE_PASSPORT
```

A Passport credential contains the details of a person's passport.

### CREDENTIAL_TYPE_PERSON_NAME

Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/credentials-providerevents#1.0.0-beta01)

```
public static final @NonNull String CREDENTIAL_TYPE_PERSON_NAME
```

A PersonName credential represents a person's name.

### CREDENTIAL_TYPE_PUBLIC_KEY

Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/credentials-providerevents#1.0.0-beta01)

```
public static final @NonNull String CREDENTIAL_TYPE_PUBLIC_KEY
```

A public key credential

### CREDENTIAL_TYPE_SSH_KEY

Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/credentials-providerevents#1.0.0-beta01)

```
public static final @NonNull String CREDENTIAL_TYPE_SSH_KEY
```

An SSHKey credential represents an SSH (Secure Shell) key pair.

### CREDENTIAL_TYPE_TOTP

Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/credentials-providerevents#1.0.0-beta01)

```
public static final @NonNull String CREDENTIAL_TYPE_TOTP
```

A TOTP is a time-based one-time password

### CREDENTIAL_TYPE_WIFI

Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/credentials-providerevents#1.0.0-beta01)

```
public static final @NonNull String CREDENTIAL_TYPE_WIFI
```

A wifi credential provides the necessary information to connect to a Wi-Fi network.

## Public fields

### INSTANCE

Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/credentials-providerevents#1.0.0-beta01)

```
public static @NonNull CredentialTypes INSTANCE
```