Skip to main content
↳ Two gates stand between a new group and a usable one: the provider approves onboarding (onboarding_status: approved), then Hop enables the group (status: enabled). A business is signed for by an associated person marked is_signer; an individual signs as itself and skips step 3.
Youthe API callerHopautomaticBankpartner bank
  1. 1You
    Platform customers: create the account for the end customer, with its identity and associated persons in the same callPOST/customers/{cid}/accountsacct_
  2. 2You
    Set the account identity: legal name, registration number, incorporation date, registered addressPATCH/customers/{cid}/accounts/{aid}
  3. 3You
    Add the people behind the entity, at least one with is_signer (business only)POST/accounts/{aid}/associated-personsaap_
  4. 4You
    Open the group. Safe to call before the identity is set; it returns with a requirementPOST/accounts/{aid}/virtual-account-groupsvag_
  5. 5Hop
    Raises the agreements the entity must signagr_
  6. 6You
    Read what is outstanding; this list drives everything that followsGET/virtual-account-groups/{gid}requirements[]
  7. 7You
    Accept the agreements, naming the signer for a businessPOST/{gid}/agreements/actionssigner_id
  8. 8You
    Upload each requested document against its requirement keyPOST/{gid}/documentsdoc_
  9. 9Hop
    Submits the entity once nothing is outstanding; no call from youunder_review
  10. 10Bank
    Verifies the entity and its people, then approves or asks for moreapproved · action_needed
  11. 11Hop
    Enables the group. Virtual accounts can now be createdstatus: enabled
  12. 12You
    Create a virtual account in the currency you needPOST/{gid}/virtual-accountsva_ pending
  13. 13Bank
    Issues the bank details; the virtual account becomes activeIBAN · account number
Known gaps: steps 9 to 11 and 13 have no webhook and no stated service time, so poll Get Virtual Account Group and Get Virtual Account with backoff. An approved group can return to action_needed after go-live, so keep reading requirements for the life of the account. Some group types charge a creation fee at step 12 that is not readable before the call.

​
Troubleshooting