@privy-io/api-types 0.22.0 → 0.24.0

package/resources/fiat.d.ts

@@ -16,6 +16,11 @@ export interface BridgeCreateExternalFiatAccountRequestBody {
      * Discriminator: the external fiat account is orchestrated via Bridge.
      */
     provider: 'bridge';
+    /**
+     * The individual or business that owns the account. Required for `iban`, `gb`, and
+     * `swift` accounts.
+     */
+    account_owner?: ExternalFiatAccountOwner;
     /**
      * Physical address associated with an external fiat account.
      */
@@ -42,6 +47,11 @@ export interface BridgeCreateFiatDepositAccountRequestBody {
      * The source fiat currency for a fiat deposit account.
      */
     source: CreateFiatDepositAccountSource;
+    /**
+     * A developer fee as a percentage string from 0 up to (not including) 100, e.g.
+     * "1.5" for 1.5%.
+     */
+    developer_fee_percent?: DeveloperFeePercent;
     /**
      * The Privy API environment.
      */
@@ -83,6 +93,11 @@ export interface BridgeFiatDepositAccount {
      * The destination crypto asset and chain for a fiat deposit account.
      */
     destination: FiatDepositAccountDestination;
+    /**
+     * A developer fee as a percentage string from 0 up to (not including) 100, e.g.
+     * "1.5" for 1.5%.
+     */
+    developer_fee_percent: DeveloperFeePercent;
     /**
      * The Privy API environment.
      */
@@ -136,6 +151,11 @@ export interface CreateExternalFiatAccountRequestBody {
      * Discriminator: the external fiat account is orchestrated via Bridge.
      */
     provider: 'bridge';
+    /**
+     * The individual or business that owns the account. Required for `iban`, `gb`, and
+     * `swift` accounts.
+     */
+    account_owner?: ExternalFiatAccountOwner;
     /**
      * Physical address associated with an external fiat account.
      */
@@ -162,6 +182,11 @@ export interface CreateFiatDepositAccountRequestBody {
      * The source fiat currency for a fiat deposit account.
      */
     source: CreateFiatDepositAccountSource;
+    /**
+     * A developer fee as a percentage string from 0 up to (not including) 100, e.g.
+     * "1.5" for 1.5%.
+     */
+    developer_fee_percent?: DeveloperFeePercent;
     /**
      * The Privy API environment.
      */
@@ -185,7 +210,17 @@ export interface CreatePayoutRequestBody {
      * The source crypto asset, chain, and amount for a payout.
      */
     source: PayoutSource;
+    /**
+     * A developer fee as a percentage string from 0 up to (not including) 100, e.g.
+     * "1.5" for 1.5%.
+     */
+    developer_fee_percent?: DeveloperFeePercent;
 }
+/**
+ * A developer fee as a percentage string from 0 up to (not including) 100, e.g.
+ * "1.5" for 1.5%.
+ */
+export type DeveloperFeePercent = string;
 /**
  * A Bridge external fiat account linked to a user.
  */
@@ -218,6 +253,13 @@ export interface ExternalFiatAccountAddress {
     state?: string;
     street_line_2?: string;
 }
+/**
+ * A business that owns an external fiat account.
+ */
+export interface ExternalFiatAccountBusinessOwner {
+    business_name: string;
+    type: 'business';
+}
 /**
  * Bank account details. The `type` field discriminates which shape applies.
  */
@@ -255,6 +297,19 @@ export interface ExternalFiatAccountIbanData {
     country: string;
     type: 'iban';
 }
+/**
+ * An individual who owns an external fiat account.
+ */
+export interface ExternalFiatAccountIndividualOwner {
+    first_name: string;
+    last_name: string;
+    type: 'individual';
+}
+/**
+ * The individual or business that owns the account. Required for `iban`, `gb`, and
+ * `swift` accounts.
+ */
+export type ExternalFiatAccountOwner = ExternalFiatAccountIndividualOwner | ExternalFiatAccountBusinessOwner;
 /**
  * Brazilian Pix account data for an external fiat account. Provide exactly one of
  * `pix_key` or `br_code`.
@@ -343,6 +398,11 @@ export interface FiatDepositAccount {
      * The destination crypto asset and chain for a fiat deposit account.
      */
     destination: FiatDepositAccountDestination;
+    /**
+     * A developer fee as a percentage string from 0 up to (not including) 100, e.g.
+     * "1.5" for 1.5%.
+     */
+    developer_fee_percent: DeveloperFeePercent;
     /**
      * The Privy API environment.
      */
@@ -420,6 +480,203 @@ export interface FiatDepositInstructions {
  * Supported fiat payment rails.
  */
 export type FiatPaymentRail = 'sepa' | 'ach_push' | 'wire' | 'fednow' | 'faster_payments';
+/**
+ * Primary purpose the business will use the account for. Passthrough to the
+ * provider. See the
+ * [Bridge customer API reference](https://apidocs.bridge.xyz/platform/customers/customers/api)
+ * for accepted values.
+ */
+export type KYBAccountPurpose = string;
+/**
+ * A beneficial owner, control person, or signer associated with the business. At
+ * least one of has_ownership, has_control, or is_signer must be true, and the
+ * business must have at least one control person and one signer.
+ */
+export interface KYBAssociatedPerson {
+    /**
+     * Date of birth in YYYY-MM-DD format. Must be 18 years or older.
+     */
+    date_of_birth: string;
+    /**
+     * Email address.
+     */
+    email: string;
+    /**
+     * Legal first name.
+     */
+    first_name: string;
+    /**
+     * Whether this person is a control person.
+     */
+    has_control: boolean;
+    /**
+     * Whether this person owns 25% or more of the business.
+     */
+    has_ownership: boolean;
+    /**
+     * Identifying documents for this person.
+     */
+    identifying_information: Array<VerificationDocument>;
+    /**
+     * Whether this person is a signer for the business.
+     */
+    is_signer: boolean;
+    /**
+     * Legal last name.
+     */
+    last_name: string;
+    /**
+     * A postal address used in KYC and KYB data submission.
+     */
+    residential_address: VerificationAddress;
+    /**
+     * When this person (a control person) attested to having verified the business
+     * ownership structure (ISO 8601).
+     */
+    attested_ownership_structure_at?: (string & {}) | (string & {});
+    /**
+     * Supporting documents for this person, such as proof of address.
+     */
+    documents?: Array<KYBIndividualDocument>;
+    /**
+     * Whether this person is a director.
+     */
+    is_director?: boolean;
+    /**
+     * Result of a KYC/AML or OFAC screen you performed and are relying on the provider
+     * to accept, honoured only for developers enrolled in reliance.
+     */
+    kyc_screen?: KyxScreen;
+    /**
+     * Legal middle name.
+     */
+    middle_name?: string;
+    /**
+     * ISO 3166-1 alpha-3 codes for all nationalities held.
+     */
+    nationalities?: Array<string>;
+    /**
+     * Result of a KYC/AML or OFAC screen you performed and are relying on the provider
+     * to accept, honoured only for developers enrolled in reliance.
+     */
+    ofac_screen?: KyxScreen;
+    /**
+     * Percentage of the business this person owns.
+     */
+    ownership_percentage?: number;
+    /**
+     * Phone number in E.164 format.
+     */
+    phone?: string;
+    /**
+     * Place of birth for an associated person.
+     */
+    place_of_birth?: KYBPlaceOfBirth;
+    /**
+     * Date the relationship with the business was established, in YYYY-MM-DD format.
+     */
+    relationship_established_at?: string;
+    /**
+     * Job title. Required when has_control is true.
+     */
+    title?: string;
+    /**
+     * Latin-1 transliteration of the first name. Required for non-Latin-1 names.
+     */
+    transliterated_first_name?: string;
+    /**
+     * Latin-1 transliteration of the last name. Required for non-Latin-1 names.
+     */
+    transliterated_last_name?: string;
+    /**
+     * Latin-1 transliteration of the middle name. Required for non-Latin-1 names.
+     */
+    transliterated_middle_name?: string;
+    /**
+     * A postal address used in KYC and KYB data submission.
+     */
+    transliterated_residential_address?: VerificationAddress;
+    /**
+     * When you verified this person against a database source (ISO 8601).
+     */
+    verified_database_at?: (string & {}) | (string & {});
+    /**
+     * When you verified the government ID for this person (ISO 8601).
+     */
+    verified_govid_at?: (string & {}) | (string & {});
+    /**
+     * When you verified proof of address for this person (ISO 8601).
+     */
+    verified_proof_of_address_at?: (string & {}) | (string & {});
+}
+/**
+ * A supporting document for business verification.
+ */
+export interface KYBBusinessDocument {
+    /**
+     * Base64-encoded data URI of the document.
+     */
+    file: string;
+    /**
+     * What this document evidences. Supports multiple purposes per file.
+     */
+    purposes: Array<KYBDocumentPurpose>;
+    /**
+     * Document description. Required when "other" is one of the purposes.
+     */
+    description?: string;
+}
+/**
+ * Legal structure of the business. Passthrough to the provider. See the
+ * [Bridge customer API reference](https://apidocs.bridge.xyz/platform/customers/customers/api)
+ * for accepted values.
+ */
+export type KYBBusinessType = string;
+/**
+ * What a supporting business document evidences. Passthrough to the provider. See
+ * the
+ * [Bridge customer API reference](https://apidocs.bridge.xyz/platform/customers/customers/api)
+ * for accepted values.
+ */
+export type KYBDocumentPurpose = string;
+/**
+ * Estimated annual revenue of the business, in USD buckets. Passthrough to the
+ * provider. See the
+ * [Bridge customer API reference](https://apidocs.bridge.xyz/platform/customers/customers/api)
+ * for accepted values.
+ */
+export type KYBEstimatedAnnualRevenue = string;
+/**
+ * A high-risk activity the business engages in. Passthrough to the provider. See
+ * the
+ * [Bridge customer API reference](https://apidocs.bridge.xyz/platform/customers/customers/api)
+ * for accepted values.
+ */
+export type KYBHighRiskActivity = string;
+/**
+ * A supporting document for an associated person.
+ */
+export interface KYBIndividualDocument {
+    /**
+     * Base64-encoded data URI of the document.
+     */
+    file: string;
+    /**
+     * What this document evidences. Supports multiple purposes per file.
+     */
+    purposes: Array<KYBIndividualDocumentPurpose>;
+    /**
+     * Document description. Required when "other" is one of the purposes.
+     */
+    description?: string;
+}
+/**
+ * What a supporting document for an associated person evidences. Passthrough to
+ * the provider. See the
+ * [Bridge customer API reference](https://apidocs.bridge.xyz/platform/customers/customers/api)
+ * for accepted values.
+ */
+export type KYBIndividualDocumentPurpose = string;
 /**
  * Request body for initiating a hosted KYB flow for an organization.
  */
@@ -453,6 +710,64 @@ export interface KYBLinksRequestBody {
      */
     redirect_uri?: string;
 }
+/**
+ * Place of birth for an associated person.
+ */
+export interface KYBPlaceOfBirth {
+    /**
+     * ISO 3166-1 alpha-3 country code.
+     */
+    country: string;
+    /**
+     * City of birth.
+     */
+    city?: string;
+}
+/**
+ * A public exchange listing for the business.
+ */
+export interface KYBPubliclyTradedListing {
+    /**
+     * ISO 10383 market identifier code of the listing venue.
+     */
+    market_identifier_code: string;
+    /**
+     * ISIN with dashes removed.
+     */
+    stock_number: string;
+    /**
+     * Exchange ticker symbol.
+     */
+    ticker: string;
+}
+/**
+ * Details of the regulated activity a business is licensed to perform.
+ */
+export interface KYBRegulatedActivity {
+    /**
+     * License number issued by the regulator.
+     */
+    license_number: string;
+    /**
+     * ISO 3166-1 alpha-3 country code of the primary regulator.
+     */
+    primary_regulatory_authority_country: string;
+    /**
+     * Name of the primary regulator.
+     */
+    primary_regulatory_authority_name: string;
+    /**
+     * Description of the regulated activities performed.
+     */
+    regulated_activities_description: string;
+}
+/**
+ * Primary source of the funds the business will transact with. Passthrough to the
+ * provider. See the
+ * [Bridge customer API reference](https://apidocs.bridge.xyz/platform/customers/customers/api)
+ * for accepted values.
+ */
+export type KYBSourceOfFunds = string;
 /**
  * List of KYB status snapshots, one per configured provider/environment.
  */
@@ -499,63 +814,216 @@ export interface KYBStatusResponse {
     tos: KyxTosStatusDetail;
 }
 /**
- * Request body for initiating Terms of Service acceptance for an organization.
+ * KYB verification data for headless submission. Fields are individually optional
+ * because the provider accepts partial submissions and grants endorsements once
+ * enough data has arrived; a partial submission can be completed by calling the
+ * endpoint again.
  */
-export interface KYBTosRequestBody {
+export interface KYBSubmitData {
     /**
-     * Email address for the organization.
+     * Primary purpose the business will use the account for. Passthrough to the
+     * provider. See the
+     * [Bridge customer API reference](https://apidocs.bridge.xyz/platform/customers/customers/api)
+     * for accepted values.
      */
-    email: string;
+    account_purpose?: KYBAccountPurpose;
     /**
-     * KYC/KYB provider identifier.
+     * Free-text purpose. Required when account_purpose is "other".
      */
-    provider: KyxProvider;
+    account_purpose_other?: string;
     /**
-     * Legal name of the business.
+     * Whether the business moves funds on behalf of third parties.
      */
-    business_name?: string;
+    acting_as_intermediary?: boolean;
     /**
-     * Provider environment (production or sandbox).
+     * Beneficial owners, control persons, and signers.
      */
-    environment?: KyxEnvironment;
-}
-/**
- * An identity document for KYC verification.
- */
-export interface KYCIdentifyingDocument {
+    associated_persons?: Array<KYBAssociatedPerson>;
     /**
-     * ISO 3166-1 alpha-3 issuing country code.
+     * Short summary of what the business does.
      */
-    issuing_country: string;
+    business_description?: string;
     /**
-     * Document type identifier.
+     * 2022 NAICS codes describing the industries the business operates in.
      */
-    type: string;
+    business_industry?: Array<string>;
     /**
-     * Document description.
+     * Registered legal name as filed with government authorities.
      */
-    description?: string;
+    business_legal_name?: string;
     /**
-     * Document expiration date.
+     * Public trading name (DBA), if different from the legal name.
      */
-    expiration?: string;
+    business_trade_name?: string;
     /**
-     * Base64-encoded back image.
+     * Legal structure of the business. Passthrough to the provider. See the
+     * [Bridge customer API reference](https://apidocs.bridge.xyz/platform/customers/customers/api)
+     * for accepted values.
      */
-    image_back?: string;
+    business_type?: KYBBusinessType;
     /**
-     * Base64-encoded front image.
+     * Description of the AML and sanctions screening controls in place.
      */
-    image_front?: string;
+    compliance_screening_explanation?: string;
     /**
-     * Document number.
+     * Whether the business conducts money services.
      */
-    number?: string;
+    conducts_money_services?: boolean;
+    /**
+     * Description of the money services conducted.
+     */
+    conducts_money_services_description?: string;
+    /**
+     * Whether money services are conducted through the provider. Requires a
+     * flow_of_funds document when true.
+     */
+    conducts_money_services_using_bridge?: boolean;
+    /**
+     * Supporting documents for verification.
+     */
+    documents?: Array<KYBBusinessDocument>;
+    /**
+     * Primary business email address.
+     */
+    email?: string;
+    /**
+     * Estimated annual revenue of the business, in USD buckets. Passthrough to the
+     * provider. See the
+     * [Bridge customer API reference](https://apidocs.bridge.xyz/platform/customers/customers/api)
+     * for accepted values.
+     */
+    estimated_annual_revenue_usd?: KYBEstimatedAnnualRevenue;
+    /**
+     * Expected monthly payment volume in USD. Required for high-risk businesses.
+     */
+    expected_monthly_payments_usd?: number;
+    /**
+     * Whether the business is tax-registered outside its country of incorporation.
+     */
+    has_foreign_tax_registration?: boolean;
+    /**
+     * Whether an intermediate entity owner holds 25% or more of the business.
+     */
+    has_material_intermediary_ownership?: boolean;
+    /**
+     * High-risk activities the business engages in.
+     */
+    high_risk_activities?: Array<KYBHighRiskActivity>;
+    /**
+     * Explanation of the high-risk activities. Required unless the only value is
+     * "none_of_the_above".
+     */
+    high_risk_activities_explanation?: string;
+    /**
+     * Business tax and registration identifiers.
+     */
+    identifying_information?: Array<VerificationDocument>;
+    /**
+     * Date of incorporation in YYYY-MM-DD format.
+     */
+    incorporation_date?: string;
+    /**
+     * Whether the business is a decentralized autonomous organization.
+     */
+    is_dao?: boolean;
+    /**
+     * Result of a KYC/AML or OFAC screen you performed and are relying on the provider
+     * to accept, honoured only for developers enrolled in reliance.
+     */
+    kyb_screen?: KyxScreen;
+    /**
+     * Result of a KYC/AML or OFAC screen you performed and are relying on the provider
+     * to accept, honoured only for developers enrolled in reliance.
+     */
+    ofac_screen?: KyxScreen;
+    /**
+     * Whether the business operates in prohibited jurisdictions.
+     */
+    operates_in_prohibited_countries?: boolean;
+    /**
+     * Additional websites and social handles.
+     */
+    other_websites?: Array<string>;
+    /**
+     * Ownership percentage at which a person is treated as a beneficial owner.
+     */
+    ownership_threshold?: number;
+    /**
+     * Business phone number in E.164 format.
+     */
+    phone?: string;
+    /**
+     * A postal address used in KYC and KYB data submission.
+     */
+    physical_address?: VerificationAddress;
+    /**
+     * Primary website. If omitted, a proof_of_nature_of_business document is required.
+     */
+    primary_website?: string;
+    /**
+     * Public exchange listings for the business.
+     */
+    publicly_traded_listings?: Array<KYBPubliclyTradedListing>;
+    /**
+     * A postal address used in KYC and KYB data submission.
+     */
+    registered_address?: VerificationAddress;
+    /**
+     * Details of the regulated activity a business is licensed to perform.
+     */
+    regulated_activity?: KYBRegulatedActivity;
+    /**
+     * Primary source of the funds the business will transact with. Passthrough to the
+     * provider. See the
+     * [Bridge customer API reference](https://apidocs.bridge.xyz/platform/customers/customers/api)
+     * for accepted values.
+     */
+    source_of_funds?: KYBSourceOfFunds;
+    /**
+     * Free-text detail on the source of funds. Required for high-risk businesses.
+     */
+    source_of_funds_description?: string;
+    /**
+     * Latin-1 transliteration of the legal name. Required for non-Latin-1 names.
+     */
+    transliterated_business_legal_name?: string;
+    /**
+     * Latin-1 transliteration of the trade name. Required for non-Latin-1 names.
+     */
+    transliterated_business_trade_name?: string;
+    /**
+     * A postal address used in KYC and KYB data submission.
+     */
+    transliterated_physical_address?: VerificationAddress;
+    /**
+     * A postal address used in KYC and KYB data submission.
+     */
+    transliterated_registered_address?: VerificationAddress;
+    /**
+     * When you verified the business against a database source (ISO 8601).
+     */
+    verified_database_at?: (string & {}) | (string & {});
+    /**
+     * When you verified the business registration documents (ISO 8601).
+     */
+    verified_govid_at?: (string & {}) | (string & {});
+    /**
+     * When you verified the business proof of address (ISO 8601), required for EEA
+     * customers and SEPA rails under reliance.
+     */
+    verified_proof_of_address_at?: (string & {}) | (string & {});
 }
 /**
- * Request body for initiating a hosted KYC flow.
+ * Request body for headless KYB data submission.
  */
-export interface KYCLinksRequestBody {
+export interface KYBSubmitRequestBody {
+    /**
+     * KYB verification data for headless submission. Fields are individually optional
+     * because the provider accepts partial submissions and grants endorsements once
+     * enough data has arrived; a partial submission can be completed by calling the
+     * endpoint again.
+     */
+    data: KYBSubmitData;
     /**
      * KYC/KYB provider identifier.
      */
@@ -565,50 +1033,63 @@ export interface KYCLinksRequestBody {
      */
     client_agreement_id?: string;
     /**
-     * Email address for the KYC session.
-     */
-    email?: string;
-    /**
-     * Endorsements to request during KYC.
+     * Endorsements to request during KYB.
      */
     endorsements?: Array<KyxEndorsementName>;
     /**
      * Provider environment (production or sandbox).
      */
     environment?: KyxEnvironment;
+}
+/**
+ * Request body for initiating Terms of Service acceptance for an organization.
+ */
+export interface KYBTosRequestBody {
     /**
-     * URI to redirect the user after completing KYC.
+     * Email address for the organization.
      */
-    redirect_uri?: string;
+    email: string;
+    /**
+     * KYC/KYB provider identifier.
+     */
+    provider: KyxProvider;
+    /**
+     * Legal name of the business.
+     */
+    business_name?: string;
+    /**
+     * Provider environment (production or sandbox).
+     */
+    environment?: KyxEnvironment;
 }
 /**
- * Residential address for KYC data submission.
+ * Request body for initiating a hosted KYC flow.
  */
-export interface KYCResidentialAddress {
+export interface KYCLinksRequestBody {
     /**
-     * City.
+     * KYC/KYB provider identifier.
      */
-    city: string;
+    provider: KyxProvider;
     /**
-     * ISO 3166-1 alpha-3 country code.
+     * Client-side agreement ID for ToS acceptance.
      */
-    country: string;
+    client_agreement_id?: string;
     /**
-     * Street address line 1.
+     * Email address for the KYC session.
      */
-    street_line_1: string;
+    email?: string;
     /**
-     * State or province code.
+     * Endorsements to request during KYC.
      */
-    subdivision: string;
+    endorsements?: Array<KyxEndorsementName>;
     /**
-     * Postal code.
+     * Provider environment (production or sandbox).
      */
-    postal_code?: string;
+    environment?: KyxEnvironment;
     /**
-     * Street address line 2.
+     * URI to redirect the user after completing KYC.
      */
-    street_line_2?: string;
+    redirect_uri?: string;
 }
 /**
  * List of KYC status snapshots, one per configured provider/environment.
@@ -654,6 +1135,10 @@ export interface KYCStatusResponse {
      * Terms of Service acceptance status for a KYC or KYB flow.
      */
     tos: KyxTosStatusDetail;
+    /**
+     * Stripe Issuing cardholder ID assigned by Bridge for this user.
+     */
+    stripe_cardholder_id?: string;
 }
 /**
  * KYC verification data for headless submission.
@@ -662,31 +1147,90 @@ export interface KYCSubmitData {
     /**
      * Date of birth in YYYY-MM-DD format.
      */
-    date_of_birth: string;
+    date_of_birth?: string;
+    /**
+     * Email address.
+     */
+    email?: string;
     /**
      * Legal first name.
      */
-    first_name: string;
+    first_name?: string;
     /**
      * Identifying documents.
      */
-    identifying_information: Array<KYCIdentifyingDocument>;
+    identifying_information?: Array<VerificationDocument>;
+    /**
+     * Result of a KYC/AML or OFAC screen you performed and are relying on the provider
+     * to accept, honoured only for developers enrolled in reliance.
+     */
+    kyc_screen?: KyxScreen;
     /**
      * Legal last name.
      */
-    last_name: string;
+    last_name?: string;
     /**
-     * Residential address for KYC data submission.
+     * Legal middle name.
      */
-    residential_address: KYCResidentialAddress;
+    middle_name?: string;
     /**
-     * Email address.
+     * ISO 3166-1 alpha-3 codes for all nationalities held.
      */
-    email?: string;
+    nationalities?: Array<string>;
+    /**
+     * Attests the user is a nonresident alien to satisfy identification without a US
+     * tax ID (must be enabled for you).
+     */
+    nonresident_alien_attestation?: boolean;
+    /**
+     * Result of a KYC/AML or OFAC screen you performed and are relying on the provider
+     * to accept, honoured only for developers enrolled in reliance.
+     */
+    ofac_screen?: KyxScreen;
     /**
      * Phone number in E.164 format.
      */
     phone?: string;
+    /**
+     * A postal address used in KYC and KYB data submission.
+     */
+    residential_address?: VerificationAddress;
+    /**
+     * Stripe Link shared data ID that supplies name, date of birth, address, and US
+     * SSN (omit those fields); retrieval errors surface in endorsements[].issues.
+     */
+    stripe_link_shared_data_id?: string;
+    /**
+     * Latin-1 transliteration of the first name. Required for non-Latin-1 names.
+     */
+    transliterated_first_name?: string;
+    /**
+     * Latin-1 transliteration of the last name. Required for non-Latin-1 names.
+     */
+    transliterated_last_name?: string;
+    /**
+     * Latin-1 transliteration of the middle name. Required for non-Latin-1 names.
+     */
+    transliterated_middle_name?: string;
+    /**
+     * A postal address used in KYC and KYB data submission.
+     */
+    transliterated_residential_address?: VerificationAddress;
+    /**
+     * When you verified the user against a database source (ISO 8601), which loosens
+     * the identifying-document requirement under reliance.
+     */
+    verified_database_at?: (string & {}) | (string & {});
+    /**
+     * When you verified the government ID (ISO 8601), which loosens the
+     * identifying-document requirement under reliance.
+     */
+    verified_govid_at?: (string & {}) | (string & {});
+    /**
+     * When you verified proof of address (ISO 8601), required for EEA customers and
+     * SEPA rails under reliance.
+     */
+    verified_proof_of_address_at?: (string & {}) | (string & {});
 }
 /**
  * Request body for headless KYC data submission.
@@ -742,6 +1286,10 @@ export type KyxCapabilityStatus = string;
  * An endorsement with its approval status and missing requirements.
  */
 export interface KyxEndorsement {
+    /**
+     * Provider issue codes, or null if none.
+     */
+    issues: Array<string> | null;
     /**
      * Missing requirements, or null if complete.
      */
@@ -775,6 +1323,24 @@ export type KyxProvider = 'bridge';
  * KYC/KYB status for the user.
  */
 export type KyxProviderStatus = string;
+/**
+ * Result of a KYC/AML or OFAC screen you performed and are relying on the provider
+ * to accept, honoured only for developers enrolled in reliance.
+ */
+export interface KyxScreen {
+    /**
+     * Outcome of a screen performed under KYC/KYB reliance.
+     */
+    result: KyxScreenResult;
+    /**
+     * When the screen was performed (ISO 8601 date or date-time).
+     */
+    screened_at: (string & {}) | (string & {});
+}
+/**
+ * Outcome of a screen performed under KYC/KYB reliance.
+ */
+export type KyxScreenResult = 'passed' | 'failed';
 /**
  * Request body for initiating Terms of Service acceptance.
  */
@@ -1005,7 +1571,17 @@ export interface PayoutDestination {
      * The ID of a previously registered external fiat account to pay out to.
      */
     fiat_account_id: string;
+    /**
+     * A fiat payment rail a payout can settle over. `ach` is a standard ACH credit to
+     * the destination account.
+     */
+    payment_rail?: PayoutPaymentRail;
 }
+/**
+ * A fiat payment rail a payout can settle over. `ach` is a standard ACH credit to
+ * the destination account.
+ */
+export type PayoutPaymentRail = 'ach' | 'ach_same_day' | 'wire' | 'fednow' | 'sepa' | 'faster_payments' | 'pix';
 /**
  * The source crypto asset, chain, and amount for a payout.
  */
@@ -1023,7 +1599,71 @@ export interface PayoutSource {
      */
     chain: string;
 }
+/**
+ * A postal address used in KYC and KYB data submission.
+ */
+export interface VerificationAddress {
+    /**
+     * City.
+     */
+    city: string;
+    /**
+     * ISO 3166-1 alpha-3 country code.
+     */
+    country: string;
+    /**
+     * Street address line 1.
+     */
+    street_line_1: string;
+    /**
+     * Postal code. Required for countries that use them.
+     */
+    postal_code?: string;
+    /**
+     * Street address line 2.
+     */
+    street_line_2?: string;
+    /**
+     * ISO 3166-2 state or province code. Required for US addresses.
+     */
+    subdivision?: string;
+}
+/**
+ * An identifying document for KYC or KYB verification. Also used for business
+ * identifiers such as tax and registration numbers, for which the image and
+ * expiration fields do not apply.
+ */
+export interface VerificationDocument {
+    /**
+     * ISO 3166-1 alpha-3 issuing country code.
+     */
+    issuing_country: string;
+    /**
+     * Document type identifier.
+     */
+    type: string;
+    /**
+     * Document description.
+     */
+    description?: string;
+    /**
+     * Document expiration date.
+     */
+    expiration?: string;
+    /**
+     * Base64-encoded back image.
+     */
+    image_back?: string;
+    /**
+     * Base64-encoded front image.
+     */
+    image_front?: string;
+    /**
+     * Document number.
+     */
+    number?: string;
+}
 export declare namespace Fiat {
-    export { type BridgeCreateExternalFiatAccountRequestBody as BridgeCreateExternalFiatAccountRequestBody, type BridgeCreateFiatDepositAccountRequestBody as BridgeCreateFiatDepositAccountRequestBody, type BridgeExternalFiatAccount as BridgeExternalFiatAccount, type BridgeFiatDepositAccount as BridgeFiatDepositAccount, type BridgeOrganizationExternalFiatAccount as BridgeOrganizationExternalFiatAccount, type CreateExternalFiatAccountRequestBody as CreateExternalFiatAccountRequestBody, type CreateFiatDepositAccountRequestBody as CreateFiatDepositAccountRequestBody, type CreateFiatDepositAccountSource as CreateFiatDepositAccountSource, type CreatePayoutRequestBody as CreatePayoutRequestBody, type ExternalFiatAccount as ExternalFiatAccount, type ExternalFiatAccountAddress as ExternalFiatAccountAddress, type ExternalFiatAccountData as ExternalFiatAccountData, type ExternalFiatAccountGBData as ExternalFiatAccountGBData, type ExternalFiatAccountIbanData as ExternalFiatAccountIbanData, type ExternalFiatAccountPixData as ExternalFiatAccountPixData, type ExternalFiatAccountResponse as ExternalFiatAccountResponse, type ExternalFiatAccountSwiftCategory as ExternalFiatAccountSwiftCategory, type ExternalFiatAccountSwiftData as ExternalFiatAccountSwiftData, type ExternalFiatAccountSwiftPurposeOfFunds as ExternalFiatAccountSwiftPurposeOfFunds, type ExternalFiatAccountUsData as ExternalFiatAccountUsData, type FiatCurrency as FiatCurrency, type FiatDepositAccount as FiatDepositAccount, type FiatDepositAccountDestination as FiatDepositAccountDestination, type FiatDepositAccountResponse as FiatDepositAccountResponse, type FiatDepositAccountSource as FiatDepositAccountSource, type FiatDepositAccountStatus as FiatDepositAccountStatus, type FiatDepositInstructions as FiatDepositInstructions, type FiatPaymentRail as FiatPaymentRail, type KYBLinksRequestBody as KYBLinksRequestBody, type KYBStatusListResponse as KYBStatusListResponse, type KYBStatusResponse as KYBStatusResponse, type KYBTosRequestBody as KYBTosRequestBody, type KYCIdentifyingDocument as KYCIdentifyingDocument, type KYCLinksRequestBody as KYCLinksRequestBody, type KYCResidentialAddress as KYCResidentialAddress, type KYCStatusListResponse as KYCStatusListResponse, type KYCStatusResponse as KYCStatusResponse, type KYCSubmitData as KYCSubmitData, type KYCSubmitRequestBody as KYCSubmitRequestBody, type KyxCapabilities as KyxCapabilities, type KyxCapabilityStatus as KyxCapabilityStatus, type KyxEndorsement as KyxEndorsement, type KyxEndorsementName as KyxEndorsementName, type KyxEndorsementStatus as KyxEndorsementStatus, type KyxEnvironment as KyxEnvironment, type KyxProvider as KyxProvider, type KyxProviderStatus as KyxProviderStatus, type KyxTosRequestBody as KyxTosRequestBody, type KyxTosResponse as KyxTosResponse, type KyxTosStatus as KyxTosStatus, type KyxTosStatusDetail as KyxTosStatusDetail, type KyxVerificationStatus as KyxVerificationStatus, type KyxVerificationStatusDetail as KyxVerificationStatusDetail, type ListExternalFiatAccountsResponse as ListExternalFiatAccountsResponse, type ListFiatDepositAccountsResponse as ListFiatDepositAccountsResponse, type ListOrganizationExternalFiatAccountsResponse as ListOrganizationExternalFiatAccountsResponse, type OfframpDepositInstructions as OfframpDepositInstructions, type OfframpResponse as OfframpResponse, type OnrampAsset as OnrampAsset, type OnrampChain as OnrampChain, type OnrampDepositInstructions as OnrampDepositInstructions, type OnrampKYCResponse as OnrampKYCResponse, type OnrampKYCStatus as OnrampKYCStatus, type OnrampResponse as OnrampResponse, type OnrampTransferStatus as OnrampTransferStatus, type OrganizationExternalFiatAccount as OrganizationExternalFiatAccount, type OrganizationExternalFiatAccountResponse as OrganizationExternalFiatAccountResponse, type PayoutDestination as PayoutDestination, type PayoutSource as PayoutSource, };
+    export { type BridgeCreateExternalFiatAccountRequestBody as BridgeCreateExternalFiatAccountRequestBody, type BridgeCreateFiatDepositAccountRequestBody as BridgeCreateFiatDepositAccountRequestBody, type BridgeExternalFiatAccount as BridgeExternalFiatAccount, type BridgeFiatDepositAccount as BridgeFiatDepositAccount, type BridgeOrganizationExternalFiatAccount as BridgeOrganizationExternalFiatAccount, type CreateExternalFiatAccountRequestBody as CreateExternalFiatAccountRequestBody, type CreateFiatDepositAccountRequestBody as CreateFiatDepositAccountRequestBody, type CreateFiatDepositAccountSource as CreateFiatDepositAccountSource, type CreatePayoutRequestBody as CreatePayoutRequestBody, type DeveloperFeePercent as DeveloperFeePercent, type ExternalFiatAccount as ExternalFiatAccount, type ExternalFiatAccountAddress as ExternalFiatAccountAddress, type ExternalFiatAccountBusinessOwner as ExternalFiatAccountBusinessOwner, type ExternalFiatAccountData as ExternalFiatAccountData, type ExternalFiatAccountGBData as ExternalFiatAccountGBData, type ExternalFiatAccountIbanData as ExternalFiatAccountIbanData, type ExternalFiatAccountIndividualOwner as ExternalFiatAccountIndividualOwner, type ExternalFiatAccountOwner as ExternalFiatAccountOwner, type ExternalFiatAccountPixData as ExternalFiatAccountPixData, type ExternalFiatAccountResponse as ExternalFiatAccountResponse, type ExternalFiatAccountSwiftCategory as ExternalFiatAccountSwiftCategory, type ExternalFiatAccountSwiftData as ExternalFiatAccountSwiftData, type ExternalFiatAccountSwiftPurposeOfFunds as ExternalFiatAccountSwiftPurposeOfFunds, type ExternalFiatAccountUsData as ExternalFiatAccountUsData, type FiatCurrency as FiatCurrency, type FiatDepositAccount as FiatDepositAccount, type FiatDepositAccountDestination as FiatDepositAccountDestination, type FiatDepositAccountResponse as FiatDepositAccountResponse, type FiatDepositAccountSource as FiatDepositAccountSource, type FiatDepositAccountStatus as FiatDepositAccountStatus, type FiatDepositInstructions as FiatDepositInstructions, type FiatPaymentRail as FiatPaymentRail, type KYBAccountPurpose as KYBAccountPurpose, type KYBAssociatedPerson as KYBAssociatedPerson, type KYBBusinessDocument as KYBBusinessDocument, type KYBBusinessType as KYBBusinessType, type KYBDocumentPurpose as KYBDocumentPurpose, type KYBEstimatedAnnualRevenue as KYBEstimatedAnnualRevenue, type KYBHighRiskActivity as KYBHighRiskActivity, type KYBIndividualDocument as KYBIndividualDocument, type KYBIndividualDocumentPurpose as KYBIndividualDocumentPurpose, type KYBLinksRequestBody as KYBLinksRequestBody, type KYBPlaceOfBirth as KYBPlaceOfBirth, type KYBPubliclyTradedListing as KYBPubliclyTradedListing, type KYBRegulatedActivity as KYBRegulatedActivity, type KYBSourceOfFunds as KYBSourceOfFunds, type KYBStatusListResponse as KYBStatusListResponse, type KYBStatusResponse as KYBStatusResponse, type KYBSubmitData as KYBSubmitData, type KYBSubmitRequestBody as KYBSubmitRequestBody, type KYBTosRequestBody as KYBTosRequestBody, type KYCLinksRequestBody as KYCLinksRequestBody, type KYCStatusListResponse as KYCStatusListResponse, type KYCStatusResponse as KYCStatusResponse, type KYCSubmitData as KYCSubmitData, type KYCSubmitRequestBody as KYCSubmitRequestBody, type KyxCapabilities as KyxCapabilities, type KyxCapabilityStatus as KyxCapabilityStatus, type KyxEndorsement as KyxEndorsement, type KyxEndorsementName as KyxEndorsementName, type KyxEndorsementStatus as KyxEndorsementStatus, type KyxEnvironment as KyxEnvironment, type KyxProvider as KyxProvider, type KyxProviderStatus as KyxProviderStatus, type KyxScreen as KyxScreen, type KyxScreenResult as KyxScreenResult, type KyxTosRequestBody as KyxTosRequestBody, type KyxTosResponse as KyxTosResponse, type KyxTosStatus as KyxTosStatus, type KyxTosStatusDetail as KyxTosStatusDetail, type KyxVerificationStatus as KyxVerificationStatus, type KyxVerificationStatusDetail as KyxVerificationStatusDetail, type ListExternalFiatAccountsResponse as ListExternalFiatAccountsResponse, type ListFiatDepositAccountsResponse as ListFiatDepositAccountsResponse, type ListOrganizationExternalFiatAccountsResponse as ListOrganizationExternalFiatAccountsResponse, type OfframpDepositInstructions as OfframpDepositInstructions, type OfframpResponse as OfframpResponse, type OnrampAsset as OnrampAsset, type OnrampChain as OnrampChain, type OnrampDepositInstructions as OnrampDepositInstructions, type OnrampKYCResponse as OnrampKYCResponse, type OnrampKYCStatus as OnrampKYCStatus, type OnrampResponse as OnrampResponse, type OnrampTransferStatus as OnrampTransferStatus, type OrganizationExternalFiatAccount as OrganizationExternalFiatAccount, type OrganizationExternalFiatAccountResponse as OrganizationExternalFiatAccountResponse, type PayoutDestination as PayoutDestination, type PayoutPaymentRail as PayoutPaymentRail, type PayoutSource as PayoutSource, type VerificationAddress as VerificationAddress, type VerificationDocument as VerificationDocument, };
 }
 //# sourceMappingURL=fiat.d.ts.map