/** * Fireblocks API * Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain. - Visit our website for more information: [Fireblocks Website](https://fireblocks.com) - Visit our developer docs: [Fireblocks DevPortal](https://developers.fireblocks.com) * * The version of the OpenAPI document: 1.6.2 * Contact: developers@fireblocks.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import { TravelRuleIssuers } from './travel-rule-issuers'; import { TravelRuleVASPCompliancePhaseData } from './travel-rule-vaspcompliance-phase-data'; import { TravelRuleVASPExternalEntityConfig } from './travel-rule-vaspexternal-entity-config'; /** * A VASP record from the Travel Rule trust framework directory. The set of keys returned depends on the `fields` query parameter. When `fields` is omitted, or supplied with an empty value, this endpoint returns the complete record. Additional fields may be present in the response beyond those documented here. Clients must ignore unrecognised fields rather than failing to deserialize. * @export * @interface TravelRuleVASP */ export interface TravelRuleVASP { /** * The Decentralized Identifier (DID) of the VASP. * @type {string} * @memberof TravelRuleVASP */ 'did': string; /** * The name of the VASP. * @type {string} * @memberof TravelRuleVASP */ 'name': string; /** * The current verification status of the VASP. * @type {string} * @memberof TravelRuleVASP */ 'verificationStatus': string; /** * The first line of the VASP\'s address. * @type {string} * @memberof TravelRuleVASP */ 'addressLine1': string; /** * The city where the VASP is located. * @type {string} * @memberof TravelRuleVASP */ 'city': string; /** * The country where the VASP is registered (ISO-3166 Alpha-2 code). * @type {string} * @memberof TravelRuleVASP */ 'country': string; /** * The email domains associated with the VASP. The field\'s type is string; its content is a JSON-encoded array of domains. Clients must parse this value to obtain the array. * @type {string} * @memberof TravelRuleVASP */ 'emailDomains': string; /** * The official website of the VASP. * @type {string} * @memberof TravelRuleVASP */ 'website': string; /** * The legal structure of the VASP (e.g., Corporation, LLC). * @type {string} * @memberof TravelRuleVASP */ 'legalStructure': string; /** * The legal name of the VASP. * @type {string} * @memberof TravelRuleVASP */ 'legalName': string; /** * The year the VASP was founded. Returned as a string, not an integer. * @type {string} * @memberof TravelRuleVASP */ 'yearFounded': string; /** * The country where the VASP is incorporated (ISO-3166 Alpha-2 code). * @type {string} * @memberof TravelRuleVASP */ 'incorporationCountry': string; /** * Indicates whether the VASP is regulated. * @type {string} * @memberof TravelRuleVASP */ 'isRegulated': string; /** * The jurisdictions where the VASP operates. * @type {string} * @memberof TravelRuleVASP */ 'jurisdictions': string; /** * Travel rule compliance status for TRLight. * @type {string} * @memberof TravelRuleVASP */ 'travelRule_TRLIGHT': string; /** * Timestamp when the VASP record was created. * @type {string} * @memberof TravelRuleVASP */ 'createdAt': string; /** * Indicates if the VASP has an admin. * @type {boolean} * @memberof TravelRuleVASP */ 'hasAdmin': boolean; /** * Indicates if the VASP is notifiable for compliance reasons. * @type {boolean} * @memberof TravelRuleVASP */ 'isNotifiable': boolean; /** * * @type {TravelRuleIssuers} * @memberof TravelRuleVASP */ 'issuers': TravelRuleIssuers; /** * The second line of the VASP\'s address (if applicable). May be null. * @type {string} * @memberof TravelRuleVASP */ 'addressLine2'?: string | null; /** * URL to the logo of the VASP. May be null. * @type {string} * @memberof TravelRuleVASP */ 'logo'?: string | null; /** * Other names the VASP is known by. May be null. * @type {string} * @memberof TravelRuleVASP */ 'otherNames'?: string | null; /** * The type of identification used by the VASP. * @type {string} * @memberof TravelRuleVASP */ 'identificationType'?: string; /** * The country of identification for the VASP (ISO-3166 Alpha-2 code). May be null. * @type {string} * @memberof TravelRuleVASP */ 'identificationCountry'?: string | null; /** * The business registration number of the VASP. * @type {string} * @memberof TravelRuleVASP */ 'businessNumber'?: string; /** * The regulatory authorities overseeing the VASP. May be null. * @type {string} * @memberof TravelRuleVASP */ 'regulatoryAuthorities'?: string | null; /** * The division of the VASP\'s registered address, where applicable. * @type {string} * @memberof TravelRuleVASP */ 'division'?: string | null; /** * The street name where the VASP is located. May be null. * @type {string} * @memberof TravelRuleVASP */ 'street'?: string | null; /** * The building number of the VASP\'s address. May be returned as an empty string when not supplied. * @type {string} * @memberof TravelRuleVASP */ 'number'?: string; /** * The unit or suite number of the VASP\'s address. May be null. * @type {string} * @memberof TravelRuleVASP */ 'unit'?: string | null; /** * The postal code of the VASP\'s location. * @type {string} * @memberof TravelRuleVASP */ 'postCode'?: string; /** * The state or region where the VASP is located. * @type {string} * @memberof TravelRuleVASP */ 'state'?: string; /** * Alternative legal names of the VASP, as a comma-separated list. Resolved from an external registry, so it is only populated for VASPs with a resolved entity record. * @type {string} * @memberof TravelRuleVASP */ 'otherLegalName'?: string | null; /** * Timestamp of the last synchronization with the GLEIF registry. Only populated for VASPs with a GLEIF-resolved LEI. * @type {string} * @memberof TravelRuleVASP */ 'gleifUpdatedAt'?: string | null; /** * The VASP\'s Legal Entity Identifier (LEI), a 20-character alphanumeric code. Only populated for VASPs with a GLEIF-resolved LEI. * @type {string} * @memberof TravelRuleVASP */ 'leiNumber'?: string | null; /** * The GLEIF Entity Legal Form (ELF) code of the VASP. Only populated for VASPs with a GLEIF-resolved LEI. * @type {string} * @memberof TravelRuleVASP */ 'legalForm'?: string | null; /** * The GLEIF entity category of the VASP. Only populated for VASPs with a GLEIF-resolved LEI. * @type {string} * @memberof TravelRuleVASP */ 'entityCategory'?: string | null; /** * The GLEIF entity status of the VASP. Only populated for VASPs with a GLEIF-resolved LEI. * @type {string} * @memberof TravelRuleVASP */ 'entityStatus'?: string | null; /** * Entity records resolved from external registries, such as GLEIF. Only populated for VASPs that have been resolved against at least one external registry. * @type {Array} * @memberof TravelRuleVASP */ 'externalEntityConfig'?: Array | null; /** * The street of the VASP\'s headquarters address. Only populated for VASPs with a GLEIF-resolved LEI. * @type {string} * @memberof TravelRuleVASP */ 'hqStreet'?: string | null; /** * The building number of the VASP\'s headquarters address. May be returned as an empty string as well as `null` when not supplied. * @type {string} * @memberof TravelRuleVASP */ 'hqNumber'?: string | null; /** * The postal code of the VASP\'s headquarters address. Only populated for VASPs with a GLEIF-resolved LEI. * @type {string} * @memberof TravelRuleVASP */ 'hqPostcode'?: string | null; /** * The region of the VASP\'s headquarters address, as an ISO-3166-2 subdivision code. Only populated for VASPs with a GLEIF-resolved LEI. * @type {string} * @memberof TravelRuleVASP */ 'hqRegion'?: string | null; /** * The city of the VASP\'s headquarters address. Only populated for VASPs with a GLEIF-resolved LEI. * @type {string} * @memberof TravelRuleVASP */ 'hqCity'?: string | null; /** * The country of the VASP\'s headquarters address (ISO-3166 Alpha-2 code). Only populated for VASPs with a GLEIF-resolved LEI. * @type {string} * @memberof TravelRuleVASP */ 'hqCountry'?: string | null; /** * Certificates or licenses held by the VASP. May be null. * @type {string} * @memberof TravelRuleVASP */ 'certificates'?: string | null; /** * A brief description of the VASP. May be null. * @type {string} * @memberof TravelRuleVASP */ 'description'?: string | null; /** * Travel rule compliance status for OpenVASP. Null when the VASP does not support this protocol. * @type {string} * @memberof TravelRuleVASP */ 'travelRule_OPENVASP'?: string | null; /** * Travel rule compliance status for Sygna. Null when the VASP does not support this protocol. * @type {string} * @memberof TravelRuleVASP */ 'travelRule_SYGNA'?: string | null; /** * Travel rule compliance status for TRISA. Null when the VASP does not support this protocol. * @type {string} * @memberof TravelRuleVASP */ 'travelRule_TRISA'?: string | null; /** * Travel rule compliance status for EMAIL. Null when the VASP does not support this protocol. * @type {string} * @memberof TravelRuleVASP */ 'travelRule_EMAIL'?: string | null; /** * Travel rule compliance status for TRP. Null when the VASP does not support this protocol. * @type {string} * @memberof TravelRuleVASP */ 'travelRule_TRP'?: string | null; /** * Travel rule compliance status for Shyft. Null when the VASP does not support this protocol. * @type {string} * @memberof TravelRuleVASP */ 'travelRule_SHYFT'?: string | null; /** * Travel rule compliance status for US Travel Rule WG. Null when the VASP does not support this protocol. * @type {string} * @memberof TravelRuleVASP */ 'travelRule_USTRAVELRULEWG'?: string | null; /** * The DID of the party that created the VASP record. May be null. * @type {string} * @memberof TravelRuleVASP */ 'createdBy'?: string | null; /** * Timestamp of the last update to the VASP record. * @type {string} * @memberof TravelRuleVASP */ 'updatedAt'?: string; /** * The DID of the party that last updated the VASP record. * @type {string} * @memberof TravelRuleVASP */ 'updatedBy'?: string; /** * The last date a transaction was sent by the VASP. * @type {string} * @memberof TravelRuleVASP */ 'lastSentDate'?: string; /** * The last date a transaction was received by the VASP. * @type {string} * @memberof TravelRuleVASP */ 'lastReceivedDate'?: string; /** * Documents associated with the VASP. May be null. * @type {string} * @memberof TravelRuleVASP */ 'documents'?: string | null; /** * The regulatory status of the VASP, as free text. * @type {string} * @memberof TravelRuleVASP */ 'regulatoryStatus'?: string | null; /** * The supervisory authority responsible for the VASP. * @type {string} * @memberof TravelRuleVASP */ 'supervisoryAuthority'?: string | null; /** * The identifier of the VASP\'s registration or operating license. * @type {string} * @memberof TravelRuleVASP */ 'registrationLicenseId'?: string | null; /** * The date the VASP\'s current regulatory status took effect. * @type {string} * @memberof TravelRuleVASP */ 'statusStartDate'?: string | null; /** * The date the VASP\'s current regulatory status expires. * @type {string} * @memberof TravelRuleVASP */ 'statusExpirationDate'?: string | null; /** * Timestamp of the last verification of the VASP\'s regulatory status. * @type {string} * @memberof TravelRuleVASP */ 'lastChecked'?: string | null; /** * Additional free-text information about the VASP. * @type {string} * @memberof TravelRuleVASP */ 'additionalInformation'?: string | null; /** * The DID of the parent VASP, when this VASP is a subsidiary of another. * @type {string} * @memberof TravelRuleVASP */ 'subsidiaryOf'?: string | null; /** * The VASP\'s public PII encryption key, published in the trust framework directory. Use it to encrypt IVMS101 personally identifiable information addressed to this VASP. * @type {string} * @memberof TravelRuleVASP */ 'pii_didkey'?: string | null; /** * The VASP\'s current compliance onboarding phase. * @type {number} * @memberof TravelRuleVASP */ 'compliancePhase'?: number | null; /** * * @type {TravelRuleVASPCompliancePhaseData} * @memberof TravelRuleVASP */ 'compliancePhaseData'?: TravelRuleVASPCompliancePhaseData | null; /** * The VASP\'s VASPnet identifier. * @type {string} * @memberof TravelRuleVASP */ 'vaspnetId'?: string | null; /** * Timestamp of the last synchronization with VASPnet. * @type {string} * @memberof TravelRuleVASP */ 'vaspnetUpdatedAt'?: string | null; /** * Names of the fields that are managed by VASPnet and cannot be modified locally. Empty when no fields are locked. * @type {Array} * @memberof TravelRuleVASP */ 'vaspnetImmutableFields'?: Array | null; /** * The public key of the Travel Rule node serving this VASP record. The format has not been confirmed against a live response; every observed value has been null. * @type {string} * @memberof TravelRuleVASP */ 'node_didkey'?: string | null; /** * The VASP\'s Due Diligence Questionnaire, as a JSON-encoded string containing a `data` object and an `updatedAt` timestamp. Clients must parse this value. * @type {string} * @memberof TravelRuleVASP */ 'ddq'?: string | null; /** * The Travel Rule protocol used to reach this VASP, when a specific one is configured. * @type {string} * @memberof TravelRuleVASP */ 'targetProtocol'?: string | null; /** * The DID of the gateway VASP that routes messages on this VASP\'s behalf. * @type {string} * @memberof TravelRuleVASP */ 'parentGateway'?: string | null; /** * Indicates if the VASP actively sends Travel Rule transfers. * @type {boolean} * @memberof TravelRuleVASP */ 'isActiveSender'?: boolean | null; /** * Indicates if the VASP actively receives Travel Rule transfers. * @type {boolean} * @memberof TravelRuleVASP */ 'isActiveReceiver'?: boolean | null; /** * The VASP\'s subsidiary entities. The element schema is not yet documented, as no response containing a populated value has been observed; do not assume a particular element type. * @type {Array} * @memberof TravelRuleVASP */ 'subsidiaries'?: Array | null; }