openapi: 3.2.0 info: title: Helix Customer API version: 3.0.0 description: Helix Public API (no customer KYC/IDV). **This spec covers all of Helix 3.x and is subject to change at any time.** servers: - url: https://sandbox-api.helix.q2.com description: Sandbox server - url: https://api.helix.q2.com description: Production server security: - basicAuth: [] tags: - name: Customer description: Endpoints for the customer object paths: /customer/archive: post: tags: - Customer summary: Archive a customer description: Archive a customer by the Helix-assigned `customerId`. externalDocs: url: https://docs.helix.q2.com/reference/customerarchive operationId: customerArchive requestBody: required: true content: application/json: schema: type: object required: - customerId properties: customerId: $ref: '#/components/schemas/HelixId' archiveReason: type: string enum: - FirstPartyFraud - ThirdPartyFraud - SyntheticIdFraud - AccountTakeoverFraud - NonActivity - CustomerRequest - BankDiscretion - Other default: Other description: "- `FirstPartyFraud`: When someone uses his/her own identity to obtain products and services with no intent to fulfill their payment obligation.\n- `ThirdPartyFraud`: When someone uses a stolen identity to commit fraud. Refers to fraud that is committed without the knowledge of the person whose identity is used to commit the fraud. \n- `SyntheticIdFraud`: When someone uses a possible combination of real and phony attributes, including possible real attributes that don’t correlate to each other, in order to assemble a phony identity. This information is then used to open fraudulent accounts and/or obtain goods and services.\n- `AccountTakeoverFraud`: When someone uses another person's account information to make purchases or withdraw money and often involves changing credentials and/or personal profile information. \n- `NonActivity`: Non-Activity.\n- `BankDiscretion`: Bank chose to archive for a non-fraud reason\n- `Other`: Default value. Providing a detailed reason is strongly encouraged as it informs and improves fraud detection mechanisms. \n" responses: '200': description: A pared down customer object content: application/json: schema: $ref: '#/components/schemas/CustomerArchive200Response' '400': $ref: '#/paths/~1card~1lock/post/responses/400' '401': $ref: '#/paths/~1card~1lock/post/responses/401' '404': $ref: '#/paths/~1card~1lock/post/responses/404' '405': $ref: '#/paths/~1card~1lock/post/responses/405' '429': $ref: '#/paths/~1card~1lock/post/responses/429' /customer/create: post: tags: - Customer summary: Create a customer description: Create a customer record. See customer object definition for parameter details. The parameters you are required to pass to Helix can vary depending on your program settings. externalDocs: url: https://docs.helix.q2.com/reference/customercreate operationId: customerCreate requestBody: required: true content: application/json: schema: type: object required: - firstName - lastName - isSubjectToBackupWithholding - isOptedInToBankCommunication - isDocumentsAccepted properties: firstName: type: string maxLength: 64 middleName: $ref: '#/components/schemas/FirstName' lastName: type: string maxLength: 128 suffix: type: string maxLength: 20 birthDate: $ref: '#/components/schemas/DateTimeProperty' gender: type: string enum: - M - F - U culture: type: string enum: - en-US - es-US description: "Accepted values vary by program:\n - `en-US`: English\n - `es-US`: Spanish\n" tag: $ref: '#/components/schemas/TagProperty' taxId: type: string maxLength: 30 description: No formatting (no dashes, spaces, etc). taxIdType: type: string enum: - SSN - EIN - ITIN driversLicenseNumber: type: string maxLength: 30 driversLicenseState: $ref: '#/components/schemas/FormationState' driversLicenseIssueDate: $ref: '#/components/schemas/DateTimeProperty' driversLicenseExpireDate: $ref: '#/components/schemas/DateTimeProperty' passportNumber: type: string maxLength: 30 passportCountry: type: string maxLength: 5 passportIssueDate: $ref: '#/components/schemas/DateTimeProperty' passportExpireDate: $ref: '#/components/schemas/DateTimeProperty' emailAddress: type: string maxLength: 255 foreignDocumentCountryCode: type: string maxLength: 3 foreignDocumentExpirationDate: $ref: '#/components/schemas/DateTimeProperty' foreignDocumentNumber: type: string maxLength: 30 foreignDocumentType: type: string enum: - DriversLicense - ConsularIdCard - Passport - PermanentResidentCard - EmploymentAuthorizationCard - VoterRegistrationCard - IdentificationCard isSubjectToBackupWithholding: type: boolean isOptedInToBankCommunication: type: boolean isDocumentsAccepted: type: boolean customField1: type: string maxLength: 100 customField2: type: string maxLength: 100 customField3: type: string maxLength: 100 customField4: type: string maxLength: 100 customField5: type: string maxLength: 100 preferredName: type: string maxLength: 21 usePreferredNameOnCard: type: boolean default: false residencyStatusType: type: string enum: - UsCitizen - ResidentAlien - NonResidentAlien addresses: type: array items: type: object required: - addressLine1 - addressType - city - country - postalCode - state properties: addressLine1: $ref: '#/components/schemas/AddressLine' addressLine2: $ref: '#/components/schemas/AddressLine' addressLine3: $ref: '#/components/schemas/AddressLine' addressLine4: $ref: '#/components/schemas/AddressLine' addressType: type: string enum: - Residence - Mailing city: $ref: '#/components/schemas/CityProperty' country: $ref: '#/components/schemas/CountryProperty' isActive: type: boolean readOnly: true postalCode: $ref: '#/components/schemas/PostalCode' state: $ref: '#/components/schemas/FormationState' phones: type: array items: type: object required: - number - phoneType properties: isActive: type: boolean readOnly: true number: type: string phoneType: type: string enum: - Home - Mobile - Office responses: '200': description: A `customerId` and `customerToken` (if enabled for program) content: application/json: schema: $ref: '#/components/schemas/CustomerCreate200Response' '400': $ref: '#/paths/~1card~1lock/post/responses/400' '401': $ref: '#/paths/~1card~1lock/post/responses/401' '404': $ref: '#/paths/~1card~1lock/post/responses/404' '405': $ref: '#/paths/~1card~1lock/post/responses/405' '429': $ref: '#/paths/~1card~1lock/post/responses/429' /customer/createBusiness: post: tags: - Customer summary: Create a business customer description: Create a business customer record. See customer object definition for parameter details. The parameters you are required to pass to Helix can vary depending on your program settings. externalDocs: url: https://docs.helix.q2.com/reference/customercreatebusiness operationId: customercreatebusiness requestBody: required: true content: application/json: schema: type: object required: - businessLegalName - legalEntityType - taxId - taxIdType properties: businessLegalName: type: string legalEntityType: type: string enum: - SoleProprietorship - SingleMemberLLC - SCorporation - CCorporation - NonProfit - Association - Partnership - LimitedLiabilityCompany - LimitedLiabilityPartnership - RevocableTrust - IrrevocableTrust - FinancialInstitutionOther - Estate - Trust - Church - Conservator - Guardianship - Government - Cooperative - BCorporation - TottenTrustPOD - LimitedPartnership - GeneralPartnership - GovernmentDepartment - GovernmentAgency - GovernmentAuthority - GovernmentNonCommercialNonUSDepartmentOrAgency - GovernmentOther - RegulatedFinancialInstitution - RegulatedBankLoanHoldingsCompany - RegulatedSavingsAndLoanHoldingCompany - ForeignFinancialInstitutionRegulatorKeepsUBOInfo taxId: $ref: '#/components/schemas/TaxId' taxIdType: $ref: '#/components/schemas/TaxIdType' businessDescription: type: string doingBusinessAs: type: string maxLength: 200 formationDate: $ref: '#/components/schemas/DateTimeProperty' formationState: $ref: '#/components/schemas/FormationState' industryClassificationCodeId: $ref: '#/components/schemas/HelixId' isTaxExempt: type: boolean isSubjectToBackupWithholding: type: boolean culture: $ref: '#/components/schemas/CultureProperty' isOptedInToBankCommunication: type: boolean isDocumentsAccepted: type: boolean businessNameOnCard: type: string maxLength: 26 businessWebsite: type: string tag: $ref: '#/components/schemas/TagProperty' emailAddress: $ref: '#/components/schemas/EmailAddress' customField1: type: string maxLength: 100 customField2: type: string maxLength: 100 customField3: type: string maxLength: 100 customField4: type: string maxLength: 100 customField5: type: string maxLength: 100 addresses: type: array items: type: object required: - addressLine1 - addressType - city - country - postalCode - state properties: addressLine1: $ref: '#/components/schemas/AddressLine' addressLine2: $ref: '#/components/schemas/AddressLine' addressLine3: $ref: '#/components/schemas/AddressLine' addressLine4: $ref: '#/components/schemas/AddressLine' addressType: type: string enum: - PrimaryBusiness - Business - Registered - TaxFormMailing - Mailing city: $ref: '#/components/schemas/CityProperty' country: $ref: '#/components/schemas/CountryProperty' isActive: type: boolean readOnly: true postalCode: $ref: '#/components/schemas/PostalCode' state: $ref: '#/components/schemas/FormationState' phones: type: array items: $ref: '#/components/schemas/PhoneItem' responses: '200': description: An envelope whose data node is a customer object content: application/json: schema: $ref: '#/components/schemas/CustomerObject200Response' '400': $ref: '#/paths/~1card~1lock/post/responses/400' '401': $ref: '#/paths/~1card~1lock/post/responses/401' '404': $ref: '#/paths/~1card~1lock/post/responses/404' '405': $ref: '#/paths/~1card~1lock/post/responses/405' '429': $ref: '#/paths/~1card~1lock/post/responses/429' /customer/createBusinessApplication: post: tags: - Customer summary: Create business application description: Create a business credit application for the given `businessCustomerId`. externalDocs: url: https://docs.helix.q2.com/reference/customercreatebusinessapplication operationId: customerCreateBusinessApplication requestBody: required: true content: application/json: schema: type: object required: - businessCustomerId - controlPersonCustomerId - controlPersonRelationshipType - controlPersonIsBeneficialOwner - isExemptFromBeneficialOwnership properties: businessCustomerId: $ref: '#/components/schemas/HelixId' controlPersonCustomerId: $ref: '#/components/schemas/HelixId' controlPersonRelationshipType: type: string enum: - Signer - Owner - Trustee - SuccessorTrustee - Guardian - Conservator - Executor - Agent - PowerOfAttorney controlPersonIsBeneficialOwner: type: boolean isExemptFromBeneficialOwnership: type: boolean exemptFromBeneficialOwnershipReasonType: $ref: '#/components/schemas/ExemptFromBeneficialOwnershipReasonType' controlPersonBeneficialOwnerPercentage: type: number format: decimal controlPersonTitle: type: string attestationDate: type: string format: datetime attesterTitle: type: string attesterName: type: string additionalRelatedCustomers: type: array items: type: object required: - customerId - relationshipType - isBeneficialOwner - canOpenAccounts - externalAccountAccessType properties: customerId: $ref: '#/components/schemas/HelixId' relationshipType: type: string enum: - Signer - Owner - NonTransactional - BeneficialOwner - Trustee - SuccessorTrustee - Guardian - Conservator - Executor - Agent - PowerOfAttorney isBeneficialOwner: type: boolean beneficialOwnerPercentage: type: number format: decimal canOpenAccounts: type: boolean title: type: string externalAccountAccessType: $ref: '#/components/schemas/ExternalAccountAccessType' responses: '200': description: A 200 status with no `data` property present content: application/json: schema: $ref: '#/components/schemas/CardArray200Response/allOf/0' '400': $ref: '#/paths/~1card~1lock/post/responses/400' '401': $ref: '#/paths/~1card~1lock/post/responses/401' '404': $ref: '#/paths/~1card~1lock/post/responses/404' '405': $ref: '#/paths/~1card~1lock/post/responses/405' '429': $ref: '#/paths/~1card~1lock/post/responses/429' /customer/generateToken/{customerId}: get: tags: - Customer summary: Generate a customer token description: Retrieve the customer token for the given `customerId`. Only applicable if your program has customer-level authentication enabled. externalDocs: url: https://docs.helix.q2.com/reference/customergeneratetoken operationId: customerGenerateToken parameters: - $ref: '#/components/parameters/CustomerIdPath' responses: '200': description: A `customerId` and `token` content: application/json: schema: $ref: '#/components/schemas/CustomerGenerateToken200Response' '400': $ref: '#/paths/~1card~1lock/post/responses/400' '401': $ref: '#/paths/~1card~1lock/post/responses/401' '404': $ref: '#/paths/~1card~1lock/post/responses/404' '405': $ref: '#/paths/~1card~1lock/post/responses/405' '429': $ref: '#/paths/~1card~1lock/post/responses/429' /customer/get/{customerId}: get: tags: - Customer summary: Get a customer description: Retrieve customer information by the Helix-assigned `customerId`. externalDocs: url: https://docs.helix.q2.com/reference/customerget operationId: customerGet parameters: - $ref: '#/components/parameters/CustomerIdPath' responses: '200': description: An envelope whose data node is a customer object content: application/json: schema: $ref: '#/components/schemas/CustomerObject200Response' '400': $ref: '#/paths/~1card~1lock/post/responses/400' '401': $ref: '#/paths/~1card~1lock/post/responses/401' '404': $ref: '#/paths/~1card~1lock/post/responses/404' '405': $ref: '#/paths/~1card~1lock/post/responses/405' '429': $ref: '#/paths/~1card~1lock/post/responses/429' /customer/getByEmail/{emailAddress}: get: tags: - Customer summary: Get a customer via emailAddress description: Retrieve customer information by the `emailAddress` specified during customer creation. externalDocs: url: https://docs.helix.q2.com/reference/customergetbyemail operationId: customerGetByEmail parameters: - name: emailAddress in: path required: true schema: type: string maxLength: 100 responses: '200': description: An envelope whose data node is a customer object content: application/json: schema: $ref: '#/components/schemas/CustomerObject200Response' '400': $ref: '#/paths/~1card~1lock/post/responses/400' '401': $ref: '#/paths/~1card~1lock/post/responses/401' '404': $ref: '#/paths/~1card~1lock/post/responses/404' '405': $ref: '#/paths/~1card~1lock/post/responses/405' '429': $ref: '#/paths/~1card~1lock/post/responses/429' /customer/getByTag/{tag}: get: tags: - Customer summary: Get a customer via tag description: Retrieve customer information by the `tag` specified during customer creation. externalDocs: url: https://docs.helix.q2.com/reference/customergetbytag operationId: customerGetByTag parameters: - name: tag in: path required: true schema: $ref: '#/components/schemas/TagProperty' responses: '200': description: An envelope whose data node is a customer object content: application/json: schema: $ref: '#/components/schemas/CustomerObject200Response' '400': $ref: '#/paths/~1card~1lock/post/responses/400' '401': $ref: '#/paths/~1card~1lock/post/responses/401' '404': $ref: '#/paths/~1card~1lock/post/responses/404' '405': $ref: '#/paths/~1card~1lock/post/responses/405' '429': $ref: '#/paths/~1card~1lock/post/responses/429' /customer/list: get: tags: - Customer summary: List customers description: Retrieve all customers for your program. Results are ordered by `lastName` then `firstName`. Each customer object includes a `customerCount` property, which can be used with the `pageNumber` and `pageSize` query parameters to paginate results. All customers, regardless of status, are returned. externalDocs: url: https://docs.helix.q2.com/reference/customerlist operationId: customerList parameters: - name: pageNumber in: query required: false description: Which page of the results to return. Use 0 to get the first page. schema: type: integer default: 0 minimum: 0 maximum: 200 - name: pageSize in: query required: false description: How many results to return on each page. Maximum is 200. schema: type: integer default: 200 minimum: 0 maximum: 200 - name: customerClass in: query required: false description: Limit which type of customers are returned. If no value is passed, all customers are returned. schema: type: string enum: - individual - business responses: '200': description: 'An array of customer objects with null arrays for the following properties: accounts, addresses, cards, externalAccounts, phones' content: application/json: schema: $ref: '#/components/schemas/CustomerArray200Response' '400': $ref: '#/paths/~1card~1lock/post/responses/400' '401': $ref: '#/paths/~1card~1lock/post/responses/401' '404': $ref: '#/paths/~1card~1lock/post/responses/404' '405': $ref: '#/paths/~1card~1lock/post/responses/405' '429': $ref: '#/paths/~1card~1lock/post/responses/429' /customer/note: post: tags: - Customer summary: Make a customer note description: Add notes to a customer record by the Helix-assigned `customerId`. externalDocs: url: https://docs.helix.q2.com/reference/customernote operationId: customerNote requestBody: required: true content: application/json: schema: type: object required: - customerId - note properties: customerId: $ref: '#/components/schemas/HelixId' note: type: string maxLength: 500 responses: '200': description: The `customerId` and `note` content: application/json: schema: $ref: '#/components/schemas/CustomerNote200Response' '400': $ref: '#/paths/~1card~1lock/post/responses/400' '401': $ref: '#/paths/~1card~1lock/post/responses/401' '404': $ref: '#/paths/~1card~1lock/post/responses/404' '405': $ref: '#/paths/~1card~1lock/post/responses/405' '429': $ref: '#/paths/~1card~1lock/post/responses/429' /customer/notesList/{customerId}: get: tags: - Customer summary: List customer notes description: Retrieve all notes for the given `customerId`, including those added via Helix Admin Console or API. externalDocs: url: https://docs.helix.q2.com/reference/customernoteslist operationId: customerNotesList parameters: - $ref: '#/components/parameters/CustomerIdPath' - $ref: '#/components/parameters/PageNumber' - $ref: '#/components/parameters/PageSize' responses: '200': description: An array of customerNote objects content: application/json: schema: $ref: '#/components/schemas/CustomerNotesList200Response' '400': $ref: '#/paths/~1card~1lock/post/responses/400' '401': $ref: '#/paths/~1card~1lock/post/responses/401' '404': $ref: '#/paths/~1card~1lock/post/responses/404' '405': $ref: '#/paths/~1card~1lock/post/responses/405' '429': $ref: '#/paths/~1card~1lock/post/responses/429' /customer/search: post: tags: - Customer summary: Search for customers description: Retrieve customer information by the given parameter(s). See customer object definition for parameter details. Results are ordered by `lastName` then `firstName`. Each customer object includes a `customerCount` property, which can be used with the `pageNumber` and `pageSize` query parameters to paginate results. externalDocs: url: https://docs.helix.q2.com/reference/customersearch operationId: customerSearch parameters: - $ref: '#/components/parameters/PageNumber' - $ref: '#/components/parameters/PageSize' requestBody: required: true content: application/json: schema: type: object properties: firstName: $ref: '#/components/schemas/FirstName' lastName: $ref: '#/components/schemas/CustomerLastName' tag: $ref: '#/components/schemas/TagProperty' taxId: $ref: '#/components/schemas/TaxId' driversLicenseNumber: $ref: '#/components/schemas/DriversLicenseNumber' passportNumber: $ref: '#/components/schemas/PassportNumber' emailAddress: $ref: '#/components/schemas/EmailAddress' birthDate: $ref: '#/components/schemas/DateTimeProperty' accounts: type: array items: type: object properties: accountNumber: type: string maxLength: 15 responses: '200': description: 'An array of customer objects with null arrays for the following properties: `accounts`, `addresses`, `cards`, `externalAccounts`, `phones` ' content: application/json: schema: $ref: '#/components/schemas/CustomerNoBusinessFieldsArray200Response' '400': $ref: '#/paths/~1card~1lock/post/responses/400' '401': $ref: '#/paths/~1card~1lock/post/responses/401' '404': $ref: '#/paths/~1card~1lock/post/responses/404' '405': $ref: '#/paths/~1card~1lock/post/responses/405' '429': $ref: '#/paths/~1card~1lock/post/responses/429' /customer/setLastContact: post: tags: - Customer summary: Set last contact description: Set the last contact date and type for the given `customerId`. externalDocs: url: https://docs.helix.q2.com/reference/customersetlastcontact operationId: customerSetLastContact requestBody: required: true content: application/json: schema: type: object required: - customerId - lastContactDate - lastContctType properties: customerId: $ref: '#/components/schemas/HelixId' lastContactDate: $ref: '#/components/schemas/DateTimeProperty' lastContactType: type: string enum: - Log In - Phone - Email - Chat responses: '200': description: The `customerId`, `lastContactDate`, and `lastContactType` content: application/json: schema: $ref: '#/components/schemas/CustomerSetLastContact200Response' '400': $ref: '#/paths/~1card~1lock/post/responses/400' '401': $ref: '#/paths/~1card~1lock/post/responses/401' '404': $ref: '#/paths/~1card~1lock/post/responses/404' '405': $ref: '#/paths/~1card~1lock/post/responses/405' '429': $ref: '#/paths/~1card~1lock/post/responses/429' /customer/update: post: tags: - Customer summary: Update a customer description: See customer object definition for parameter details. externalDocs: url: https://docs.helix.q2.com/reference/customerupdate operationId: customerUpdate requestBody: required: true content: application/json: schema: type: object required: - customerId properties: customerId: $ref: '#/components/schemas/HelixId' firstName: $ref: '#/components/schemas/FirstName' middleName: $ref: '#/components/schemas/FirstName' lastName: $ref: '#/components/schemas/CustomerLastName' suffix: $ref: '#/components/schemas/SuffixProperty' birthDate: $ref: '#/components/schemas/DateTimeProperty' taxId: $ref: '#/components/schemas/TaxId' driversLicenseNumber: $ref: '#/components/schemas/DriversLicenseNumber' driversLicenseState: $ref: '#/components/schemas/FormationState' driversLicenseIssueDate: $ref: '#/components/schemas/DateTimeProperty' driversLicenseExpireDate: $ref: '#/components/schemas/DateTimeProperty' passportNumber: $ref: '#/components/schemas/PassportNumber' passportCountry: $ref: '#/components/schemas/PassportNumber' passportIssueDate: $ref: '#/components/schemas/DateTimeProperty' passportExpireDate: $ref: '#/components/schemas/DateTimeProperty' emailAddress: $ref: '#/components/schemas/EmailAddress' gender: $ref: '#/components/schemas/GenderProperty' culture: $ref: '#/components/schemas/CultureProperty' isSubjectToBackupWithholding: type: boolean isOptedInToBankCommunication: type: boolean isDocumentsAccepted: type: boolean tag: $ref: '#/components/schemas/TagProperty' customField1: type: string maxLength: 100 customField2: type: string maxLength: 100 customField3: type: string maxLength: 100 customField4: type: string maxLength: 100 customField5: type: string maxLength: 100 foreignDocumentCountryCode: type: string maxLength: 3 foreignDocumentExpirationDate: $ref: '#/components/schemas/DateTimeProperty' foreignDocumentNumber: type: string maxLength: 30 foreignDocumentType: $ref: '#/components/schemas/ForeignDocumentType' businessLegalName: type: string businessDescription: type: string doingBusinessAs: type: string maxLength: 200 formationDate: $ref: '#/components/schemas/DateTimeProperty' formationState: type: string maxLength: 2 industryClassificationCodeId: $ref: '#/components/schemas/HelixId' isTaxExempt: type: boolean businessWebsite: type: string isExemptFromBeneficialOwnership: type: boolean exemptFromBeneficialOwnershipReasonType: type: string description: "The reason the business is exempt from Beneficial Ownership. See customer.exemptFromBeneficialOwnershipType for more details. \n" enum: - UsStockExchangeTradedEntity - CharityOrNonProfitEntity - PublicAccountingFirmRegisteredUnderSection102 - UsStateRegulatedBank - UsRegulatedInsuranceCompany - UsRegulatedFinancialInstitution - UsFederalGovernmentAgency - UsStateGovernmentAgency - UsLocalGovernmentAgency - NonUsGovernmentAgency - BankHoldingCompany - SavingsAndLoanHoldingCompany - FinancialMarketUtility - NonUsEntityOpeningAPrivateBankingAccount - ForeignFinancialInstitution - ClassOfSecuritiesIssuer - SecCurrentRegisteredFirm - CommodityFuturesTradingCommissionRegisteredEntity - ExcludedPooledInvestmentVehicle - NonExcludedPooledInvestmentVehicle - UsStockExchangeMajorityEquityEntity attestationDate: type: string format: datetime attesterTitle: type: string attesterName: type: string businessNameOnCard: type: string maxLength: 26 addresses: type: array items: type: object required: - addressLine1 - addressType - city - country - postalCode - state properties: addressLine1: $ref: '#/components/schemas/AddressLine' addressLine2: $ref: '#/components/schemas/AddressLine' addressLine3: $ref: '#/components/schemas/AddressLine' addressLine4: $ref: '#/components/schemas/AddressLine' addressType: type: string enum: - Individual - Mailing - PrimaryBusiness - Business - Registered - TaxFormMailing city: $ref: '#/components/schemas/CityProperty' country: $ref: '#/components/schemas/CountryProperty' isActive: type: boolean readOnly: true postalCode: $ref: '#/components/schemas/PostalCode' state: $ref: '#/components/schemas/FormationState' phones: type: array items: $ref: '#/components/schemas/PhoneItem' responses: '200': description: An envelope whose data node is a customer object content: application/json: schema: $ref: '#/components/schemas/CustomerObject200Response' '400': $ref: '#/paths/~1card~1lock/post/responses/400' '401': $ref: '#/paths/~1card~1lock/post/responses/401' '404': $ref: '#/paths/~1card~1lock/post/responses/404' '405': $ref: '#/paths/~1card~1lock/post/responses/405' '429': $ref: '#/paths/~1card~1lock/post/responses/429' /customer/updateAddress: post: tags: - Customer summary: Update a customer address description: Update an address for the given `customerId` for address verification or manual review. externalDocs: url: https://docs.helix.q2.com/reference/customerUpdateAddress operationId: customerupdateaddress requestBody: required: true content: application/json: schema: type: object required: - customerId - addresses properties: customerId: $ref: '#/components/schemas/HelixId' addresses: type: array description: At least one address must be provided. items: type: object required: - addressLine1 - addressType - city - country - postalCode - state properties: addressLine1: $ref: '#/components/schemas/AddressLine' addressLine2: $ref: '#/components/schemas/AddressLine' addressLine3: $ref: '#/components/schemas/AddressLine' addressLine4: $ref: '#/components/schemas/AddressLine' addressType: type: string enum: - Individual - Mailing - PrimaryBusiness - Business - Registered - TaxFormMailing city: $ref: '#/components/schemas/CityProperty' country: $ref: '#/components/schemas/CountryProperty' postalCode: $ref: '#/components/schemas/PostalCode' state: $ref: '#/components/schemas/FormationState' responses: '200': description: An envelope whose data node is a customer object content: application/json: schema: $ref: '#/components/schemas/CustomerObject200Response' '400': $ref: '#/paths/~1card~1lock/post/responses/400' '401': $ref: '#/paths/~1card~1lock/post/responses/401' '404': $ref: '#/paths/~1card~1lock/post/responses/404' '405': $ref: '#/paths/~1card~1lock/post/responses/405' '429': $ref: '#/paths/~1card~1lock/post/responses/429' components: schemas: EmailAddress: type: string maxLength: 255 LegalName: type: string maxLength: 100 ExternalAccountObject200Response: allOf: - $ref: '#/components/schemas/CardArray200Response/allOf/0' - type: object properties: data: type: object properties: accountNumber: type: string accountNumberMasked: type: string businessName: type: string maxLength: 100 customField1: type: string maxLength: 50 customField2: type: string maxLength: 50 customField3: type: string maxLength: 50 customField4: type: string maxLength: 50 customField5: type: string maxLength: 50 customerId: $ref: '#/components/schemas/HelixId' externalAccountId: $ref: '#/components/schemas/HelixId' firstName: type: string maxLength: 50 isActive: type: boolean deprecated: true isLocked: type: boolean lastModifiedDate: $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate' lastName: type: string maxLength: 50 lockedDate: $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate' lockedReason: type: string name: type: string nickName: type: string nocCode: type: string routingNumber: type: string routingNumberMasked: type: string status: type: string enum: - Unverified - VerifyLocked - Verified - Denied - Expired - Archived statusDate: $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate' tag: $ref: '#/components/schemas/TagProperty' type: type: string enum: - Checking - Savings - Business Checking - Business Savings - Prepaid ExemptFromBeneficialOwnershipReasonType: type: string enum: - UsStockExchangeTradedEntity - CharityOrNonProfitEntity - PublicAccountingFirmRegisteredUnderSection102 - UsStateRegulatedBank - UsRegulatedInsuranceCompany - UsRegulatedFinancialInstitution - UsFederalGovernmentAgency - UsStateGovernmentAgency - UsLocalGovernmentAgency - NonUsGovernmentAgency - BankHoldingCompany - SavingsAndLoanHoldingCompany - FinancialMarketUtility - NonUsEntityOpeningAPrivateBankingAccount - ForeignFinancialInstitution - ClassOfSecuritiesIssuer - SecCurrentRegisteredFirm - CommodityFuturesTradingCommissionRegisteredEntity - ExcludedPooledInvestmentVehicle - NonExcludedPooledInvestmentVehicle - UsStockExchangeMajorityEquityEntity CityProperty: type: string maxLength: 50 CardObject200Response: allOf: - $ref: '#/components/schemas/CardArray200Response/allOf/0' - type: object properties: data: type: object properties: accounts: type: array items: type: object properties: accountBalance: type: number format: decimal accountId: $ref: '#/components/schemas/HelixId' accountNumberMasked: type: string availableBalance: type: number format: decimal balanceLastModifiedDate: $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate' cardPriority: $ref: '#/components/schemas/CardPriority' customerId: $ref: '#/components/schemas/HelixId' lastModifiedDate: $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate' name: type: string pendingBalance: type: number format: decimal status: $ref: '#/components/schemas/AccountObject200Response/allOf/1/properties/data/properties/status' tag: $ref: '#/components/schemas/TagProperty' type: $ref: '#/components/schemas/AccountObject200Response/allOf/1/properties/data/properties/type' archivedDate: $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate' binId: $ref: '#/components/schemas/HelixId' cardCarrierMessage: type: string description: 'Identifier used uniquely by various card production facilities for mapping card configurations. ' cardDesignIdentificationNumber: type: string description: 'Identifier used uniquely by various card production facilities for mapping card configurations. ' cardHolderCustomerId: $ref: '#/components/schemas/HelixId' cardId: $ref: '#/components/schemas/HelixId' cardNumberMasked: type: string cardVendorUniqueData: type: string description: 'Identifier used uniquely by various card production facilities for mapping card configurations. ' createdDate: $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate' customerId: $ref: '#/components/schemas/HelixId' deniedDate: $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate' digitalWalletTokens: type: array items: type: object properties: device: type: object properties: deviceId: type: string deviceIpAddress: type: string deviceLanguageCode: type: string deviceLocation: type: string deviceName: type: string deviceNumber: type: string deviceType: type: string enum: - Card - MobilePhone - Tablet - Watch - MobileDevice - FashionAccessory - HomeAppliance - KeyFob - MediaOrGamingDevice - MobileDeviceAccessory - PCOrLaptop - Vehicle - UnknownOther isDeviceProvisioned: type: boolean panReferenceId: type: string token: type: string tokenReferenceId: type: string tokenRequestorId: type: string enum: - '40010030273' - '40010075001' - '40010043095' - '40010075338' tokenRequestorName: type: string enum: - ApplePay - GooglePay - SamsungPay - VisaCheckout tokenStatus: type: string enum: - ActiveForPayment - Initiated - SuspendedTemporarily - DeactivatedPermanently tokenType: type: string enum: - Card on file - Secure element - Cloud based payment/HCE - E-Commerce Enabler walletInformation: type: object properties: panSource: type: string enum: - KeyEntered - OnFile - MobileBankingApp walletAccountId: type: string walletEmailAddressHashed: type: string walletProviderDeviceScore: type: string walletProviderReasonCodes: type: string walletProviderRiskAssessmentType: type: string enum: - Approved - ApprovedConditionally - NotApproved walletProviderRiskAssessmentVersion: type: string expireMonth: $ref: '#/components/schemas/MonthProperty' expireYear: $ref: '#/components/schemas/YearProperty' expiredDate: $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate' firstName: type: string isDigitalOnly: type: boolean isDualIssuanceSinglePAN: type: boolean isPINSet: type: boolean lastModifiedDate: $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate' lastName: type: string lockReasonTypeCode: type: string enum: - UNK - STL - LST - FRD - DMG - ADM - TMP - PIN lockTypeCode: type: string enum: - UNL - CST - SYS middleName: type: string nameOnCard: type: string nickName: type: string photoImageId: type: string description: 'Identifier used uniquely by various card production facilities for mapping card configurations. ' preferredName: type: string primaryAccountId: $ref: '#/components/schemas/HelixId' qualifierCode: $ref: '#/components/schemas/CardQualifierCode' reissuedDate: $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate' renewalOverride: $ref: '#/components/schemas/RenewalOverride' renewalOverrideReason: type: string requestedDate: $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate' status: type: string enum: - Initiated - Pending - PendingVerification - Verified - Denied - Expired - Archived - Reissued - Hotlisted - ReissuedPendingVerification - AutoReissuedPendingVerification tag: $ref: '#/components/schemas/TagProperty' typeCode: type: string enum: - DBT vendorTypeCode: $ref: '#/components/schemas/CardVendorTypeCode' verifiedDate: $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate' CustomerNotesList200Response: allOf: - $ref: '#/components/schemas/CardArray200Response/allOf/0' - type: object properties: data: type: array items: type: object properties: customerId: $ref: '#/components/schemas/HelixId' customerNoteId: $ref: '#/components/schemas/AccountClose200Response/allOf/1/properties/data/properties/transactionId' effective: $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate' modifiedBy: $ref: '#/components/schemas/HelixId' noteText: type: string ExternalAccountAccessType: type: string enum: - FULL - RDLY - ACH - NONE TaxIdType: type: string enum: - SSN - EIN - ITIN CustomerGenerateToken200Response: allOf: - $ref: '#/components/schemas/CardArray200Response/allOf/0' - type: object properties: data: type: object properties: customerId: $ref: '#/components/schemas/HelixId' token: type: string AccountObject200Response: allOf: - $ref: '#/components/schemas/CardArray200Response/allOf/0' - type: object properties: data: type: object properties: accessTypeCode: type: string enum: - FULL - AUTHSIGNER - RDONLY - NONE accountBalance: type: number format: decimal accountId: $ref: '#/components/schemas/HelixId' accountMinimumBalance: type: number format: decimal accountNumber: type: string accountNumberMasked: type: string availableBalance: type: number format: decimal balanceLastModifiedDate: $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate' category: type: string maxLength: 50 closedAmount: type: number format: decimal closedDate: $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate' closedReason: $ref: '#/components/schemas/CloseReason' closedReasonNotes: $ref: '#/components/schemas/CloseReasonNotes' createdDate: $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate' customField1: type: string maxLength: 50 customField2: type: string maxLength: 50 customField3: type: string maxLength: 50 customField4: type: string maxLength: 50 customField5: type: string maxLength: 50 customerId: $ref: '#/components/schemas/HelixId' customerPriority: $ref: '#/components/schemas/HelixId' externalProgramTag: type: string firstDepositDate: $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate' globalAccountAccessEnabled: type: boolean interestTransferFkId: $ref: '#/components/schemas/HelixId' isCloseable: type: boolean isJointAccount: type: boolean isLocked: type: boolean isPrimary: type: boolean isPrimaryCustomer: type: boolean lastModifiedDate: $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate' legalName1: $ref: '#/components/schemas/LegalName' legalName2: $ref: '#/components/schemas/LegalName' lockReasonTypeCode: $ref: '#/components/schemas/AccountLockReasonTypeCode' lockTypeCode: $ref: '#/components/schemas/CardObject200Response/allOf/1/properties/data/properties/lockTypeCode' accountLockClassificationCode: type: - string - 'null' maxLength: 10 description: Program-configured classification code associated with the account lock. accountLockClassificationCodeDescription: type: - string - 'null' description: Human-readable description of the accountLockClassificationCode. maturityTypeCode: type: string name: type: string pendingBalance: type: number format: decimal primaryCustomerId: $ref: '#/components/schemas/HelixId' productId: $ref: '#/components/schemas/HelixId' recurringContributionAmount: type: number format: decimal recurringContributionEndDate: $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate' recurringContributionFromExternalAccountId: $ref: '#/components/schemas/HelixId' recurringContributionNextDate: $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate' recurringContributionStartDate: $ref: '#/components/schemas/DateTimeProperty' recurringContributionType: $ref: '#/components/schemas/RecurringContributionType' regDWithdrawalCount: type: integer format: int32 minimum: 0 routingNumber: type: string routingNumberMasked: type: string sourceLinks: type: array items: type: object deprecated: true properties: creditSetting: type: number format: decimal customerId: $ref: '#/components/schemas/HelixId' debitSetting: type: number format: decimal isCreditAutoTransferEnabled: type: boolean isDebitAutoTransferEnabled: type: boolean linkOptionTypeCode: type: string enum: - OVRPRTAMT - OVRPRTMLT - OVRSECPCT - OVRSECFIX description: '- `OVRPRTAMT`: Auto-transfer exact amount of withdrawal - `OVRPRTMLT`: Auto-transfer to the nearest multiple of `debitSetting` to cover withdrawal amount - `OVRSECPCT`: Allow lending up to `debitSetting` percentage of security account funds - `OVRSECFIX`: Allow lending up to fixed amount of `debitSetting` ' linkTypeCode: type: string enum: - OVRPRT - OVRSEC description: '- `OVRPRT`: Overdraft protention - `OVRSEC`: Overdraft security ' sourceAccountId: $ref: '#/components/schemas/HelixId' targetAccountId: $ref: '#/components/schemas/HelixId' deprecated: true status: type: string enum: - Open - Closed - PendingOpen - PendingClosed subCategory: type: string tag: $ref: '#/components/schemas/TagProperty' targetAmount: type: number format: decimal targetDate: $ref: '#/components/schemas/DateTimeProperty' targetLinks: type: array items: $ref: '#/components/schemas/AccountObject200Response/allOf/1/properties/data/properties/sourceLinks/items' deprecated: true targetMetDate: $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate' targetMetPercent: type: number format: decimal totalCustomers: $ref: '#/components/schemas/HelixId' type: type: string enum: - Checking - Savings - ForBenefitOf - Prepaid - Time Deposit - Business Checking - Business Savings CloseReason: type: string enum: - Fraud - Never funded - BSA reasons - Relationship ended - Deceased - Other - Consolidating Bank Accounts - re-CIP - Risk-Related - Member Requested - Negative Balance (Reopen Eligible) - Negative Balance (Reopen Ineligible) - ID Theft - Account Take Over - Dormant description: 'The following values are not enabled by default and must be enabled by Q2: `Consolidating Bank Accounts`, `re-CIP`, `Risk-Related`, `Member Requested`, `Negative Balance (Reopen Eligible)`, `Negative Balance (Reopen Ineligible)`, `ID Theft`, `Account Take Over`, `Dormant` ' CustomerNoBusinessFieldsArray200Response: allOf: - $ref: '#/components/schemas/CardArray200Response/allOf/0' - type: object properties: data: type: array items: type: object properties: accessTypeCode: type: string enum: - FULL - ACCT - CARD - FDRY accounts: type: - array - 'null' items: $ref: '#/components/schemas/AccountObject200Response/allOf/1/properties/data' addresses: type: - array - 'null' items: $ref: '#/components/schemas/AddressItem' birthDate: $ref: '#/components/schemas/DateTimeProperty' cards: type: - array - 'null' items: $ref: '#/components/schemas/CardObject200Response/allOf/1/properties/data' customerCount: $ref: '#/components/schemas/HelixId' createdDate: $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate' culture: $ref: '#/components/schemas/CultureProperty' customField1: type: string maxLength: 100 customField2: type: string maxLength: 100 customField3: type: string maxLength: 100 customField4: type: string maxLength: 100 customField5: type: string maxLength: 100 customerId: $ref: '#/components/schemas/HelixId' deceasedDate: $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate' documentsAcceptedDate: $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate' driversLicenseExpireDate: $ref: '#/components/schemas/DateTimeProperty' driversLicenseIssueDate: $ref: '#/components/schemas/DateTimeProperty' driversLicenseNumber: $ref: '#/components/schemas/DriversLicenseNumber' driversLicenseNumberMasked: type: string driversLicenseState: $ref: '#/components/schemas/FormationState' emailAddress: $ref: '#/components/schemas/EmailAddress' externalAccounts: type: - array - 'null' items: $ref: '#/components/schemas/ExternalAccountObject200Response/allOf/1/properties/data' firstName: $ref: '#/components/schemas/FirstName' fraudStatus: $ref: '#/components/schemas/CustomerObject200Response/allOf/1/properties/data/properties/status' gender: $ref: '#/components/schemas/GenderProperty' idStatus: $ref: '#/components/schemas/CustomerObject200Response/allOf/1/properties/data/properties/status' iqStatus: $ref: '#/components/schemas/CustomerObject200Response/allOf/1/properties/data/properties/status' isActive: type: boolean deprecated: true isDocumentsAccepted: type: boolean isLocked: type: boolean isOptedInToBankCommunication: type: boolean isRelianceAgreement: type: boolean isSubjectToBackupWithholding: type: boolean kycStatus: $ref: '#/components/schemas/CustomerObject200Response/allOf/1/properties/data/properties/status' lastActivityDate: $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate' lastModifiedDate: $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate' lastName: $ref: '#/components/schemas/CustomerLastName' lockedDate: $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate' lockedReason: type: string middleName: $ref: '#/components/schemas/FirstName' ofacStatus: $ref: '#/components/schemas/CustomerObject200Response/allOf/1/properties/data/properties/status' passportCountry: type: string passportExpireDate: $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate' passportIssueDate: $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate' passportNumber: $ref: '#/components/schemas/PassportNumber' passportNumberMasked: type: string phones: type: - array - 'null' items: $ref: '#/components/schemas/PhoneItem' qualiFileStatus: type: string deprecated: true residencyStatusType: $ref: '#/components/schemas/ResidencyStatusType' status: $ref: '#/components/schemas/CustomerObject200Response/allOf/1/properties/data/properties/status' suffix: type: string tag: type: string taxId: $ref: '#/components/schemas/TaxId' taxIdMasked: type: string taxIdType: $ref: '#/components/schemas/TaxIdType' CultureProperty: type: string enum: - en-US - es-US description: "Accepted values vary by program:\n - `en-US`: English\n - `es-US`: Spanish\n" CardArray200Response: allOf: - type: object properties: errors: type: array items: {} example: [] requestId: type: string example: 1249a3bf-aca1-40dd-9fba-2a3193550c39 status: type: integer enum: - 200 throttle: type: object properties: periodEndsAt: $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate' periodLengthInSeconds: $ref: '#/components/schemas/HelixId' periodRequestLimit: $ref: '#/components/schemas/HelixId' requestsRemainingInPeriod: $ref: '#/components/schemas/HelixId' warningThreshold: type: number format: decimal example: 0.2 - type: object properties: data: type: array items: $ref: '#/components/schemas/CardObject200Response/allOf/1/properties/data' CustomerObject200Response: allOf: - $ref: '#/components/schemas/CardArray200Response/allOf/0' - type: object properties: data: type: object properties: accessTypeCode: allOf: - deprecated: true - $ref: '#/components/schemas/CustomerNoBusinessFieldsArray200Response/allOf/1/properties/data/items/properties/accessTypeCode' accounts: type: - array - 'null' items: $ref: '#/components/schemas/AccountObject200Response/allOf/1/properties/data' description: An array of account objects owned by the customer addresses: type: - array - 'null' items: $ref: '#/components/schemas/AddressItem' attestationDate: $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate' attesterName: type: string maxLength: 50 attesterTitle: type: string maxLength: 50 description: Title of the person attesting to the business' information birthDate: allOf: - description: 'Format: yyyy-MM-ddT00:00:00.000+00:00 Example: `1976-07-04T00:00:00.000+00:00` ' - $ref: '#/components/schemas/DateTimeProperty' businessDescription: type: string maxLength: 200 businessLegalName: type: string maxLength: 300 businessNameOnCard: type: string maxLength: 26 businessWebsite: type: string maxLength: 100 cards: type: - array - 'null' items: $ref: '#/components/schemas/CardObject200Response/allOf/1/properties/data' customerCount: $ref: '#/components/schemas/HelixId' createdDate: allOf: - description: 'Date the customer was created. **Note: a customer may have been created but is not available for use, depending on the `isLocked` or `status` properties.** ' - $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate' culture: $ref: '#/components/schemas/CultureProperty' customField1: type: string maxLength: 100 customField2: type: string maxLength: 100 customField3: type: string maxLength: 100 customField4: type: string maxLength: 100 customField5: type: string maxLength: 100 customerId: $ref: '#/components/schemas/HelixId' doingBusinessAs: type: string maxLength: 200 deceasedDate: $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate' documentsAcceptedDate: $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate' driversLicenseExpireDate: $ref: '#/components/schemas/DateTimeProperty' driversLicenseIssueDate: $ref: '#/components/schemas/DateTimeProperty' driversLicenseNumber: type: string driversLicenseNumberMasked: type: string driversLicenseState: $ref: '#/components/schemas/FormationState' emailAddress: type: string exemptFromBeneficialOwnershipReasonType: $ref: '#/components/schemas/ExemptFromBeneficialOwnershipReasonType' externalAccounts: type: - array - 'null' items: $ref: '#/components/schemas/ExternalAccountObject200Response/allOf/1/properties/data' firstName: type: string foreignDocumentCountryCode: type: string maxLength: 3 foreignDocumentExpirationDate: $ref: '#/components/schemas/DateTimeProperty' foreignDocumentNumber: type: string maxLength: 30 foreignDocumentNumberMasked: type: string foreignDocumentType: $ref: '#/components/schemas/ForeignDocumentType' formationDate: $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate' formationState: $ref: '#/components/schemas/FormationState' fraudStatus: type: string description: 'Customer''s status in regards to the ''fraud'' customer verification module. ' enum: - '' - Verified - Denied - Automated Review - Manual Review - Resubmit gender: $ref: '#/components/schemas/GenderProperty' idStatus: $ref: '#/components/schemas/CustomerObject200Response/allOf/1/properties/data/properties/status' industryClassificationCodeId: $ref: '#/components/schemas/HelixId' iqStatus: type: string enum: - '' - Verified - Denied - Automated Review - Manual Review - Resubmit isActive: type: boolean description: Use `status` instead. deprecated: true isBusiness: type: boolean isDocumentsAccepted: type: boolean isExemptFromBeneficialOwnership: type: boolean isLocked: type: boolean isMinor: type: boolean isOptedInToBankCommunication: type: boolean isRelianceAgreement: type: boolean isSubjectToBackupWithholding: type: boolean isTaxExempt: type: boolean kybStatus: type: string enum: - Initiated - Manual Review - Verified - Denied - Expired - Deceased - Archived - Automated Review kybStatusDate: $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate' kycStatus: type: string enum: - '' - Verified - Denied - Automated Review - Manual Review - Resubmit lastContactDate: $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate' lastContactType: $ref: '#/components/schemas/LastContactType' lastModifiedDate: $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate' lastName: type: string legalEntityType: type: string enum: - Individual - SingleMemberLLC - SCorporation - CCorporation - SoleProprietorship - NonProfit - Association - Partnership - LimitedLiabilityCompany - LimitedLiabilityPartnership - RevocableTrust - IrrevocableTrust - FinancialInstitutionOther - Estate - Trust - Church - Conservator - Guardianship - Government - Cooperative - BCorporation - TottenTrustPOD - LimitedPartnership - GeneralPartnership - GovernmentDepartment - GovernmentAgency - GovernmentAuthority - GovernmentNonCommercialNonUSDepartmentOrAgency - GovernmentOther - RegulatedFinancialInstitution - RegulatedBankLoanHoldingsCompany - RegulatedSavingsAndLoanHoldingCompany - ForeignFinancialInstitutionRegulatorKeepsUBOInfo lockedDate: $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate' lockedReason: type: string middleName: type: string ofacStatus: type: string enum: - '' - Verified - Denied - Automated Review - Manual Review - Resubmit passportCountry: type: string passportExpireDate: $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate' passportIssueDate: $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate' passportNumber: type: string passportNumberMasked: type: string phones: type: - array - 'null' items: $ref: '#/components/schemas/PhoneItem' preferredName: type: string maxLength: 21 qualiFileStatus: type: string deprecated: true residencyStatusType: $ref: '#/components/schemas/ResidencyStatusType' status: type: string enum: - Active - Initiated - Manual Review - Verified - Denied - Expired - Archived - Deceased - Automated Review - Resubmit suffix: type: string tag: type: string taxId: $ref: '#/components/schemas/TaxId' taxIdMasked: type: string taxIdType: $ref: '#/components/schemas/TaxIdType' usePreferredNameOnCard: type: boolean default: false SuffixProperty: type: string maxLength: 20 CardVendorTypeCode: type: string CustomerSetLastContact200Response: allOf: - $ref: '#/components/schemas/CardArray200Response/allOf/0' - type: object properties: data: type: array items: type: object properties: customerId: $ref: '#/components/schemas/HelixId' dormancyStatus: type: string enum: - Active - Inactive - Dormant lastContactDate: type: string format: date-time example: '2021-01-07T19:00:59.761-06:00' lastContactType: $ref: '#/components/schemas/LastContactType' PassportNumber: type: string maxLength: 30 DriversLicenseNumber: type: string maxLength: 30 AccountLockReasonTypeCode: type: string enum: - UNK - FRD - ADM - TMP - FRZ - SUS - CO - RTN - REC - DED - DOR description: '- `UNK`: Unknown - `FRD`: Fraud investigation - `ADM`: Administrative - `TMP`: Temporary - `FRZ`: Freeze - `SUS`: Suspected fraud - `CO`: Credits only - `RTN`: Return risk - `REC`: Recovery - `DED`: Deceased - `DOR`: Dormant ' CustomerCreate200Response: allOf: - $ref: '#/components/schemas/CardArray200Response/allOf/0' - type: object properties: data: type: object properties: customerId: $ref: '#/components/schemas/HelixId' customerToken: type: string messages: deprecated: true type: array items: {} questions: deprecated: true type: array items: {} verificationStatus: deprecated: true type: string MonthProperty: type: integer minimum: 1 maximum: 12 CustomerArchive200Response: allOf: - $ref: '#/components/schemas/CardArray200Response/allOf/0' - type: object properties: data: type: object properties: accounts: type: array items: {} addresses: type: array items: {} cards: type: array items: {} customerId: $ref: '#/components/schemas/HelixId' externalAccounts: type: array items: {} phones: type: array items: {} status: type: string enum: - Archived CloseReasonNotes: type: string maxLength: 255 description: Required if `closeReason` is `Other` TagProperty: type: string maxLength: 50 PostalCode: type: string maxLength: 9 HelixId: type: integer format: int32 minimum: 1 CustomerNote200Response: allOf: - $ref: '#/components/schemas/CardArray200Response/allOf/0' - type: object properties: data: type: object properties: customerId: $ref: '#/components/schemas/HelixId' note: type: string RenewalOverride: type: string PhoneItem: type: object required: - number - phoneType properties: isActive: type: boolean readOnly: true number: type: string phoneType: type: string enum: - Home - Mobile - Office AccountClose200Response: allOf: - $ref: '#/components/schemas/CardArray200Response/allOf/0' - type: object properties: data: type: object properties: customerId: $ref: '#/components/schemas/HelixId' accountId: $ref: '#/components/schemas/HelixId' closeToAccountId: $ref: '#/components/schemas/HelixId' transactionId: type: integer format: int64 minimum: 1 transactionTag: $ref: '#/components/schemas/TagProperty' closingBalanceAmount: type: number format: decimal interestPaidAmount: type: number format: decimal totalClosingAmount: type: number format: decimal isClosedToExternalAccount: type: boolean FormationState: type: string maxLength: 2 TaxId: type: string maxLength: 30 description: No formatting (no dashes, spaces, etc). CustomerArray200Response: allOf: - $ref: '#/components/schemas/CardArray200Response/allOf/0' - type: object properties: data: type: array items: $ref: '#/components/schemas/CustomerObject200Response/allOf/1/properties/data' CardPriority: type: integer format: int32 minimum: 1 maximum: 4 GenderProperty: type: string enum: - M - F - U RecurringContributionType: type: string enum: - None - BiWeekly - Monthly DateTimeProperty: type: string format: date-time example: '2000-07-04T00:00:00.000+00:00' CardQualifierCode: type: string AddressLine: type: string maxLength: 100 CustomerLastName: type: string maxLength: 128 ForeignDocumentType: type: string enum: - DriversLicense - ConsularIdCard - Passport - PermanentResidentCard - EmploymentAuthorizationCard - VoterRegistrationCard - IdentificationCard ResidencyStatusType: type: string enum: - UsCitizen - ResidentAlien - NonResidentAlien FirstName: type: string maxLength: 64 YearProperty: type: integer minimum: 1900 maximum: 9999 CountryProperty: type: string maxLength: 50 LastContactType: type: string enum: - Log In - Phone - Email - Chat AddressItem: type: object required: - addressLine1 - addressType - city - country - postalCode - state properties: addressLine1: $ref: '#/components/schemas/AddressLine' addressLine2: $ref: '#/components/schemas/AddressLine' addressLine3: $ref: '#/components/schemas/AddressLine' addressLine4: $ref: '#/components/schemas/AddressLine' addressType: type: string enum: - Individual - Mailing - PrimaryBusiness - Business - Registered - TaxFormMailing city: $ref: '#/components/schemas/CityProperty' country: $ref: '#/components/schemas/CountryProperty' isActive: type: boolean readOnly: true postalCode: $ref: '#/components/schemas/PostalCode' state: $ref: '#/components/schemas/FormationState' parameters: PageSize: name: pageSize in: query required: false description: How many results to return on each page. Maximum is 200. schema: type: integer default: 200 minimum: 0 maximum: 200 CustomerIdPath: name: customerId in: path required: true schema: $ref: '#/components/schemas/HelixId' PageNumber: name: pageNumber in: query required: false description: Which page of the results to return. Use 0 to get the first page. schema: type: integer default: 0 minimum: 0 maximum: 200 securitySchemes: basicAuth: type: http scheme: basic x-samples-languages: - curl - node - python - csharp - ruby - go - java - kotlin - php x-provenance: method: searched source: https://docs.helix.q2.com/reference harvested: '2026-10-14' tool: harvest-readme-openapi.py note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored. assembled_from: - https://docs.helix.q2.com/reference/accountaddentitlement.md - https://docs.helix.q2.com/reference/accountbeneficiaryadd.md - https://docs.helix.q2.com/reference/accountbeneficiaryedit.md - https://docs.helix.q2.com/reference/accountbeneficiaryget.md - https://docs.helix.q2.com/reference/accountbeneficiarylist.md - https://docs.helix.q2.com/reference/accountbeneficiaryremove.md - https://docs.helix.q2.com/reference/accountbeneficiaryreplace.md - https://docs.helix.q2.com/reference/accountclose.md - https://docs.helix.q2.com/reference/accountcreate.md - https://docs.helix.q2.com/reference/accounteditentitlement.md - https://docs.helix.q2.com/reference/accountget.md - https://docs.helix.q2.com/reference/accountgetbytag.md - https://docs.helix.q2.com/reference/accountlimitdelete.md - https://docs.helix.q2.com/reference/accountlimitlist.md - https://docs.helix.q2.com/reference/accountlimitset.md - https://docs.helix.q2.com/reference/accountlist.md - https://docs.helix.q2.com/reference/accountlistentitlements.md - https://docs.helix.q2.com/reference/accountlock.md - https://docs.helix.q2.com/reference/accountplacehold.md - https://docs.helix.q2.com/reference/accountreleasehold.md - https://docs.helix.q2.com/reference/accountremoveentitlement.md - https://docs.helix.q2.com/reference/accountstoppaycreatecheckstoppay.md - https://docs.helix.q2.com/reference/accountstoppayexpire.md - https://docs.helix.q2.com/reference/accountstoppaylist.md - https://docs.helix.q2.com/reference/accountunlock.md - https://docs.helix.q2.com/reference/accountupdate.md - https://docs.helix.q2.com/reference/bankdocumentdownload.md - https://docs.helix.q2.com/reference/bankdocumentlist.md - https://docs.helix.q2.com/reference/cardaddaccount.md - https://docs.helix.q2.com/reference/cardarchive.md - https://docs.helix.q2.com/reference/cardcontrolarchive.md - https://docs.helix.q2.com/reference/cardcontrolarchivebytag.md - https://docs.helix.q2.com/reference/cardcontrolcreate.md - https://docs.helix.q2.com/reference/cardcontrolget.md - https://docs.helix.q2.com/reference/cardcontrolgetbytag.md - https://docs.helix.q2.com/reference/cardcreatedigital.md - https://docs.helix.q2.com/reference/cardfraudtextalertget.md - https://docs.helix.q2.com/reference/cardfraudtextalertoptout.md - https://docs.helix.q2.com/reference/cardget.md - https://docs.helix.q2.com/reference/cardgetbytag.md - https://docs.helix.q2.com/reference/cardhotlist.md - https://docs.helix.q2.com/reference/cardinitiate.md - https://docs.helix.q2.com/reference/cardlimitget.md - https://docs.helix.q2.com/reference/cardlimitoverride.md - https://docs.helix.q2.com/reference/cardlimitreset.md - https://docs.helix.q2.com/reference/cardlimittemporaryoverride.md - https://docs.helix.q2.com/reference/cardlist.md - https://docs.helix.q2.com/reference/cardlock.md - https://docs.helix.q2.com/reference/cardmockadminfalconfraud.md - https://docs.helix.q2.com/reference/cardmockdeclinepurchaseauthorize.md - https://docs.helix.q2.com/reference/cardmockdepositpurchasereturn.md - https://docs.helix.q2.com/reference/cardmockdepositpurchasereturnreversal.md - https://docs.helix.q2.com/reference/cardmockwithdrawalcardcash.md - https://docs.helix.q2.com/reference/cardmockwithdrawalpurchaseauthorize.md - https://docs.helix.q2.com/reference/cardmockwithdrawalpurchasecomplete.md - https://docs.helix.q2.com/reference/cardorderphysical.md - https://docs.helix.q2.com/reference/cardprovisionapplepay.md - https://docs.helix.q2.com/reference/cardprovisioncarddetail.md - https://docs.helix.q2.com/reference/cardprovisiongooglepay.md - https://docs.helix.q2.com/reference/cardreissue.md - https://docs.helix.q2.com/reference/cardremoveaccount.md - https://docs.helix.q2.com/reference/cardrenewaloverride.md - https://docs.helix.q2.com/reference/cardreprioritizeaccount.md - https://docs.helix.q2.com/reference/cardresetpin.md - https://docs.helix.q2.com/reference/cardriskfactorget.md - https://docs.helix.q2.com/reference/cardriskfactorset.md - https://docs.helix.q2.com/reference/cardunlock.md - https://docs.helix.q2.com/reference/cardupdate.md - https://docs.helix.q2.com/reference/cardverify.md - https://docs.helix.q2.com/reference/cardverifybycvv.md - https://docs.helix.q2.com/reference/customeranswerlist.md - https://docs.helix.q2.com/reference/customeranswerpost.md - https://docs.helix.q2.com/reference/customerarchive.md - https://docs.helix.q2.com/reference/customerbeneficiaryaccountassignmentlist.md - https://docs.helix.q2.com/reference/customerbeneficiarycreate.md - https://docs.helix.q2.com/reference/customerbeneficiarydeactivate.md - https://docs.helix.q2.com/reference/customerbeneficiaryget.md - https://docs.helix.q2.com/reference/customerbeneficiarylist.md - https://docs.helix.q2.com/reference/customerbeneficiaryupdate.md - https://docs.helix.q2.com/reference/customercreate.md - https://docs.helix.q2.com/reference/customercreatebusiness.md - https://docs.helix.q2.com/reference/customercreatebusinessapplication.md - https://docs.helix.q2.com/reference/customerdocumentget.md - https://docs.helix.q2.com/reference/customerdocumentlist.md - https://docs.helix.q2.com/reference/customerdocumentupdatestatus.md - https://docs.helix.q2.com/reference/customerdocumentupload.md - https://docs.helix.q2.com/reference/customergeneratetoken.md - https://docs.helix.q2.com/reference/customerget.md - https://docs.helix.q2.com/reference/customergetbyemail.md - https://docs.helix.q2.com/reference/customergetbytag.md - https://docs.helix.q2.com/reference/customerlist.md - https://docs.helix.q2.com/reference/customernote.md - https://docs.helix.q2.com/reference/customernoteslist.md - https://docs.helix.q2.com/reference/customerrelationshiparchive.md - https://docs.helix.q2.com/reference/customerrelationshipcreate.md - https://docs.helix.q2.com/reference/customerrelationshiplist.md - https://docs.helix.q2.com/reference/customerrelationshipupdate.md - https://docs.helix.q2.com/reference/customerrelationshipupdateprimarycontact.md - https://docs.helix.q2.com/reference/customersearch.md - https://docs.helix.q2.com/reference/customersecurityanswerslist.md - https://docs.helix.q2.com/reference/customersetlastcontact.md - https://docs.helix.q2.com/reference/customerupdate.md - https://docs.helix.q2.com/reference/customerupdateaddress-2.md - https://docs.helix.q2.com/reference/externalaccountarchive.md - https://docs.helix.q2.com/reference/externalaccountcreate.md - https://docs.helix.q2.com/reference/externalaccountdocumentupload.md - https://docs.helix.q2.com/reference/externalaccountget.md - https://docs.helix.q2.com/reference/externalaccountgetbytag.md - https://docs.helix.q2.com/reference/externalaccountinitiate.md - https://docs.helix.q2.com/reference/externalaccountlist.md - https://docs.helix.q2.com/reference/externalaccountlock.md - https://docs.helix.q2.com/reference/externalaccountresendverification.md - https://docs.helix.q2.com/reference/externalaccountunlock.md - https://docs.helix.q2.com/reference/externalaccountupdate.md - https://docs.helix.q2.com/reference/externalaccountverify.md - https://docs.helix.q2.com/reference/feeconfiglist.md - https://docs.helix.q2.com/reference/feeget.md - https://docs.helix.q2.com/reference/feegetbycustomertag.md - https://docs.helix.q2.com/reference/programget.md - https://docs.helix.q2.com/reference/programlistaccountholds.md - https://docs.helix.q2.com/reference/programlistindustryclassificationcodes.md - https://docs.helix.q2.com/reference/programquestionslist.md - https://docs.helix.q2.com/reference/statementdownload.md - https://docs.helix.q2.com/reference/statementget.md - https://docs.helix.q2.com/reference/statementlist.md - https://docs.helix.q2.com/reference/statementsearch.md - https://docs.helix.q2.com/reference/transactioncreatefee.md - https://docs.helix.q2.com/reference/transactionget.md - https://docs.helix.q2.com/reference/transactiongetbytag.md - https://docs.helix.q2.com/reference/transactionlist.md - https://docs.helix.q2.com/reference/transactionsetavailabledate.md - https://docs.helix.q2.com/reference/transactionsetstatus.md - https://docs.helix.q2.com/reference/transactionwireget.md - https://docs.helix.q2.com/reference/transferachoriginationcreate.md - https://docs.helix.q2.com/reference/transfercreate.md - https://docs.helix.q2.com/reference/transfervoid.md - https://docs.helix.q2.com/reference/transferwirecreate-2.md merge: pages: 137 deduped: 1427 conflicts_kept_first: 0