@digitalpersona/core/dist/api/docs/core.md

DigitalPersona Web Access Core library

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@digitalpersona/core](./core.md)

## core package

## Classes

|  Class | Description |
|  --- | --- |
|  [Answer](./core.answer.md) | An answer to a security question. |
|  [Base32](./core.base32.md) | Set of converters to Base32. |
|  [Base64](./core.base64.md) | Set of converters to Base64. |
|  [Base64Url](./core.base64url.md) | Set of converters to Base64Url. |
|  [BioSample](./core.biosample.md) | A biometric sample. |
|  [BioSampleFormat](./core.biosampleformat.md) | Biometric sample format info. |
|  [BioSampleHeader](./core.biosampleheader.md) | Contains meta-information about biometric sample data. |
|  [Credential](./core.credential.md) | Credential data. |
|  [FaceImage](./core.faceimage.md) | Face image data. |
|  [Finger](./core.finger.md) | Finger enrollment data. |
|  [JWT](./core.jwt.md) | Represents a JSON Web Token and gives access to the token's payload. Note that this class does not allow to validate the token signature in the browser, it must be done on a server side. |
|  [Question](./core.question.md) | Security question data. |
|  [Ticket](./core.ticket.md) | A structure wrapping a JSON Web Token to pass it to the DigitalPersona Web Components services. |
|  [Url](./core.url.md) | Provides a way to construct sanitized URLs from a base URL, a path and a query object |
|  [User](./core.user.md) | Represents a user's identity using a user's name name and a type of the name. This class is typially used to pass a user name during authentication. |
|  [Utf16](./core.utf16.md) | Set of converters to UTF16. |
|  [Utf8](./core.utf8.md) | Set of converters to UTF8. |

## Enumerations

|  Enumeration | Description |
|  --- | --- |
|  [BioFactor](./core.biofactor.md) | Biometric factors. |
|  [BioSampleEncryption](./core.biosampleencryption.md) | A biometric sample encryption type. |
|  [BioSampleFormatOwner](./core.biosampleformatowner.md) | Biometric owner ID registered with [IBIA](http://www.ibia.org/base/cbeff/_biometric_org.phpx)<!-- -->. |
|  [BioSamplePurpose](./core.biosamplepurpose.md) | A purpose the biometric sample was intended for. |
|  [BioSampleType](./core.biosampletype.md) | A representation type of a biometric sample. |
|  [ClaimName](./core.claimname.md) | Enumerate publicly registered and private DigitalPersona claim names. |
|  [FaceImageType](./core.faceimagetype.md) | Format of a face image sample. |
|  [FingerPosition](./core.fingerposition.md) | Positions of fingers. |
|  [QuestionType](./core.questiontype.md) | Type of a security question. |
|  [UserNameType](./core.usernametype.md) | Enumerates supported username formats. |

## Interfaces

|  Interface | Description |
|  --- | --- |
|  [ClaimSet](./core.claimset.md) | Set of claims passed in a JSON Web Token. |
|  [CredentialUsed](./core.credentialused.md) | Claim information about a credential used. See [ClaimSet.crd](./core.claimset.crd.md)<!-- -->. |
|  [QuestionWithAnswer](./core.questionwithanswer.md) | A structure associating a sequrity question with its corresponding answer. |

## Type Aliases

|  Type Alias | Description |
|  --- | --- |
|  [Answers](./core.answers.md) | A collection on answers to security questions. |
|  [Base32String](./core.base32string.md) | Branded alias type for Base32-encoded strings. |
|  [Base64String](./core.base64string.md) | Branded alias type for Base64-encoded strings. |
|  [Base64UrlString](./core.base64urlstring.md) | Branded alias type for Base64Url-encoded strings. |
|  [ClaimNames](./core.claimnames.md) | Alias type representing all claim names, as if <code>type ClaimNames = &quot;jti&quot; &#124; &quot;iss&quot; &#124; &quot;iat&quot; &#124; &quot;aud&quot; &#124; ... &#124; &quot;wan&quot; &#124; &quot;t24&quot;;</code> |
|  [CredentialId](./core.credentialid.md) | Branded alias type for credential identifier strings. |
|  [Fingers](./core.fingers.md) | Collection of finger enrollment data. |
|  [HexString](./core.hexstring.md) | Branded alias type for Hex-encoded strings. |
|  [JSONWebToken](./core.jsonwebtoken.md) | Branded alias type for a string representing a JSON Web Token. |
|  [QuestionNumber](./core.questionnumber.md) |  |
|  [Questions](./core.questions.md) | A collection of security questions. |
|  [Utf16String](./core.utf16string.md) | Branded alias type for UTF16-encoded strings. |
|  [Utf8String](./core.utf8string.md) | Branded alias type for UTF8-encoded strings. |