@trinsic/api 2.3.0-alpha2 → 3.0.1

package/dist/esm/models/SwedenBankIdProviderOutput.js

@@ -0,0 +1,65 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the SwedenBankIdProviderOutput interface.
+ */
+export function instanceOfSwedenBankIdProviderOutput(value) {
+    return true;
+}
+export function SwedenBankIdProviderOutputFromJSON(json) {
+    return SwedenBankIdProviderOutputFromJSONTyped(json, false);
+}
+export 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'])),
+    };
+}
+export function SwedenBankIdProviderOutputToJSON(json) {
+    return SwedenBankIdProviderOutputToJSONTyped(json, false);
+}
+export 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/esm/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/esm/models/UgandaNidMatch2Input.js

@@ -0,0 +1,45 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the UgandaNidMatch2Input interface.
+ */
+export function instanceOfUgandaNidMatch2Input(value) {
+    return true;
+}
+export function UgandaNidMatch2InputFromJSON(json) {
+    return UgandaNidMatch2InputFromJSONTyped(json, false);
+}
+export 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'])),
+    };
+}
+export function UgandaNidMatch2InputToJSON(json) {
+    return UgandaNidMatch2InputToJSONTyped(json, false);
+}
+export 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/esm/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/esm/models/VerificationProfileResponse.js

@@ -27,6 +27,8 @@ export 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;
 }
 export function VerificationProfileResponseFromJSON(json) {
@@ -43,6 +45,7 @@ export function VerificationProfileResponseFromJSONTyped(json, ignoreDiscriminat
         'logoUrl': json['logoUrl'],
         'primaryColor': json['primaryColor'],
         'enabledProviders': json['enabledProviders'],
+        'isProductionUsage': json['isProductionUsage'],
     };
 }
 export function VerificationProfileResponseToJSON(json) {
@@ -59,5 +62,6 @@ export function VerificationProfileResponseToJSONTyped(value, ignoreDiscriminato
         'logoUrl': value['logoUrl'],
         'primaryColor': value['primaryColor'],
         'enabledProviders': value['enabledProviders'],
+        'isProductionUsage': value['isProductionUsage'],
     };
 }

package/dist/esm/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;

package/dist/esm/models/YotiDocumentDetails.js

@@ -0,0 +1,49 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the YotiDocumentDetails interface.
+ */
+export function instanceOfYotiDocumentDetails(value) {
+    return true;
+}
+export function YotiDocumentDetailsFromJSON(json) {
+    return YotiDocumentDetailsFromJSONTyped(json, false);
+}
+export function YotiDocumentDetailsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'type': json['type'] == null ? undefined : json['type'],
+        'issuingCountry': json['issuingCountry'] == null ? undefined : json['issuingCountry'],
+        'documentNumber': json['documentNumber'] == null ? undefined : json['documentNumber'],
+        'expirationDate': json['expirationDate'] == null ? undefined : (new Date(json['expirationDate'])),
+        'issuingAuthority': json['issuingAuthority'] == null ? undefined : json['issuingAuthority'],
+    };
+}
+export function YotiDocumentDetailsToJSON(json) {
+    return YotiDocumentDetailsToJSONTyped(json, false);
+}
+export function YotiDocumentDetailsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'type': value['type'],
+        'issuingCountry': value['issuingCountry'],
+        'documentNumber': value['documentNumber'],
+        'expirationDate': value['expirationDate'] == null ? undefined : (value['expirationDate'].toISOString().substring(0, 10)),
+        'issuingAuthority': value['issuingAuthority'],
+    };
+}

package/dist/esm/models/YotiProviderOutput.d.ts

@@ -0,0 +1,112 @@
+/**
+ * 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.
+ */
+import type { YotiStructuredPostalAddress } from './YotiStructuredPostalAddress';
+import type { YotiDocumentDetails } from './YotiDocumentDetails';
+/**
+ * Exposed properties for the `yoti` Provider which do not directly map to the normalized IdentityData model.
+ * @export
+ * @interface YotiProviderOutput
+ */
+export interface YotiProviderOutput {
+    /**
+     * The unique id for your service of the individual. This is not shared between different services so if the user logs into a different service, the user will have a new id for the other service.
+     * @type {string}
+     * @memberof YotiProviderOutput
+     */
+    rememberMeId?: string | null;
+    /**
+     * The email address of the individual
+     * @type {string}
+     * @memberof YotiProviderOutput
+     */
+    email?: string | null;
+    /**
+     * The given name of the individual. This can correspond to first and middle names in English.
+     * @type {string}
+     * @memberof YotiProviderOutput
+     */
+    givenName?: string | null;
+    /**
+     * The family name of the individual
+     * @type {string}
+     * @memberof YotiProviderOutput
+     */
+    familyName?: string | null;
+    /**
+     * Full name of the individual which is composed of the given and family name.
+     * Unverified full name may be safe to use. For example, Aadhaar card provides full name, but due to certain limitations of verifying Aadhaar, Yoti is unable to verify this property so it is listed as "unverified".
+     * @type {string}
+     * @memberof YotiProviderOutput
+     */
+    fullName?: string | null;
+    /**
+     * The date of birth of the individual.
+     * Unverified date of birth may be safe to use. For example, Aadhaar card provides date of birth, but due to certain limitations of verifying Aadhaar, Yoti is unable to verify this property so it is listed as "unverified".
+     * @type {Date}
+     * @memberof YotiProviderOutput
+     */
+    dateOfBirth?: Date | null;
+    /**
+     * The gender of the individual. Depending on the source or country, gender may not be verified. This is a setting that can be configured while setting up scopes.
+     *
+     * Unverified gender may be safe to use. For example, Aadhaar card provides gender, but due to certain limitations of verifying Aadhaar, Yoti is unable to verify this property so it is listed as "unverified".
+     * In some countries
+     * Possible values:
+     * - "MALE"
+     * - "FEMALE"
+     * - "TRANSGENDER"
+     * - "OTHER"
+     * @type {string}
+     * @memberof YotiProviderOutput
+     */
+    gender?: string | null;
+    /**
+     * The nationality of the individual as a ISO alpha-3 code
+     * @type {string}
+     * @memberof YotiProviderOutput
+     */
+    nationality?: string | null;
+    /**
+     * The mobile phone number of the individual. This number was verified with a one time password (OTP) during the user's registration with Yoti. In some cases, Yoti may do additional checks against its sources to confirm the user's identity.
+     * @type {string}
+     * @memberof YotiProviderOutput
+     */
+    mobileNumber?: string | null;
+    /**
+     * A structured postal address for the individual that comes from the underlying document or can be manually added. In the case of being manually added, the address is considered "unverified".
+     * Unverified addresses may be safe to use. For example, Aadhaar card provides an address, but due to certain limitations of verifying Aadhaar, Yoti is unable to verify this property so it is listed as "unverified".
+     * @type {YotiStructuredPostalAddress}
+     * @memberof YotiProviderOutput
+     */
+    structuredPostalAddress?: YotiStructuredPostalAddress | null;
+    /**
+     * The whole address for the individual that comes from the underlying document or can be manually added. In the case of being manually added, the address is considered "unverified". The format of this will be different for each country.
+     * Refer to `StructuredPostalAddress` for a detailed version of the address.
+     * @type {string}
+     * @memberof YotiProviderOutput
+     */
+    postalAddress?: string | null;
+    /**
+     * The details of the underlying document used to help create the Yoti credential
+     * @type {YotiDocumentDetails}
+     * @memberof YotiProviderOutput
+     */
+    documentDetails?: YotiDocumentDetails | null;
+}
+/**
+ * Check if a given object implements the YotiProviderOutput interface.
+ */
+export declare function instanceOfYotiProviderOutput(value: object): value is YotiProviderOutput;
+export declare function YotiProviderOutputFromJSON(json: any): YotiProviderOutput;
+export declare function YotiProviderOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): YotiProviderOutput;
+export declare function YotiProviderOutputToJSON(json: any): YotiProviderOutput;
+export declare function YotiProviderOutputToJSONTyped(value?: YotiProviderOutput | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/YotiProviderOutput.js

@@ -0,0 +1,65 @@
+/* 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.
+ */
+import { YotiStructuredPostalAddressFromJSON, YotiStructuredPostalAddressToJSON, } from './YotiStructuredPostalAddress';
+import { YotiDocumentDetailsFromJSON, YotiDocumentDetailsToJSON, } from './YotiDocumentDetails';
+/**
+ * Check if a given object implements the YotiProviderOutput interface.
+ */
+export function instanceOfYotiProviderOutput(value) {
+    return true;
+}
+export function YotiProviderOutputFromJSON(json) {
+    return YotiProviderOutputFromJSONTyped(json, false);
+}
+export function YotiProviderOutputFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'rememberMeId': json['rememberMeId'] == null ? undefined : json['rememberMeId'],
+        'email': json['email'] == null ? undefined : json['email'],
+        'givenName': json['givenName'] == null ? undefined : json['givenName'],
+        'familyName': json['familyName'] == null ? undefined : json['familyName'],
+        'fullName': json['fullName'] == null ? undefined : json['fullName'],
+        'dateOfBirth': json['dateOfBirth'] == null ? undefined : (new Date(json['dateOfBirth'])),
+        'gender': json['gender'] == null ? undefined : json['gender'],
+        'nationality': json['nationality'] == null ? undefined : json['nationality'],
+        'mobileNumber': json['mobileNumber'] == null ? undefined : json['mobileNumber'],
+        'structuredPostalAddress': json['structuredPostalAddress'] == null ? undefined : YotiStructuredPostalAddressFromJSON(json['structuredPostalAddress']),
+        'postalAddress': json['postalAddress'] == null ? undefined : json['postalAddress'],
+        'documentDetails': json['documentDetails'] == null ? undefined : YotiDocumentDetailsFromJSON(json['documentDetails']),
+    };
+}
+export function YotiProviderOutputToJSON(json) {
+    return YotiProviderOutputToJSONTyped(json, false);
+}
+export function YotiProviderOutputToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'rememberMeId': value['rememberMeId'],
+        'email': value['email'],
+        'givenName': value['givenName'],
+        'familyName': value['familyName'],
+        'fullName': value['fullName'],
+        'dateOfBirth': value['dateOfBirth'] == null ? undefined : (value['dateOfBirth'].toISOString().substring(0, 10)),
+        'gender': value['gender'],
+        'nationality': value['nationality'],
+        'mobileNumber': value['mobileNumber'],
+        'structuredPostalAddress': YotiStructuredPostalAddressToJSON(value['structuredPostalAddress']),
+        'postalAddress': value['postalAddress'],
+        'documentDetails': YotiDocumentDetailsToJSON(value['documentDetails']),
+    };
+}

package/dist/esm/models/YotiStructuredPostalAddress.d.ts

@@ -0,0 +1,152 @@
+/**
+ * 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 YotiStructuredPostalAddress
+ */
+export interface YotiStructuredPostalAddress {
+    /**
+     * The address's country. This field does not have a specified format, but is recommended to use for the country field.
+     * @type {string}
+     * @memberof YotiStructuredPostalAddress
+     */
+    country?: string | null;
+    /**
+     * The address's ISO alpha-3 country code
+     * @type {string}
+     * @memberof YotiStructuredPostalAddress
+     */
+    countryIso?: string | null;
+    /**
+     * The whole address in proper order and formatted with line breaks.
+     *
+     * Examples:
+     * United Kingdom: "15a North Street\nCARSHALTON\nSM5 2HW\nUK"
+     * India: "S/O: Vipen Kumar Aggarwal\nHouse No.86-A\nRajguru Nagar\nLudhiana\nPunjab\n141012\nIndia"
+     * United States of America: "1512 Ferry Street\nAnniston AL 36201\nUSA"
+     * @type {string}
+     * @memberof YotiStructuredPostalAddress
+     */
+    formattedAddress?: string | null;
+    /**
+     * The first line of the address
+     * @type {string}
+     * @memberof YotiStructuredPostalAddress
+     */
+    line1?: string | null;
+    /**
+     * The second line of the address
+     * @type {string}
+     * @memberof YotiStructuredPostalAddress
+     */
+    line2?: string | null;
+    /**
+     * The third line of the address
+     * @type {string}
+     * @memberof YotiStructuredPostalAddress
+     */
+    line3?: string | null;
+    /**
+     * The fourth line of the address
+     * @type {string}
+     * @memberof YotiStructuredPostalAddress
+     */
+    line4?: string | null;
+    /**
+     * The address's town or city
+     * @type {string}
+     * @memberof YotiStructuredPostalAddress
+     */
+    townCity?: string | null;
+    /**
+     * The address's state. This is an optional field that may only appear for US addresses.
+     * @type {string}
+     * @memberof YotiStructuredPostalAddress
+     */
+    state?: string | null;
+    /**
+     * The address's postal code
+     * @type {string}
+     * @memberof YotiStructuredPostalAddress
+     */
+    postalCode?: string | null;
+    /**
+     * The address's building number
+     * @type {string}
+     * @memberof YotiStructuredPostalAddress
+     */
+    buildingNumber?: string | null;
+    /**
+     * The address's building name
+     * @type {string}
+     * @memberof YotiStructuredPostalAddress
+     */
+    building?: string | null;
+    /**
+     * The address's sub building or specific part of the building
+     * @type {string}
+     * @memberof YotiStructuredPostalAddress
+     */
+    subBuilding?: string | null;
+    /**
+     * The address'ss locality can be an area, a village, a region, or a known neighborhood
+     * @type {string}
+     * @memberof YotiStructuredPostalAddress
+     */
+    locality?: string | null;
+    /**
+     * The unique delivery point reference number. This is an 8-digit code used in the UK for identifying delivery addresses.
+     * @type {string}
+     * @memberof YotiStructuredPostalAddress
+     */
+    deliveryPointReferenceNumber?: string | null;
+    /**
+     * The address's landmark. A landmark is a recognizable feature or place that helps locate the address. This optional field may appear only for Indian addresses.
+     * @type {string}
+     * @memberof YotiStructuredPostalAddress
+     */
+    landmark?: string | null;
+    /**
+     * The address's subdistrict. This optional field may appear only for Indian addresses.
+     * @type {string}
+     * @memberof YotiStructuredPostalAddress
+     */
+    subdistrict?: string | null;
+    /**
+     * The address's district. This optional field may appear only for Indian addresses.
+     * @type {string}
+     * @memberof YotiStructuredPostalAddress
+     */
+    district?: string | null;
+    /**
+     * The address's post office. This optional field may appear only for Indian addresses.
+     * @type {string}
+     * @memberof YotiStructuredPostalAddress
+     */
+    postOffice?: string | null;
+    /**
+     * The address's care-of field. This indicates that mail should be delivered to an individual through another person or entity who is a known resident at the address.
+     * This optional field may appear only for Indian addresses.
+     * @type {string}
+     * @memberof YotiStructuredPostalAddress
+     */
+    careOf?: string | null;
+}
+/**
+ * Check if a given object implements the YotiStructuredPostalAddress interface.
+ */
+export declare function instanceOfYotiStructuredPostalAddress(value: object): value is YotiStructuredPostalAddress;
+export declare function YotiStructuredPostalAddressFromJSON(json: any): YotiStructuredPostalAddress;
+export declare function YotiStructuredPostalAddressFromJSONTyped(json: any, ignoreDiscriminator: boolean): YotiStructuredPostalAddress;
+export declare function YotiStructuredPostalAddressToJSON(json: any): YotiStructuredPostalAddress;
+export declare function YotiStructuredPostalAddressToJSONTyped(value?: YotiStructuredPostalAddress | null, ignoreDiscriminator?: boolean): any;