@blindpay/node 3.10.0 → 3.11.0

package/dist/resources/customers/index.d.mts

@@ -0,0 +1,466 @@
+import { P as PaginationParams, C as Country, B as BlindpayApiResponse, A as AccountClass, K as KycStatus, e as AccountPurpose, S as SourceOfFundsDocType, d as BusinessIndustry, E as EstimatedAnnualRevenue, f as SourceOfWealth, g as RecipientRelationship, h as SoleProprietorDocType, i as PurposeOfTransactions, j as PaginationMetadata, k as BusinessType } from '../../index.d-CGeWvXXq.mjs';
+import { I as InternalApiClient } from '../../api-client-DYqrodZr.mjs';
+import { S as StrictOmit } from '../../strict-omit-ByJhzKNC.mjs';
+
+type CustomerProofOfAddressDocType = "UTILITY_BILL" | "BANK_STATEMENT" | "RENTAL_AGREEMENT" | "TAX_DOCUMENT" | "GOVERNMENT_CORRESPONDENCE";
+type CustomerIdentificationDocument = "PASSPORT" | "ID_CARD" | "DRIVERS";
+type CustomerAmlStatus = "clear" | "hit" | "error";
+type CustomerAmlHits = {
+    has_sanction_match: boolean;
+    has_pep_match: boolean;
+    has_watchlist_match: boolean;
+    has_crimelist_match: boolean;
+    has_adversemedia_match: boolean;
+};
+type CustomerFraudWarning = {
+    id: string | null;
+    name: string | null;
+    operation: string | null;
+    score: number | null;
+};
+type CustomerOwnerTaxType = "SSN" | "ITIN";
+type CustomerKycType = "light" | "standard" | "enhanced";
+type CustomerOwnerRole = "beneficial_controlling" | "beneficial_owner" | "controlling_person";
+type CustomerOwner = {
+    id: string;
+    role: CustomerOwnerRole;
+    first_name: string;
+    last_name: string;
+    date_of_birth: string;
+    tax_id: string;
+    address_line_1: string;
+    address_line_2: string | null;
+    city: string;
+    state_province_region: string;
+    country: Country;
+    postal_code: string;
+    id_doc_country: Country;
+    id_doc_type: CustomerIdentificationDocument;
+    id_doc_front_file: string;
+    id_doc_back_file: string | null;
+    proof_of_address_doc_type: CustomerProofOfAddressDocType;
+    proof_of_address_doc_file: string | null;
+    ownership_percentage: number | null;
+    title: string | null;
+    tax_type?: CustomerOwnerTaxType | null;
+    instance_id?: string;
+    customer_id?: string;
+};
+type CustomerIndividualWithStandardKYC = {
+    id: string;
+    is_tos_accepted: boolean;
+    type: Extract<AccountClass, "individual">;
+    kyc_type: Extract<CustomerKycType, "standard">;
+    kyc_status: KycStatus;
+    kyc_warnings: Array<{
+        code: string | null;
+        message: string | null;
+        resolution_status: string | null;
+        warning_id: string | null;
+    }> | null;
+    email: string;
+    tax_id: string;
+    address_line_1: string;
+    address_line_2?: string | null;
+    city: string;
+    state_province_region: string;
+    country: Country;
+    postal_code: string;
+    ip_address: string | null;
+    image_url: string | null;
+    phone_number: string;
+    proof_of_address_doc_type: CustomerProofOfAddressDocType;
+    proof_of_address_doc_file: string;
+    first_name: string;
+    last_name: string;
+    date_of_birth: string;
+    id_doc_country: Country;
+    id_doc_type: CustomerIdentificationDocument;
+    id_doc_front_file: string;
+    id_doc_back_file: string;
+    aiprise_validation_key: string;
+    instance_id: string;
+    tos_id: string | null;
+    created_at: string;
+    updated_at: string;
+    limit: {
+        per_transaction: number;
+        daily: number;
+        monthly: number;
+    };
+    fraud_warnings?: CustomerFraudWarning[] | null;
+    aml_status?: CustomerAmlStatus | null;
+    aml_hits?: CustomerAmlHits | null;
+    account_purpose?: AccountPurpose | null;
+    account_purpose_other?: string | null;
+    occupation?: string | null;
+    external_id?: string | null;
+    is_fbo?: boolean | null;
+    selfie_file?: string | null;
+    source_of_funds_doc_type?: SourceOfFundsDocType | null;
+    source_of_funds_doc_file?: string | null;
+    business_description?: string | null;
+    business_industry?: BusinessIndustry | null;
+    estimated_annual_revenue?: EstimatedAnnualRevenue | null;
+    source_of_wealth?: SourceOfWealth | null;
+    recipient_relationship?: RecipientRelationship | null;
+    sole_proprietor_doc_type?: SoleProprietorDocType | null;
+    publicly_traded?: boolean | null;
+};
+type CustomerIndividualWithEnhancedKYC = {
+    id: string;
+    is_tos_accepted: boolean;
+    type: Extract<AccountClass, "individual">;
+    kyc_type: Extract<CustomerKycType, "enhanced">;
+    kyc_status: KycStatus;
+    kyc_warnings: Array<{
+        code: string | null;
+        message: string | null;
+        resolution_status: string | null;
+        warning_id: string | null;
+    }> | null;
+    email: string;
+    tax_id: string;
+    address_line_1: string;
+    address_line_2?: string | null;
+    city: string;
+    state_province_region: string;
+    country: Country;
+    postal_code: string;
+    ip_address: string | null;
+    image_url: string | null;
+    phone_number: string | null;
+    proof_of_address_doc_type: CustomerProofOfAddressDocType;
+    proof_of_address_doc_file: string;
+    first_name: string;
+    last_name: string;
+    date_of_birth: string;
+    id_doc_country: Country;
+    id_doc_type: CustomerIdentificationDocument;
+    id_doc_front_file: string;
+    id_doc_back_file: string | null;
+    aiprise_validation_key: string;
+    instance_id: string;
+    source_of_funds_doc_type: string;
+    source_of_funds_doc_file: string;
+    individual_holding_doc_front_file: string;
+    purpose_of_transactions: PurposeOfTransactions;
+    purpose_of_transactions_explanation: string | null;
+    tos_id: string | null;
+    created_at: string;
+    updated_at: string;
+    limit: {
+        per_transaction: number;
+        daily: number;
+        monthly: number;
+    };
+    fraud_warnings?: CustomerFraudWarning[] | null;
+    aml_status?: CustomerAmlStatus | null;
+    aml_hits?: CustomerAmlHits | null;
+    account_purpose?: AccountPurpose | null;
+    account_purpose_other?: string | null;
+    occupation?: string | null;
+    external_id?: string | null;
+    is_fbo?: boolean | null;
+    selfie_file?: string | null;
+    business_description?: string | null;
+    business_industry?: BusinessIndustry | null;
+    estimated_annual_revenue?: EstimatedAnnualRevenue | null;
+    source_of_wealth?: SourceOfWealth | null;
+    recipient_relationship?: RecipientRelationship | null;
+    sole_proprietor_doc_type?: SoleProprietorDocType | null;
+    publicly_traded?: boolean | null;
+};
+type CustomerBusinessWithStandardKYB = {
+    id: string;
+    is_tos_accepted: boolean;
+    is_fbo: boolean;
+    type: Extract<AccountClass, "business">;
+    kyc_type: Extract<CustomerKycType, "standard">;
+    kyc_status: KycStatus;
+    kyc_warnings: Array<{
+        code: string | null;
+        message: string | null;
+        resolution_status: string | null;
+        warning_id: string | null;
+    }> | null;
+    email: string;
+    tax_id: string;
+    address_line_1: string;
+    address_line_2?: string | null;
+    city: string;
+    state_province_region: string;
+    country: Country;
+    postal_code: string;
+    ip_address: string | null;
+    image_url: string | null;
+    phone_number: string | null;
+    proof_of_address_doc_type: CustomerProofOfAddressDocType;
+    proof_of_address_doc_file: string;
+    legal_name: string;
+    alternate_name: string | null;
+    formation_date: string;
+    website: string | null;
+    owners: CustomerOwner[];
+    incorporation_doc_file: string;
+    proof_of_ownership_doc_file: string;
+    external_id: string | null;
+    instance_id: string;
+    tos_id: string | null;
+    aiprise_validation_key: string;
+    created_at: string;
+    updated_at: string;
+    limit: {
+        per_transaction: number;
+        daily: number;
+        monthly: number;
+    };
+    fraud_warnings?: CustomerFraudWarning[] | null;
+    aml_status?: CustomerAmlStatus | null;
+    aml_hits?: CustomerAmlHits | null;
+    account_purpose?: AccountPurpose | null;
+    account_purpose_other?: string | null;
+    occupation?: string | null;
+    selfie_file?: string | null;
+    source_of_funds_doc_type?: SourceOfFundsDocType | null;
+    source_of_funds_doc_file?: string | null;
+    business_description?: string | null;
+    business_industry?: BusinessIndustry | null;
+    estimated_annual_revenue?: EstimatedAnnualRevenue | null;
+    source_of_wealth?: SourceOfWealth | null;
+    recipient_relationship?: RecipientRelationship | null;
+    sole_proprietor_doc_type?: SoleProprietorDocType | null;
+};
+type CreateCustomerIndividualWithStandardKYCInput = {
+    country: Country;
+    email: string;
+    account_purpose?: AccountPurpose | null;
+    address_line_1?: string | null;
+    address_line_2?: string | null;
+    city?: string | null;
+    date_of_birth?: string | null;
+    external_id?: string | null;
+    first_name?: string | null;
+    id_doc_back_file?: string | null;
+    id_doc_country?: Country | null;
+    id_doc_front_file?: string | null;
+    id_doc_type?: CustomerIdentificationDocument | null;
+    image_url?: string | null;
+    ip_address?: string | null;
+    last_name?: string | null;
+    phone_number?: string | null;
+    postal_code?: string | null;
+    proof_of_address_doc_file?: string | null;
+    proof_of_address_doc_type?: CustomerProofOfAddressDocType | null;
+    selfie_file?: string | null;
+    source_of_funds_doc_file?: string | null;
+    source_of_funds_doc_type?: SourceOfFundsDocType | null;
+    source_of_wealth?: SourceOfWealth | null;
+    state_province_region?: string | null;
+    tax_id?: string | null;
+    tos_id?: string | null;
+    account_purpose_other?: string | null;
+    occupation?: string | null;
+    recipient_relationship?: RecipientRelationship | null;
+    sole_proprietor_doc_type?: SoleProprietorDocType | null;
+};
+type CreateCustomerIndividualWithStandardKYCResponse = {
+    id: string;
+};
+type CreateCustomerIndividualWithEnhancedKYCInput = {
+    country: Country;
+    email: string;
+    account_purpose?: AccountPurpose | null;
+    address_line_1?: string | null;
+    address_line_2?: string | null;
+    city?: string | null;
+    date_of_birth?: string | null;
+    external_id?: string | null;
+    first_name?: string | null;
+    id_doc_back_file?: string | null;
+    id_doc_country?: Country | null;
+    id_doc_front_file?: string | null;
+    id_doc_type?: CustomerIdentificationDocument | null;
+    image_url?: string | null;
+    ip_address?: string | null;
+    last_name?: string | null;
+    phone_number?: string | null;
+    postal_code?: string | null;
+    proof_of_address_doc_file?: string | null;
+    proof_of_address_doc_type?: CustomerProofOfAddressDocType | null;
+    purpose_of_transactions?: PurposeOfTransactions | null;
+    purpose_of_transactions_explanation?: string | null;
+    selfie_file?: string | null;
+    source_of_funds_doc_file?: string | null;
+    source_of_funds_doc_type?: SourceOfFundsDocType | null;
+    source_of_wealth?: SourceOfWealth | null;
+    state_province_region?: string | null;
+    tax_id?: string | null;
+    tos_id?: string | null;
+    account_purpose_other?: string | null;
+    occupation?: string | null;
+    recipient_relationship?: RecipientRelationship | null;
+    sole_proprietor_doc_type?: SoleProprietorDocType | null;
+};
+type CreateCustomerIndividualWithEnhancedKYCResponse = {
+    id: string;
+};
+type CreateCustomerBusinessWithStandardKYBInput = {
+    country: Country;
+    email: string;
+    account_purpose?: AccountPurpose | null;
+    address_line_1?: string | null;
+    address_line_2?: string | null;
+    alternate_name?: string | null;
+    business_description?: string | null;
+    business_industry?: BusinessIndustry | null;
+    business_type?: BusinessType | null;
+    city?: string | null;
+    estimated_annual_revenue?: EstimatedAnnualRevenue | null;
+    external_id?: string | null;
+    formation_date?: string | null;
+    image_url?: string | null;
+    incorporation_doc_file?: string | null;
+    ip_address?: string | null;
+    legal_name?: string | null;
+    owners?: Array<StrictOmit<CustomerOwner, "id">> | null;
+    phone_number?: string | null;
+    postal_code?: string | null;
+    proof_of_address_doc_file?: string | null;
+    proof_of_address_doc_type?: CustomerProofOfAddressDocType | null;
+    proof_of_ownership_doc_file?: string | null;
+    publicly_traded?: boolean | null;
+    source_of_funds_doc_file?: string | null;
+    source_of_funds_doc_type?: SourceOfFundsDocType | null;
+    source_of_wealth?: SourceOfWealth | null;
+    state_province_region?: string | null;
+    tax_id?: string | null;
+    tos_id?: string | null;
+    website?: string | null;
+    account_purpose_other?: string | null;
+    occupation?: string | null;
+    recipient_relationship?: RecipientRelationship | null;
+    sole_proprietor_doc_type?: SoleProprietorDocType | null;
+};
+type CreateCustomerBusinessWithStandardKYBResponse = {
+    id: string;
+};
+type ListCustomersInput = PaginationParams & {
+    full_name?: string;
+    customer_name?: string;
+    status?: string;
+    customer_id?: string;
+    bank_account_id?: string;
+    country?: Country;
+};
+type ListCustomersResponse = {
+    data: Array<CustomerIndividualWithStandardKYC | CustomerIndividualWithEnhancedKYC | CustomerBusinessWithStandardKYB>;
+    pagination: PaginationMetadata;
+};
+type GetCustomerInput = string;
+type GetCustomerResponse = CustomerIndividualWithStandardKYC | CustomerIndividualWithEnhancedKYC | CustomerBusinessWithStandardKYB;
+type UpdateCustomerInput = {
+    customer_id: string;
+    account_purpose?: AccountPurpose | null;
+    address_line_1?: string;
+    address_line_2?: string;
+    alternate_name?: string;
+    business_description?: string;
+    business_industry?: BusinessIndustry | null;
+    business_type?: BusinessType | null;
+    city?: string;
+    country?: Country;
+    date_of_birth?: string;
+    email?: string;
+    estimated_annual_revenue?: EstimatedAnnualRevenue | null;
+    external_id?: string;
+    first_name?: string;
+    formation_date?: string;
+    id_doc_back_file?: string;
+    id_doc_country?: Country;
+    id_doc_front_file?: string;
+    id_doc_type?: CustomerIdentificationDocument;
+    image_url?: string;
+    incorporation_doc_file?: string;
+    ip_address?: string;
+    last_name?: string;
+    legal_name?: string;
+    owners?: Array<StrictOmit<CustomerOwner, "id">>;
+    phone_number?: string;
+    postal_code?: string;
+    proof_of_address_doc_file?: string;
+    proof_of_address_doc_type?: CustomerProofOfAddressDocType;
+    proof_of_ownership_doc_file?: string;
+    publicly_traded?: boolean | null;
+    purpose_of_transactions?: PurposeOfTransactions;
+    purpose_of_transactions_explanation?: string;
+    selfie_file?: string;
+    source_of_funds_doc_file?: string;
+    source_of_funds_doc_type?: SourceOfFundsDocType;
+    source_of_wealth?: SourceOfWealth | null;
+    state_province_region?: string;
+    tax_id?: string;
+    tos_id?: string;
+    website?: string;
+    account_purpose_other?: string | null;
+    occupation?: string | null;
+    recipient_relationship?: RecipientRelationship | null;
+    sole_proprietor_doc_type?: SoleProprietorDocType | null;
+};
+type DeleteCustomerInput = string;
+type GetCustomerLimitsInput = string;
+type GetCustomerLimitsResponse = {
+    limits: {
+        payin: {
+            daily: number;
+            monthly: number;
+        };
+        payout: {
+            daily: number;
+            monthly: number;
+        };
+    };
+};
+type GetCustomerLimitIncreaseRequestsInput = string;
+type CustomerLimitIncreaseRequestStatus = "in_review" | "approved" | "rejected";
+type CustomerLimitIncreaseRequestSupportingDocumentType = "individual_bank_statement" | "individual_tax_return" | "individual_proof_of_income" | "business_bank_statement" | "business_financial_statements" | "business_tax_return";
+type GetCustomerLimitIncreaseRequestsResponse = Array<{
+    id: string;
+    customer_id: string;
+    status: CustomerLimitIncreaseRequestStatus;
+    daily: number;
+    monthly: number;
+    per_transaction: number;
+    supporting_document_file: string;
+    supporting_document_type: CustomerLimitIncreaseRequestSupportingDocumentType;
+    created_at: string;
+    updated_at: string;
+    approved_per_transaction?: number | null;
+    approved_daily?: number | null;
+    approved_monthly?: number | null;
+}>;
+type RequestCustomerLimitIncreaseInput = {
+    customer_id: string;
+    daily: number;
+    monthly: number;
+    per_transaction: number;
+    supporting_document_file: string;
+    supporting_document_type: CustomerLimitIncreaseRequestSupportingDocumentType;
+};
+type RequestCustomerLimitIncreaseResponse = {
+    id: string;
+};
+declare function createCustomersResource(instanceId: string, client: InternalApiClient): {
+    list(params?: ListCustomersInput): Promise<BlindpayApiResponse<ListCustomersResponse>>;
+    createIndividualWithStandardKYC(data: CreateCustomerIndividualWithStandardKYCInput): Promise<BlindpayApiResponse<CreateCustomerIndividualWithStandardKYCResponse>>;
+    createIndividualWithEnhancedKYC(data: CreateCustomerIndividualWithEnhancedKYCInput): Promise<BlindpayApiResponse<CreateCustomerIndividualWithEnhancedKYCResponse>>;
+    createBusinessWithStandardKYB(data: CreateCustomerBusinessWithStandardKYBInput): Promise<BlindpayApiResponse<CreateCustomerBusinessWithStandardKYBResponse>>;
+    get(customer_id: GetCustomerInput): Promise<BlindpayApiResponse<GetCustomerResponse>>;
+    update({ customer_id, ...data }: UpdateCustomerInput): Promise<BlindpayApiResponse<void>>;
+    delete(customer_id: DeleteCustomerInput): Promise<BlindpayApiResponse<void>>;
+    getLimits(customer_id: GetCustomerLimitsInput): Promise<BlindpayApiResponse<GetCustomerLimitsResponse>>;
+    getLimitIncreaseRequests(customer_id: GetCustomerLimitIncreaseRequestsInput): Promise<BlindpayApiResponse<GetCustomerLimitIncreaseRequestsResponse>>;
+    requestLimitIncrease({ customer_id, ...data }: RequestCustomerLimitIncreaseInput): Promise<BlindpayApiResponse<RequestCustomerLimitIncreaseResponse>>;
+};
+
+export { type CreateCustomerBusinessWithStandardKYBInput, type CreateCustomerBusinessWithStandardKYBResponse, type CreateCustomerIndividualWithEnhancedKYCInput, type CreateCustomerIndividualWithEnhancedKYCResponse, type CreateCustomerIndividualWithStandardKYCInput, type CreateCustomerIndividualWithStandardKYCResponse, type CustomerAmlHits, type CustomerAmlStatus, type CustomerBusinessWithStandardKYB, type CustomerFraudWarning, type CustomerIdentificationDocument, type CustomerIndividualWithEnhancedKYC, type CustomerIndividualWithStandardKYC, type CustomerKycType, type CustomerLimitIncreaseRequestStatus, type CustomerLimitIncreaseRequestSupportingDocumentType, type CustomerOwner, type CustomerOwnerRole, type CustomerOwnerTaxType, type CustomerProofOfAddressDocType, type DeleteCustomerInput, type GetCustomerInput, type GetCustomerLimitIncreaseRequestsInput, type GetCustomerLimitIncreaseRequestsResponse, type GetCustomerLimitsInput, type GetCustomerLimitsResponse, type GetCustomerResponse, type ListCustomersInput, type ListCustomersResponse, type RequestCustomerLimitIncreaseInput, type RequestCustomerLimitIncreaseResponse, type UpdateCustomerInput, createCustomersResource };