@trinsic/api 2.3.0-alpha2 → 3.0.1

package/dist/models/SpidProviderOutput.d.ts

@@ -11,7 +11,7 @@
  */
 import type { SpidBillingInformation } from './SpidBillingInformation';
 /**
- *
+ * Exposed properties for the `italy-spid` Provider which do not directly map to the normalized IdentityData model.
  * @export
  * @interface SpidProviderOutput
  */
@@ -35,15 +35,15 @@ export interface SpidProviderOutput {
      */
     identityProviderEntityId: string;
     /**
-     * The identifier of the user's SPID credential.
+     * The identifier of the SPID credential, uniquely identifying it within the SPID federation.
      *
-     * This uniquely identifies the credential within the SPID federation.
+     * The format of this string is specific to each individual Identity Provider.
      * @type {string}
      * @memberof SpidProviderOutput
      */
     spidCode: string;
     /**
-     * Expiration date of the user's SPID credential.
+     * Expiration date of the SPID credential.
      *
      * This is not the same as the expiration date of the underlying identity document (such as a passport) which was
      * used to create the SPID identity.
@@ -52,63 +52,131 @@ export interface SpidProviderOutput {
      */
     spidCredentialExpirationDate?: Date | null;
     /**
-     * The user's place of birth.
+     * The raw, space-separated string value for the "IdCard" field from the SPID credential.
+     *
+     * Trinsic additionally parses this field and uses it to populate the `Document` object in the normalized data model.
+     * @type {string}
+     * @memberof SpidProviderOutput
+     */
+    rawIdCard?: string | null;
+    /**
+     * The individual's first / given name(s)
+     * @type {string}
+     * @memberof SpidProviderOutput
+     */
+    givenName?: string | null;
+    /**
+     * The individual's last / family name(s)
+     * @type {string}
+     * @memberof SpidProviderOutput
+     */
+    familyName?: string | null;
+    /**
+     * The date of birth of the individual
+     * @type {Date}
+     * @memberof SpidProviderOutput
+     */
+    dateOfBirth?: Date | null;
+    /**
+     * The gender of the individual.
+     *
+     * Possible values: "M" | "F"
+     * @type {string}
+     * @memberof SpidProviderOutput
+     */
+    gender?: string | null;
+    /**
+     * The individual's place of birth.
+     *
+     * This is a 4-digit Belfiore Code identifying either the municipality of birth (for births in Italy) or a foreign country (for births outside Italy).
      * @type {string}
      * @memberof SpidProviderOutput
      */
     placeOfBirth?: string | null;
     /**
-     * The user's county of birth.
+     * The individual's county (province) of birth, abbreviated.
+     *
+     * For foreign births, this is "EE".
      * @type {string}
      * @memberof SpidProviderOutput
      */
     countyOfBirth?: string | null;
     /**
-     * The raw, space-separated string value for the "IdCard" field from the SPID identity.
+     * The street address of the individual's residence.
      *
-     * Trinsic additionally parses this field and uses it to populate the `Document` object in the normalized data model.
+     * This includes street name, street type, and house number, in the standard format for the given state.
      * @type {string}
      * @memberof SpidProviderOutput
      */
-    rawIdCard?: string | null;
+    domicileStreetAddress?: string | null;
+    /**
+     * The postal code of the individual's residence
+     * @type {string}
+     * @memberof SpidProviderOutput
+     */
+    domicilePostalCode?: string | null;
+    /**
+     * The municipality of the individual's residence
+     * @type {string}
+     * @memberof SpidProviderOutput
+     */
+    domicileMunicipality?: string | null;
     /**
-     * The email address of the user.
+     * The province of the individual's residence
+     * @type {string}
+     * @memberof SpidProviderOutput
+     */
+    domicileProvince?: string | null;
+    /**
+     * The 2-digit country code of the individual's residence
+     * @type {string}
+     * @memberof SpidProviderOutput
+     */
+    domicileNation?: string | null;
+    /**
+     * The email address of the individual
      * @type {string}
      * @memberof SpidProviderOutput
      */
     email?: string | null;
     /**
-     * The digital address of the user.
+     * The mobile phone number of the individual, in Italian format.
+     * @type {string}
+     * @memberof SpidProviderOutput
+     */
+    mobilePhone?: string | null;
+    /**
+     * The PEC (Italian Certified Email) address of the individual or organization.
      * @type {string}
      * @memberof SpidProviderOutput
      */
     digitalAddress?: string | null;
     /**
-     * Fiscal tax number for the subject.
+     * Fiscal tax number for the individual.
      * @type {string}
      * @memberof SpidProviderOutput
      */
     fiscalNumber?: string | null;
     /**
-     * VAT number for the subject.
+     * The VAT number of the organization which was verified, or of the organization which the verified individual is associated with.
      * @type {string}
      * @memberof SpidProviderOutput
      */
     ivaCode?: string | null;
     /**
-     * The name of the company which the user is associated with.
+     * The name of the organization which was verified, or of the organization which the verified individual is associated with.
      * @type {string}
      * @memberof SpidProviderOutput
      */
     companyName?: string | null;
     /**
-     * The fiscal tax number of the company which the user is associated with.
+     * The fiscal tax number of the organization which was verified, or of the organization which the verified individual is associated with.
      * @type {string}
      * @memberof SpidProviderOutput
      */
     companyFiscalNumber?: string | null;
     /**
-     * The registered office address of the company which the user is associated with.
+     * The registered office address of the organization which was verified, or of the organization which the verified individual is associated with.
      * @type {string}
      * @memberof SpidProviderOutput
      */

package/dist/models/SpidProviderOutput.js

@@ -41,10 +41,20 @@ function SpidProviderOutputFromJSONTyped(json, ignoreDiscriminator) {
         'identityProviderEntityId': json['identityProviderEntityId'],
         'spidCode': json['spidCode'],
         'spidCredentialExpirationDate': json['spidCredentialExpirationDate'] == null ? undefined : (new Date(json['spidCredentialExpirationDate'])),
+        'rawIdCard': json['rawIdCard'] == null ? undefined : json['rawIdCard'],
+        'givenName': json['givenName'] == null ? undefined : json['givenName'],
+        'familyName': json['familyName'] == null ? undefined : json['familyName'],
+        'dateOfBirth': json['dateOfBirth'] == null ? undefined : (new Date(json['dateOfBirth'])),
+        'gender': json['gender'] == null ? undefined : json['gender'],
         'placeOfBirth': json['placeOfBirth'] == null ? undefined : json['placeOfBirth'],
         'countyOfBirth': json['countyOfBirth'] == null ? undefined : json['countyOfBirth'],
-        'rawIdCard': json['rawIdCard'] == null ? undefined : json['rawIdCard'],
+        'domicileStreetAddress': json['domicileStreetAddress'] == null ? undefined : json['domicileStreetAddress'],
+        'domicilePostalCode': json['domicilePostalCode'] == null ? undefined : json['domicilePostalCode'],
+        'domicileMunicipality': json['domicileMunicipality'] == null ? undefined : json['domicileMunicipality'],
+        'domicileProvince': json['domicileProvince'] == null ? undefined : json['domicileProvince'],
+        'domicileNation': json['domicileNation'] == null ? undefined : json['domicileNation'],
         'email': json['email'] == null ? undefined : json['email'],
+        'mobilePhone': json['mobilePhone'] == null ? undefined : json['mobilePhone'],
         'digitalAddress': json['digitalAddress'] == null ? undefined : json['digitalAddress'],
         'fiscalNumber': json['fiscalNumber'] == null ? undefined : json['fiscalNumber'],
         'ivaCode': json['ivaCode'] == null ? undefined : json['ivaCode'],
@@ -65,10 +75,20 @@ function SpidProviderOutputToJSONTyped(value, ignoreDiscriminator = false) {
         'identityProviderEntityId': value['identityProviderEntityId'],
         'spidCode': value['spidCode'],
         'spidCredentialExpirationDate': value['spidCredentialExpirationDate'] == null ? undefined : (value['spidCredentialExpirationDate'].toISOString().substring(0, 10)),
+        'rawIdCard': value['rawIdCard'],
+        'givenName': value['givenName'],
+        'familyName': value['familyName'],
+        'dateOfBirth': value['dateOfBirth'] == null ? undefined : (value['dateOfBirth'].toISOString().substring(0, 10)),
+        'gender': value['gender'],
         'placeOfBirth': value['placeOfBirth'],
         'countyOfBirth': value['countyOfBirth'],
-        'rawIdCard': value['rawIdCard'],
+        'domicileStreetAddress': value['domicileStreetAddress'],
+        'domicilePostalCode': value['domicilePostalCode'],
+        'domicileMunicipality': value['domicileMunicipality'],
+        'domicileProvince': value['domicileProvince'],
+        'domicileNation': value['domicileNation'],
         'email': value['email'],
+        'mobilePhone': value['mobilePhone'],
         'digitalAddress': value['digitalAddress'],
         'fiscalNumber': value['fiscalNumber'],
         'ivaCode': value['ivaCode'],

package/dist/models/SubProviderMetadata.d.ts

@@ -38,15 +38,6 @@ export interface SubProviderMetadata {
      * @memberof SubProviderMetadata
      */
     subtext: string;
-    /**
-     * The Provider's subtext recommended to be shown next to the name.
-     *
-     * This is flavor text, not a full, human-readable description of the provider.
-     * @type {string}
-     * @memberof SubProviderMetadata
-     * @deprecated
-     */
-    description: string;
     /**
      * A URL pointing to the logo on Trinsic's CDN.
      *

package/dist/models/SubProviderMetadata.js

@@ -28,8 +28,6 @@ function instanceOfSubProviderMetadata(value) {
         return false;
     if (!('subtext' in value) || value['subtext'] === undefined)
         return false;
-    if (!('description' in value) || value['description'] === undefined)
-        return false;
     if (!('logoUrl' in value) || value['logoUrl'] === undefined)
         return false;
     return true;
@@ -45,7 +43,6 @@ function SubProviderMetadataFromJSONTyped(json, ignoreDiscriminator) {
         'id': json['id'],
         'name': json['name'],
         'subtext': json['subtext'],
-        'description': json['description'],
         'logoUrl': json['logoUrl'],
     };
 }
@@ -60,7 +57,6 @@ function SubProviderMetadataToJSONTyped(value, ignoreDiscriminator = false) {
         'id': value['id'],
         'name': value['name'],
         'subtext': value['subtext'],
-        'description': value['description'],
         'logoUrl': value['logoUrl'],
     };
 }

package/dist/models/SwedenBankIdProviderOutput.d.ts

@@ -0,0 +1,110 @@
+/**
+ * Trinsic API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Exposed properties for the `sweden-bankid` Provider which do not directly map to the normalized IdentityData model.
+ * @export
+ * @interface SwedenBankIdProviderOutput
+ */
+export interface SwedenBankIdProviderOutput {
+    /**
+     * The full name of the individual.
+     * @type {string}
+     * @memberof SwedenBankIdProviderOutput
+     */
+    fullName?: string | null;
+    /**
+     * The date of birth of the individual.
+     * @type {Date}
+     * @memberof SwedenBankIdProviderOutput
+     */
+    dateOfBirth?: Date | null;
+    /**
+     * The Swedish personal number (personnummer) associated with the verified individual. The value is typically a 12-digit number.
+     * This is in the format YYYYMMDDXXXX, where:
+     * - YYYYMMDD is the date of birth.
+     * - XXXX is an individual number, indicating gender.
+     *
+     * If XXXX is even, the individual is female.
+     * If XXXX is odd, the individual is male.
+     * @type {string}
+     * @memberof SwedenBankIdProviderOutput
+     */
+    personalIdentityNumber?: string | null;
+    /**
+     * The given name of the individual
+     * @type {string}
+     * @memberof SwedenBankIdProviderOutput
+     */
+    givenName?: string | null;
+    /**
+     * The family name of the individual
+     * @type {string}
+     * @memberof SwedenBankIdProviderOutput
+     */
+    familyName?: string | null;
+    /**
+     * The end user's country on the verified certificate. This is ISO 2-character code of the country.
+     * @type {string}
+     * @memberof SwedenBankIdProviderOutput
+     */
+    country?: string | null;
+    /**
+     * The object identifier policy of the individual's verified certificate
+     * @type {string}
+     * @memberof SwedenBankIdProviderOutput
+     */
+    certificatePolicy?: string | null;
+    /**
+     * The common name of the end user's verified certificate
+     * @type {string}
+     * @memberof SwedenBankIdProviderOutput
+     */
+    commonName?: string | null;
+    /**
+     * The distinguished name of the end user's verified certificate
+     * @type {string}
+     * @memberof SwedenBankIdProviderOutput
+     */
+    distinguishedName?: string | null;
+    /**
+     * The country that issued the Swedish personal number. This is an ISO 2-character code of the country and is extracted from the certificate. This will always be `SE`.
+     * @type {string}
+     * @memberof SwedenBankIdProviderOutput
+     */
+    personalIdentityNumberIssuingCountry?: string | null;
+    /**
+     * The IP address of the device used for authentication
+     * @type {string}
+     * @memberof SwedenBankIdProviderOutput
+     */
+    authenticationDeviceIp?: string | null;
+    /**
+     * The certificate validity start date (not before) in UTC
+     * @type {Date}
+     * @memberof SwedenBankIdProviderOutput
+     */
+    notBefore?: Date | null;
+    /**
+     * The certificate validity end date (not after) in UTC
+     * @type {Date}
+     * @memberof SwedenBankIdProviderOutput
+     */
+    notAfter?: Date | null;
+}
+/**
+ * Check if a given object implements the SwedenBankIdProviderOutput interface.
+ */
+export declare function instanceOfSwedenBankIdProviderOutput(value: object): value is SwedenBankIdProviderOutput;
+export declare function SwedenBankIdProviderOutputFromJSON(json: any): SwedenBankIdProviderOutput;
+export declare function SwedenBankIdProviderOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): SwedenBankIdProviderOutput;
+export declare function SwedenBankIdProviderOutputToJSON(json: any): SwedenBankIdProviderOutput;
+export declare function SwedenBankIdProviderOutputToJSONTyped(value?: SwedenBankIdProviderOutput | null, ignoreDiscriminator?: boolean): any;

package/dist/models/SwedenBankIdProviderOutput.js

@@ -0,0 +1,72 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Trinsic API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfSwedenBankIdProviderOutput = instanceOfSwedenBankIdProviderOutput;
+exports.SwedenBankIdProviderOutputFromJSON = SwedenBankIdProviderOutputFromJSON;
+exports.SwedenBankIdProviderOutputFromJSONTyped = SwedenBankIdProviderOutputFromJSONTyped;
+exports.SwedenBankIdProviderOutputToJSON = SwedenBankIdProviderOutputToJSON;
+exports.SwedenBankIdProviderOutputToJSONTyped = SwedenBankIdProviderOutputToJSONTyped;
+/**
+ * Check if a given object implements the SwedenBankIdProviderOutput interface.
+ */
+function instanceOfSwedenBankIdProviderOutput(value) {
+    return true;
+}
+function SwedenBankIdProviderOutputFromJSON(json) {
+    return SwedenBankIdProviderOutputFromJSONTyped(json, false);
+}
+function SwedenBankIdProviderOutputFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'fullName': json['fullName'] == null ? undefined : json['fullName'],
+        'dateOfBirth': json['dateOfBirth'] == null ? undefined : (new Date(json['dateOfBirth'])),
+        'personalIdentityNumber': json['personalIdentityNumber'] == null ? undefined : json['personalIdentityNumber'],
+        'givenName': json['givenName'] == null ? undefined : json['givenName'],
+        'familyName': json['familyName'] == null ? undefined : json['familyName'],
+        'country': json['country'] == null ? undefined : json['country'],
+        'certificatePolicy': json['certificatePolicy'] == null ? undefined : json['certificatePolicy'],
+        'commonName': json['commonName'] == null ? undefined : json['commonName'],
+        'distinguishedName': json['distinguishedName'] == null ? undefined : json['distinguishedName'],
+        'personalIdentityNumberIssuingCountry': json['personalIdentityNumberIssuingCountry'] == null ? undefined : json['personalIdentityNumberIssuingCountry'],
+        'authenticationDeviceIp': json['authenticationDeviceIp'] == null ? undefined : json['authenticationDeviceIp'],
+        'notBefore': json['notBefore'] == null ? undefined : (new Date(json['notBefore'])),
+        'notAfter': json['notAfter'] == null ? undefined : (new Date(json['notAfter'])),
+    };
+}
+function SwedenBankIdProviderOutputToJSON(json) {
+    return SwedenBankIdProviderOutputToJSONTyped(json, false);
+}
+function SwedenBankIdProviderOutputToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'fullName': value['fullName'],
+        'dateOfBirth': value['dateOfBirth'] == null ? undefined : (value['dateOfBirth'].toISOString().substring(0, 10)),
+        'personalIdentityNumber': value['personalIdentityNumber'],
+        'givenName': value['givenName'],
+        'familyName': value['familyName'],
+        'country': value['country'],
+        'certificatePolicy': value['certificatePolicy'],
+        'commonName': value['commonName'],
+        'distinguishedName': value['distinguishedName'],
+        'personalIdentityNumberIssuingCountry': value['personalIdentityNumberIssuingCountry'],
+        'authenticationDeviceIp': value['authenticationDeviceIp'],
+        'notBefore': value['notBefore'] == null ? undefined : (value['notBefore'].toISOString()),
+        'notAfter': value['notAfter'] == null ? undefined : (value['notAfter'].toISOString()),
+    };
+}

package/dist/models/UgandaNidMatch2Input.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Trinsic API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface UgandaNidMatch2Input
+ */
+export interface UgandaNidMatch2Input {
+    /**
+     * The user's Uganda National ID number (NIN) - 14 alphanumeric characters
+     * @type {string}
+     * @memberof UgandaNidMatch2Input
+     */
+    idNumber?: string | null;
+    /**
+     * The card number on the document (secondary ID number).
+     * Required for Uganda Basic KYC instead of first name and last name.
+     * @type {string}
+     * @memberof UgandaNidMatch2Input
+     */
+    secondaryIdNumber?: string | null;
+    /**
+     * The user's date of birth, in `YYYY-MM-DD` format
+     * @type {Date}
+     * @memberof UgandaNidMatch2Input
+     */
+    dateOfBirth?: Date | null;
+}
+/**
+ * Check if a given object implements the UgandaNidMatch2Input interface.
+ */
+export declare function instanceOfUgandaNidMatch2Input(value: object): value is UgandaNidMatch2Input;
+export declare function UgandaNidMatch2InputFromJSON(json: any): UgandaNidMatch2Input;
+export declare function UgandaNidMatch2InputFromJSONTyped(json: any, ignoreDiscriminator: boolean): UgandaNidMatch2Input;
+export declare function UgandaNidMatch2InputToJSON(json: any): UgandaNidMatch2Input;
+export declare function UgandaNidMatch2InputToJSONTyped(value?: UgandaNidMatch2Input | null, ignoreDiscriminator?: boolean): any;

package/dist/models/UgandaNidMatch2Input.js

@@ -0,0 +1,52 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Trinsic API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfUgandaNidMatch2Input = instanceOfUgandaNidMatch2Input;
+exports.UgandaNidMatch2InputFromJSON = UgandaNidMatch2InputFromJSON;
+exports.UgandaNidMatch2InputFromJSONTyped = UgandaNidMatch2InputFromJSONTyped;
+exports.UgandaNidMatch2InputToJSON = UgandaNidMatch2InputToJSON;
+exports.UgandaNidMatch2InputToJSONTyped = UgandaNidMatch2InputToJSONTyped;
+/**
+ * Check if a given object implements the UgandaNidMatch2Input interface.
+ */
+function instanceOfUgandaNidMatch2Input(value) {
+    return true;
+}
+function UgandaNidMatch2InputFromJSON(json) {
+    return UgandaNidMatch2InputFromJSONTyped(json, false);
+}
+function UgandaNidMatch2InputFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'idNumber': json['idNumber'] == null ? undefined : json['idNumber'],
+        'secondaryIdNumber': json['secondaryIdNumber'] == null ? undefined : json['secondaryIdNumber'],
+        'dateOfBirth': json['dateOfBirth'] == null ? undefined : (new Date(json['dateOfBirth'])),
+    };
+}
+function UgandaNidMatch2InputToJSON(json) {
+    return UgandaNidMatch2InputToJSONTyped(json, false);
+}
+function UgandaNidMatch2InputToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'idNumber': value['idNumber'],
+        'secondaryIdNumber': value['secondaryIdNumber'],
+        'dateOfBirth': value['dateOfBirth'] == null ? undefined : (value['dateOfBirth'].toISOString().substring(0, 10)),
+    };
+}

package/dist/models/VerificationProfileResponse.d.ts

@@ -51,6 +51,12 @@ export interface VerificationProfileResponse {
      * @memberof VerificationProfileResponse
      */
     enabledProviders: Array<string>;
+    /**
+     * Whether this profile is for production usage. Only applicable for Live environment profiles.
+     * @type {boolean}
+     * @memberof VerificationProfileResponse
+     */
+    isProductionUsage: boolean;
 }
 /**
  * Check if a given object implements the VerificationProfileResponse interface.

package/dist/models/VerificationProfileResponse.js

@@ -34,6 +34,8 @@ function instanceOfVerificationProfileResponse(value) {
         return false;
     if (!('enabledProviders' in value) || value['enabledProviders'] === undefined)
         return false;
+    if (!('isProductionUsage' in value) || value['isProductionUsage'] === undefined)
+        return false;
     return true;
 }
 function VerificationProfileResponseFromJSON(json) {
@@ -50,6 +52,7 @@ function VerificationProfileResponseFromJSONTyped(json, ignoreDiscriminator) {
         'logoUrl': json['logoUrl'],
         'primaryColor': json['primaryColor'],
         'enabledProviders': json['enabledProviders'],
+        'isProductionUsage': json['isProductionUsage'],
     };
 }
 function VerificationProfileResponseToJSON(json) {
@@ -66,5 +69,6 @@ function VerificationProfileResponseToJSONTyped(value, ignoreDiscriminator = fal
         'logoUrl': value['logoUrl'],
         'primaryColor': value['primaryColor'],
         'enabledProviders': value['enabledProviders'],
+        'isProductionUsage': value['isProductionUsage'],
     };
 }

package/dist/models/YotiDocumentDetails.d.ts

@@ -0,0 +1,62 @@
+/**
+ * Trinsic API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface YotiDocumentDetails
+ */
+export interface YotiDocumentDetails {
+    /**
+     * The type of document used to create the Yoti credential.
+     *
+     * Possible values:
+     * - PASSPORT: A government-issued identity document
+     * - DRIVING_LICENCE: A government-issued identity card
+     * - NATIONAL_ID: A government-issued identity card
+     * - PASS_CARD: A physical or digital identity card that is accredited by the UK's national Proof of Age Standards Scheme (PASS)
+     * @type {string}
+     * @memberof YotiDocumentDetails
+     */
+    type?: string | null;
+    /**
+     * The issuing country's ISO alpha-3 code
+     * @type {string}
+     * @memberof YotiDocumentDetails
+     */
+    issuingCountry?: string | null;
+    /**
+     * The arbitrary document number for the provided document type
+     * @type {string}
+     * @memberof YotiDocumentDetails
+     */
+    documentNumber?: string | null;
+    /**
+     * The document's expiration date in YYYY-MM-DD format
+     * @type {Date}
+     * @memberof YotiDocumentDetails
+     */
+    expirationDate?: Date | null;
+    /**
+     * The document's issuing authority. This can either be a country code as a specified ISO alpha-3 or the name of the issuing authority.
+     * @type {string}
+     * @memberof YotiDocumentDetails
+     */
+    issuingAuthority?: string | null;
+}
+/**
+ * Check if a given object implements the YotiDocumentDetails interface.
+ */
+export declare function instanceOfYotiDocumentDetails(value: object): value is YotiDocumentDetails;
+export declare function YotiDocumentDetailsFromJSON(json: any): YotiDocumentDetails;
+export declare function YotiDocumentDetailsFromJSONTyped(json: any, ignoreDiscriminator: boolean): YotiDocumentDetails;
+export declare function YotiDocumentDetailsToJSON(json: any): YotiDocumentDetails;
+export declare function YotiDocumentDetailsToJSONTyped(value?: YotiDocumentDetails | null, ignoreDiscriminator?: boolean): any;