Skip to main content

Retrieve individual 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: Re-fetches the full customer record by code — everything you sent on Create, plus system-computed fields such as screening status and Virtual Account currency assignment.

Endpoint​

  • Path Parameter — REQUIRED code — the customerRegistration.code returned by Create

Additional Fields in the Response​

FieldNotes
customerIdSystem-generated unique customer identifier, e.g. 100000909313824I
fullName / nickName / tradeNameDerived display names
screeningStatusAML screening state, e.g. IP (in progress)
customerStatus / customerState / customerStateCodeLifecycle status, e.g. Active / System Approved / AA
virtualAccountCurrencyCodes / virtualAccountCurrencyNameCurrencies this customer's VA is provisioned for, e.g. EUR, USD-USA, GBP
providerKYC/screening provider used, e.g. AiPrise
registrationApprovedBy / creationDate / createdByAudit trail fields
info

Response shape is identical to the Business Customer Receipt (Retrieve business VA customer), just without the ownerDetailList array.