Customers

Get customer

Changed on Nov 6, 2026

:::info Customers API v2 The new customer onboarding flow is recommended for all new integrations.

If you already have an existing integration with Customers API v1, you can continue using it. BVNK will continue to support this API going forward. :::

get/platform/v1/customers/{customerReference}

Request

Base URL
https://api.sandbox.bvnk.com
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/bvnk/apis/bvnk-api-endpoints/docs/platform/v1/customers/:customerReference/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

customerReferencestring uuid required

Example:0a184641-30e2-4414-871f-3db1c683900e

Customer reference

Response

Success

Example response

{
  "reference": "0a184641-30e2-4414-871f-3db1c683900e",
  "status": "VERIFIED",
  "type": "COMPANY",
  "company": {
    "name": "UK Ltd Version 2.0",
    "description": "Number 1 customer, be super nice.",
    "taxResidenceCountryCode": "DE",
    "registrationNumber": "1849203",
    "industry": {
      "reference": "b59c2055-7655-43bb-923d-0005928301d7",
      "name": "Finance"
    },
    "monthlyExpectedVolumes": {
      "reference": "b59c2055-7655-43bb-923d-0005928301d7",
      "name": "0 - 500 000.00 EUR",
      "max": 500000
    },
    "address": {
      "addressLine1": "123 Main Street",
      "addressLine2": "Apartment 456",
      "postalCode": "NW1 4NP",
      "city": "London",
      "countryCode": "DE",
      "country": "Great Britain",
      "stateCode": "AL"
    },
    "representative": {
      "firstName": "John",
      "lastName": "Mirra",
      "dateOfBirth": "2001-12-31",
      "birthCountryCode": "HK",
      "nationality": "US",
      "address": {
        "addressLine1": "123 Main Street",
        "addressLine2": "Apartment 456",
        "postalCode": "NW1 4NP",
        "city": "London",
        "countryCode": "DE",
        "country": "Great Britain",
        "stateCode": "AL"
      }
    },
    "taxResidences": [
      {
        "country": "ES",
        "tin": "48291734Z",
        "noTinReason": "UNABLE_TO_OBTAIN",
        "noTinExplanation": "Moved to Portugal in September 2026. The NIF application is still being processed."
      }
    ],
    "countryOfIncorporation": "ES",
    "crsClassification": "PASSIVE_NFE",
    "carfClassification": "OTHER_ENTITY",
    "associates": [
      {
        "person": {
          "reference": "29e6a51d-e02b-4aa9-94da-1b7bcb4c6848",
          "firstName": "Michael",
          "lastName": "Johnson",
          "dateOfBirth": "1982-03-24",
          "placeOfBirth": "New York",
          "address": {
            "addressLine1": "123 Main Street",
            "addressLine2": "Apartment 456",
            "postalCode": "NW1 4NP",
            "city": "London",
            "countryCode": "GB",
            "country": "Great Britain",
            "stateCode": "AL"
          }
        },
        "details": {
          "nationality": "US",
          "contactInfo": {
            "emailAddress": "michael.johnson@techcorp.com",
            "phoneNumber": "+12025551234"
          },
          "documentNumber": "123456789",
          "documentInfo": {
            "number": "123456789",
            "type": "PASSPORT",
            "issuingCountryCode": "US"
          },
          "taxIdentification": {
            "number": "123-45-6789",
            "taxResidenceCountryCode": "US"
          }
        },
        "title": "BUSINESS_OWNER",
        "controls": {
          "hasOwnership": true,
          "hasControl": true,
          "isSigner": true
        },
        "ownership": {
          "type": "DIRECT",
          "percentage": 51
        },
        "controllingPersonRole": "LP_OWNERSHIP",
        "taxResidences": [
          {
            "country": "ES",
            "tin": "48291734Z",
            "noTinReason": "UNABLE_TO_OBTAIN",
            "noTinExplanation": "Moved to Portugal in September 2026. The NIF application is still being processed."
          }
        ]
      }
    ]
  }
}

Changes

Nov 6, 2026c386d436bf2c Revision changes
- warning
  added the new GIFT enum value to the ////// response property for the response status
- warning
  added the new STUDENT enum value to the ////// response property for the response status
- warning
  added the new STUDENT_LOAN enum value to the ////// response property for the response status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  removed the NOT_PROVIDED enum value from the ////// response property for the response status
Jun 16, 202697d6c0d2fe2e Revision changes
- warning
  added the new ACCOMMODATION_FOOD_SERVICES enum value to the ////// response property for the response status
- warning
  added the new ADMINISTRATIVE_SUPPORT_WASTE_MANAGEMENT_REMEDIATION_SERVICES enum value to the ////// response property for the response status
- warning
  added the new ADULT_ENTERTAINMENT enum value to the ////// response property for the response status
- warning
  added the new AGRICULTURE_FORESTRY_FISHING_HUNTING enum value to the ////// response property for the response status
- warning
  added the new ARTS_ENTERTAINMENT_RECREATION enum value to the ////// response property for the response status
- warning
  added the new AUCTIONS enum value to the ////// response property for the response status
- warning
  added the new AUTOMOBILES enum value to the ////// response property for the response status
- warning
  added the new BLOCKCHAIN enum value to the ////// response property for the response status
- warning
  added the new CLOSE_ASSOCIATES enum value to the ////// response property for the response status
- warning
  added the new CONSTRUCTION enum value to the ////// response property for the response status
- warning
  added the new CRYPTO enum value to the ////// response property for the response status
- warning
  added the new CRYPTO_TRADING enum value to the ////// response property for the response status
- warning
  added the new DOMESTIC_PEP enum value to the ////// response property for the response status
- warning
  added the new DONATIONS enum value to the ////// response property for the response status
- warning
  added the new DRIVERS enum value to the /////// response property for the response status
- warning
  added the new DRUGS enum value to the ////// response property for the response status
- warning
  added the new EDUCATIONAL_SERVICES enum value to the ////// response property for the response status
- warning
  added the new EXPORT_IMPORT enum value to the ////// response property for the response status
- warning
  added the new E_COMMERCE enum value to the ////// response property for the response status
- warning
  added the new FAMILY_MEMBERS enum value to the ////// response property for the response status
- warning
  added the new FINANCE_INSURANCE enum value to the ////// response property for the response status
- warning
  added the new FINANCIAL_INSTITUTION enum value to the ////// response property for the response status
- warning
  added the new FOREIGN_PEP enum value to the ////// response property for the response status
- warning
  added the new FORMER_PEP_2_YEARS enum value to the ////// response property for the response status
- warning
  added the new FORMER_PEP_OLDER enum value to the ////// response property for the response status
- warning
  added the new GAMBLING enum value to the ////// response property for the response status
- warning
  added the new GAMBLING enum value to the ////// response property for the response status
- warning
  added the new GOODS_SERVICES enum value to the ////// response property for the response status
- warning
  added the new HEALTH_CARE_SOCIAL_ASSISTANCE enum value to the ////// response property for the response status
- warning
  added the new HEDGE_FUND enum value to the ////// response property for the response status
- warning
  added the new ID_CARD enum value to the /////// response property for the response status
- warning
  added the new INCOME_0_TO_50K enum value to the ////// response property for the response status
- warning
  added the new INCOME_100K_TO_250K enum value to the ////// response property for the response status
- warning
  added the new INCOME_250K_TO_500K enum value to the ////// response property for the response status
- warning
  added the new INCOME_500K_TO_750K enum value to the ////// response property for the response status
- warning
  added the new INCOME_50K_TO_100K enum value to the ////// response property for the response status
- warning
  added the new INCOME_750K_TO_1M enum value to the ////// response property for the response status
- warning
  added the new INCOME_ABOVE_1M enum value to the ////// response property for the response status
- warning
  added the new INFORMATION enum value to the ////// response property for the response status
- warning
  added the new INSURANCE enum value to the ////// response property for the response status
- warning
  added the new INVESTMENT enum value to the ////// response property for the response status
- warning
  added the new INVESTMENTS enum value to the ////// response property for the response status
- warning
  added the new MANAGEMENT_OF_COMPANIES_ENTERPRISES enum value to the ////// response property for the response status
- warning
  added the new MANUFACTURING enum value to the ////// response property for the response status
- warning
  added the new MARKET_MAKER enum value to the ////// response property for the response status
- warning
  added the new MINING enum value to the ////// response property for the response status
- warning
  added the new MONEY_SERVICE_BUSINESS enum value to the ////// response property for the response status
- warning
  added the new NON_PROFIT enum value to the ////// response property for the response status
- warning
  added the new NOT_CLASSIFIED enum value to the ////// response property for the response status
- warning
  added the new NOT_PEP enum value to the ////// response property for the response status
- warning
  added the new NOT_PROVIDED enum value to the ////// response property for the response status
- warning
  added the new OTHER enum value to the /////// response property for the response status
- warning
  added the new OTHER_SERVICES enum value to the ////// response property for the response status
- warning
  added the new PASSPORT enum value to the /////// response property for the response status
- warning
  added the new PENSION enum value to the ////// response property for the response status
- warning
  added the new PRECIOUS_METALS enum value to the ////// response property for the response status
- warning
  added the new PROFESSIONAL_SCIENTIFIC_TECHNICAL_SERVICES enum value to the ////// response property for the response status
- warning
  added the new PUBLIC_ADMINISTRATION enum value to the ////// response property for the response status
- warning
  added the new REAL_ESTATE enum value to the ////// response property for the response status
- warning
  added the new REAL_ESTATE_RENTAL_LEASING enum value to the ////// response property for the response status
- warning
  added the new REGISTERED_INVESTMENT_ADVISOR enum value to the ////// response property for the response status
- warning
  added the new RESIDENCE_PERMIT enum value to the /////// response property for the response status
- warning
  added the new RETAIL_TRADE enum value to the ////// response property for the response status
- warning
  added the new RETIRED enum value to the ////// response property for the response status
- warning
  added the new SALARIED enum value to the ////// response property for the response status
- warning
  added the new SALARY enum value to the ////// response property for the response status
- warning
  added the new SAVINGS enum value to the ////// response property for the response status
- warning
  added the new SELF_EMPLOYED enum value to the ////// response property for the response status
- warning
  added the new SELF_EMPLOYMENT enum value to the ////// response property for the response status
- warning
  added the new SHELL_BANK enum value to the ////// response property for the response status
- warning
  added the new STO_ISSUER enum value to the ////// response property for the response status
- warning
  added the new TRANSFERS_FAMILY_FRIENDS enum value to the ////// response property for the response status
- warning
  added the new TRANSFERS_OWN_WALLET enum value to the ////// response property for the response status
- warning
  added the new TRANSPORTATION_WAREHOUSING enum value to the ////// response property for the response status
- warning
  added the new TRAVEL_TRANSPORT enum value to the ////// response property for the response status
- warning
  added the new UNEMPLOYED enum value to the ////// response property for the response status
- warning
  added the new UTILITIES enum value to the ////// response property for the response status
- warning
  added the new WEAPONS enum value to the ////// response property for the response status
- warning
  added the new WHOLESALE_TRADE enum value to the ////// response property for the response status

Operation history