Guides
Guides/Applications

Applications

Manage the full lifecycle of broker-managed Business Plus and Individual Plus applications — from creation through KYB/KYC review to approval.

Applications

The Applications API covers two broker-managed products:

  • Business Plus is for a business entity. Create an empty application, upload documents, complete the form, and add officers.
  • Individual Plus is for an individual applicant. The applicant is the application, so there are no officers to add or remove.

Version 2 is the current flow. Version 1 paths and request bodies are unchanged.


Version 2 — Business Plus

  1. Create Business Plus Application creates an empty application and returns its id. Use that id on every later call.
  2. Get Business Plus Application returns the application and lists the documents that are still required.
  3. Upload Document uploads a file. Documents flagged needForFormExtraction are read automatically and used to pre-fill the form. Call Get Business Plus Application again to review those values.
  4. Update Business Plus Application fills in or edits the form. Send the application id, and call it again whenever the details change.
  5. Create Officer adds an owner, director, shareholder, or beneficial owner.
  6. Update Officer edits an officer who is already on the application.
  7. Delete Officer removes an officer.

Version 2 — Individual Plus

  1. Create Individual Plus Application creates an empty application and returns its id. Use that id on every later call.
  2. Get Individual Plus Application returns the application and lists the documents that are still required.
  3. Upload Document uploads a file. Documents flagged needForFormExtraction are read automatically and used to pre-fill the form. Call Get Individual Plus Application again to review those values.
  4. Update Individual Plus Application fills in or edits the form. Send the complete Individual form, including Individual.Id and Individual.Version from the last response.

Version 2 — Shared

Answer Application Ask answers a question FV Bank asked about an application. Copy the question text exactly from the detail response.

Key concepts

  • ApplicationId is returned when the application is created. Later calls use that id.
  • ApplicationType is BUSINESS for Business Plus and INDIVIDUAL_PLUS for Individual Plus. A Business Plus detail response includes Business and Individuals. An Individual Plus detail response includes IndividualPlus.
  • Action items on the detail response are Form, Kyc, and Document records. Each state is missing (action needed), submitted (under review), approved, or rejected.
  • Document extraction applies in version 2. Documents flagged needForFormExtraction are read automatically and used to pre-fill the form.
  • Optimistic locking applies when you send Version. A stale version returns dirty_update (400).
  • Locked applications return 423. No changes are allowed until FV Bank unlocks the application.

Business Plus form changes in version 2

Removed: monthly per-rail counts and amounts, AmountOfInitialDeposit, AverageBalance, HasBusinessPlan, Businesses, BusinessOther, RegulatedDisclosure, RegulatoryAgency, MoneyServicesBusiness, PrimaryBusinessModel, MerchantAcquirerPsp, Phone, BusinessProductServices, DepositReasons, PaymentReasons, Penalty, PenaltyDetails, Litigation, LitigationDetails, LiquidFunds, BankAccountAnotherFinancialInstitution, AdditionalBankAccountInstName, Engage, EmpCount, OperationStartDate, OperateEstDate, InternationalCustomers, HasCoinConversionPlan, HasCryptoConversionPlan, DealsInCryptocurrency.

Added: BusinessRegistrationState, IsFinancialInstitution, CountriesOfOperations, BusSourceOfWealth, BusPurposeOfAccount, AnnualRevenue, ExpectedDepositVolumeTier, ExpectedDepositVolumeTierOther, ExpectedPaymentVolumeTier, ExpectedPaymentVolumeTierOther, CustomersInSanctionedCountries, HasSanctionedCountryExposure.

Individual Plus form changes in version 2

Removed: monthly per-rail counts and amounts, InterestedInCrypto, HasCoinConversionPlan, HasCryptoConversionPlan, HasCriminalRecord, CriminalRecordDetail, CountryOfBirth, CardAvail.

Added: SourceOfFund, ExpectedDepositVolumeTier, ExpectedDepositVolumeTierOther, ExpectedPaymentVolumeTier, ExpectedPaymentVolumeTierOther, and OtherBankDetails (required when HasBankAccount is true). Card is required and is 0 or 1. MailingAddress is required when Card is 1. MotherMaidenName is optional.


Version 1

Version 1 still uses one detail page for both products.

Business Plus

  1. Create Application submits the KYB payload without Business.Id. Save the ApplicationId.
  2. Upsert Individual adds each officer. Omit Id to create one. To edit an officer, send that officer's Id and Version.
  3. Upload Document uploads required documents. Use Documents[].DocumentType from Get Application as the type parameter.
  4. Get Application shows the action-item states.
  5. Delete Individual removes an officer.
  6. Re-submit Application (Update) sends Business.Id when the form needs to be corrected.

Individual Plus

  1. Upsert Individual Plus Application creates the application when Individual.Id is null, and updates it when you send Individual.Id and Individual.Version.
  2. Upload Document uploads required documents.
  3. Get Application shows the action-item states.

Both products

Search guide books, endpoints, paths, or parameters

↑↓navigate↵openEscclose