@privy-io/api-types 0.22.0 → 0.23.0

package/src/resources/fiat.ts

@@ -559,6 +559,210 @@ export interface FiatDepositInstructions {
  */
 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;
+
+  /**
+   * Supporting documents for this person, such as proof of address.
+   */
+  documents?: Array<KYBIndividualDocument>;
+
+  /**
+   * Whether this person is a director.
+   */
+  is_director?: boolean;
+
+  /**
+   * Legal middle name.
+   */
+  middle_name?: string;
+
+  /**
+   * ISO 3166-1 alpha-3 codes for all nationalities held.
+   */
+  nationalities?: Array<string>;
+
+  /**
+   * 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;
+}
+
+/**
+ * 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.
  */
@@ -599,6 +803,74 @@ 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.
  */
@@ -656,74 +928,233 @@ export interface KYBStatusResponse {
 }
 
 /**
- * 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;
-}
+  associated_persons?: Array<KYBAssociatedPerson>;
 
-/**
- * An identity document for KYC verification.
- */
-export interface KYCIdentifyingDocument {
   /**
-   * 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;
+
+  /**
+   * 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;
 }
 
 /**
- * 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.
    */
@@ -735,12 +1166,7 @@ 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>;
 
@@ -748,46 +1174,66 @@ export interface KYCLinksRequestBody {
    * 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;
 }
 
 /**
@@ -853,37 +1299,73 @@ 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>;
 
   /**
    * 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;
 
   /**
    * Phone number in E.164 format.
    */
   phone?: string;
+
+  /**
+   * A postal address used in KYC and KYB data submission.
+   */
+  residential_address?: VerificationAddress;
+
+  /**
+   * 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;
 }
 
 /**
@@ -1325,6 +1807,83 @@ 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,
@@ -1355,13 +1914,26 @@ export declare namespace Fiat {
     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 KYCIdentifyingDocument as KYCIdentifyingDocument,
     type KYCLinksRequestBody as KYCLinksRequestBody,
-    type KYCResidentialAddress as KYCResidentialAddress,
     type KYCStatusListResponse as KYCStatusListResponse,
     type KYCStatusResponse as KYCStatusResponse,
     type KYCSubmitData as KYCSubmitData,
@@ -1396,5 +1968,7 @@ export declare namespace Fiat {
     type OrganizationExternalFiatAccountResponse as OrganizationExternalFiatAccountResponse,
     type PayoutDestination as PayoutDestination,
     type PayoutSource as PayoutSource,
+    type VerificationAddress as VerificationAddress,
+    type VerificationDocument as VerificationDocument,
   };
 }