Sandbox LoginProduction LoginStatus Page
Quickstart Guides

Retrieve Customer Details

Suggest Edits

This endpoint allows you to retrieve the information about a specific customer within the system. By using this endpoint, you can access key customer data, including their profile, associated virtual IBANs, and other relevant details. You can either list all customers or else choose to list only a specific one. Examples below:

🚧

BETA Endpoints

Please note that these endpoints are currently in beta, and they may undergo changes as we continue to improve and refine the functionality.


📘

Note

This endpoint includes pagination.

  • page: page number which starts from 0
  • size: page size which limits the number of returned customers in the response

Retrieving all customer details

Request

EnvironmentEndpoint
ProductionGET https://api.bvnk.com/api/platform/v1/customers
SandboxGET https://api.sandbox.bvnk.com/api/platform/v1/customers
curl --location 'https://api.sandbox.bvnk.com/api/platform/v1/customers' \
--header 'Authorization: Hawk id="vOjKT0txxpp6TMQP6QTQziyBjAiVnMGNH3dbFa0SGhK7OFsMD6lWFPaN8TXCqkXk", ts="1724508332", nonce="O7KMY1", mac="yBxrGq5pKFcAe0taEYf/OI3rQwJDHHF3S6rZB9WVjCw="'

Response

HTTP 200 OK


{
    "content": [
        {
            "reference": "6f6c6bee-58e7-4bc3-ae43-b7f84cd6cc93",
            "status": "PENDING",
            "type": "COMPANY",
            "name": "Umbrella Ltd",
            "description": "This is the company description"
        },
        {
            "reference": "71a4bffc-8f23-4601-9f36-194c041c99eb",
            "status": "PENDING",
            "type": "COMPANY",
            "name": "Acme",
            "description": "This is the company description"
        }
    ],
    "pageable": {
        "pageNumber": 0,
        "pageSize": 20,
        "sort": {
            "empty": true,
            "sorted": false,
            "unsorted": true
        },
        "offset": 0,
        "paged": true,
        "unpaged": false
    },
    "last": true,
    "totalPages": 1,
    "totalElements": 20,
    "first": true,
    "size": 20,
    "number": 0,
    "sort": {
        "empty": true,
        "sorted": false,
        "unsorted": true
    },
    "numberOfElements": 20,
    "empty": false
}

Retrieving details for a specific customer

Request

EnvironmentEndpoint
ProductionGET https://api.bvnk.com/api/platform/v1/customers/{customerReference}
SandboxGET https://api.sandbox.bvnk.com/api/platform/v1/customers/{customerReference}
curl --location 'https://api.sandbox.bvnk.com/api/platform/v1/customers/6f6c6bee-58e7-4bc3-ae43-b7f84cd6cc93' \
--header 'Authorization: Hawk id="vOjKT0txxpp6TMQP6QTQziyBjAiVnMGNH3dbFa0SGhK7OFsMD6lWFPaN8TXCqkXk", ts="1724508521", nonce="qPtZyf", mac="ykMq5TqZfCsStncuIBNgca5yHBX6OsADtSjytj0El5w="'

Response

HTTP 200 OK

{
    "reference": "6f6c6bee-58e7-4bc3-ae43-b7f84cd6cc93",
    "status": "PENDING",
    "type": "COMPANY",
    "company": {
        "name": "Umbrella Ltd",
        "description": "This is the company description",
        "taxResidenceCountryCode": "DE",
        "registrationNumber": "1849203",
        "industry": {
            "reference": "30ea5818-06d8-11ef-b6e1-027612b7f6b5",
            "name": "Supermarkets/Convenience Store"
        },
        "monthlyExpectedVolumes": {
            "reference": "ef779c41-547e-11ef-8b9c-027612b7f6b5",
            "name": "0 - 500 000.00 EUR",
            "min": 0,
            "max": 500000
        },
        "address": {
            "address1": "Waterloo Bridge 13",
            "address2": null,
            "city": "London",
            "postalCode": "0000",
            "countryCode": "GB",
            "country": "United Kingdom"
        },
        "representative": {
            "reference": "ee5b430e-6abe-4249-b42a-1f4ad089d6d2",
            "firstName": "Donald",
            "lastName": "Duck",
            "dateOfBirth": "1908-11-29",
            "address": {
                "address1": null,
                "address2": null,
                "city": null,
                "postalCode": null,
                "countryCode": "DE",
                "country": "Germany"
            }
        }
    }
}

Retrieving details by specifying page and size

Request

EnvironmentEndpoint
ProductionGET https://api.bvnk.com/api/platform/v1/customers?page={page}&size={size}
SandboxGET https://api.sandbox.bvnk.com/api/platform/v1/customers?page={page}&size={size}\
curl --location 'https://api.sandbox.bvnk.com/api/platform/v1/customers?page=0&size=20' \
--header 'Authorization: Hawk id="vOjKT0txxpp6TMQP6QTQziyBjAiVnMGNH3dbFa0SGhK7OFsMD6lWFPaN8TXCqkXk", ts="1724508332", nonce="O7KMY1", mac="yBxrGq5pKFcAe0taEYf/OI3rQwJDHHF3S6rZB9WVjCw="'

Response

HTTP 200 OK

{
    "content": [
        {
            "reference": "6f6c6bee-58e7-4bc3-ae43-b7f84cd6cc93",
            "status": "PENDING",
            "type": "COMPANY",
            "name": "Umbrella Ltd",
            "description": "This is the company description"
        },
        {
            "reference": "71a4bffc-8f23-4601-9f36-194c041c99eb",
            "status": "PENDING",
            "type": "COMPANY",
            "name": "Acme",
            "description": "This is the company description"
        }
    ],
    "pageable": {
        "pageNumber": 0,
        "pageSize": 2,
        "sort": {
            "empty": true,
            "sorted": false,
            "unsorted": true
        },
        "offset": 0,
        "paged": true,
        "unpaged": false
    },
    "last": false,
    "totalPages": 10,
    "totalElements": 20,
    "first": true,
    "size": 2,
    "number": 0,
    "sort": {
        "empty": true,
        "sorted": false,
        "unsorted": true
    },
    "numberOfElements": 2,
    "empty": false
}

Updated 14 days ago