Look up the country-specific identification type that a customer must provide as their tin value. Each country uses a different identification system (e.g. SSN in the US, BVN in Nigeria, NINO in the UK), and individual vs business customers within the same country may require different types. Call this endpoint before creating or updating a customer to know what field label to show in your UI and what value to collect. Save the collected value as the customer's tin field. Required scope: virtual-account:read.
Authorization
oauth2ClientCredentials virtual-account:readUse your OAuth client credentials to obtain a short-lived Bearer token from POST /oauth/token.
In: header
Scope: virtual-account:read
Query Parameters
Unique identifier of the customer. If provided, country and type are not required.
Two-letter country code (e.g., NG). Required if customer_id is not provided.
2 <= length <= 2Customer type. Required if customer_id is not provided. Possible values: business, individual.
Value in
- "business"
- "individual"
Response Body
application/json
application/json
curl --request GET \ --url 'https://example.com/api/external/virtual-bank-account/identification-type'{ "message": "Identification type retrieved successfully.", "data": { "label": "Bank Verification Number", "country": "NG", "customer_type": "individual" }}GETRetrieve a single virtual bank account
Retrieves details of a specific virtual bank account by its ID. Required scope: `virtual-account:read`.
POSTClose a virtual bank account
Initiate closure of a virtual bank account. Supported currencies: GBP, EUR, NGN, USD. Returns 400 if already closed or provider/currency not supported; 404 if not found. Required scope: `virtual-account:close`.