Skip to main content
Opening a virtual account is requirements-driven. You open the group first and Hop tells you what is outstanding: Get Virtual Account Group returns a requirements list, and you clear it item by item. There is no submit step.

​
Accounts, groups and virtual accounts

An account is the business or person you open virtual accounts for. Its identity and associated persons are what gets verified, and its virtual accounts carry its name. A platform customer uses one account per end customer, created with Create Account. A group is what an account is verified and enabled through before it can hold virtual accounts. An account can hold several groups. Opening the same type again returns the existing group. A virtual account belongs to one group. A group can hold several, in any of its currencies, including more than one per currency.
↳ Account type is set by the identity profile (type: “business” | “individual”) and decides what else is required. A business entity is signed for by an associated person marked is_signer; an individual signs as itself and has no associated persons. Two gates stand between a new group and a usable one: the provider approves onboarding, then Hop enables the group.
Youthe API callerHopautomaticBankpartner bank

​
Business account

  1. Identity
  2. 1You
    Platform customers: create the account for the end customer, with its identity and associated persons in the same callPOST/customers/{cid}/accounts acct_
  3. 2You
    Set the account identity: legal name, registration number, incorporation date, registered addressPATCH/customers/{cid}/accounts/{aid}
  4. 3You
    Add the people behind the entity: at least one with is_signerPOST/accounts/{aid}/associated-persons aap_
  5. Open the group
  6. 4You
    Open the group: safe to call before the identity is set, it just comes back with a requirementPOST/accounts/{aid}/virtual-account-groups vag_
  7. 5Hop
    Raises the agreements the entity must signagr_
  8. Clear requirements
  9. 6You
    Read what is outstanding. This list drives everything that followsGET/virtual-account-groups/{gid} requirements[]
  10. 7You
    Accept the agreements, naming the signerPOST/{gid}/agreements/actions signer_id required
  11. 8You
    Upload each requested document against its requirement keyPOST/{gid}/documents doc_
  12. Review
  13. 9Hop
    Submits the entity once nothing is outstanding. No call from youunder_review
  14. 10Bank
    Verifies the entity and its people, then approves or asks for moreapproved · action_needed
  15. Go live
  16. 11Hop
    Enables the group. Virtual accounts can now be createdstatus: enabled
  17. 12You
    Create a virtual account in the currency you needPOST/{gid}/virtual-accounts va_
  18. 13Bank
    Issues the bank details; the virtual account leaves pendingIBAN · account number

​
Individual account

  1. Identity
  2. 1You
    Platform customers: create the account for the end customer, with its identity in the same callPOST/customers/{cid}/accounts acct_
  3. 2You
    Set the account identity: name, date of birth, nationality, address, tax residence and due-diligence answersPATCH/customers/{cid}/accounts/{aid}
  4. Open the group
  5. 3You
    Open the group. No associated persons are needed for an individualPOST/accounts/{aid}/virtual-account-groups vag_
  6. 4Hop
    Raises the agreements the person must signagr_
  7. Clear requirements
  8. 5You
    Read what is outstanding. For an individual this is profile fields and identity documentsGET/virtual-account-groups/{gid} requirements[]
  9. 6You
    Accept the agreements: omit signer_id, the person signs as themselvesPOST/{gid}/agreements/actions no signer_id
  10. 7You
    Upload each requested document against its requirement keyPOST/{gid}/documents doc_
  11. Review
  12. 8Hop
    Submits the person once nothing is outstanding. No call from youunder_review
  13. 9Bank
    Verifies the person, then approves or asks for moreapproved · action_needed
  14. Go live
  15. 10Hop
    Enables the group. Virtual accounts can now be createdstatus: enabled
  16. 11You
    Create a virtual account in the currency you needPOST/{gid}/virtual-accounts va_
  17. 12Bank
    Issues the bank details; the virtual account leaves pendingIBAN · account number

​
What each requirement means

Everything after the group is opened is driven by the requirements list on Get Virtual Account Group. Four kinds appear: Saving an identity profile or an associated person resumes onboarding on its own, so poll the group rather than re-creating anything.

​
Troubleshooting