Skip to main content

Retrieve business VA customer

GET
Authentication

Virtual Account APIs use the same access token as the rest of the platform. Obtain it from the Authentication API and send it on every VA call:

Authorization: Bearer <access_token>

Base URLs for each environment are listed under API environments.

note

What this does: Same idea as the Individual Receipt (Retrieve individual VA customer), but for Business — returns the full registration plus enriched fields, including the resolved ownerDetailList[] with each owner's screening state.

Endpoint​

  • Path Parameter — REQUIRED code

Additional Fields vs Create​

FieldNotes
customerId / fullNameSystem-generated ID and resolved display name
legalStatusName / natureOfBusinessName / businessRelationshipNameHuman-readable labels for the codes you submitted
screeningStatus / customerState / customerStateCodeAML/approval lifecycle
ownerDetailList[].ownerId / ownerState / ownerStateCode / screeningStatusPer-owner screening result — each owner is independently screened
virtualAccountCurrencyCodes / virtualAccountCurrencyNameProvisioned VA currencies