Step 1: Creating a Customer

This endpoint enables you to easily create a customer within the system. This functionality allows you to establish a unique customer profile, which can then be used to generate virtual IBANs and manage payment flows tailored to that specific customer. By integrating this endpoint, you can streamline the onboarding process and efficiently manage customer data, setting the foundation for smooth and secure transactions.

🚧
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.

Request

Environment	Endpoint
Production	`POST` `https://api.bvnk.com/api/platform/v1/customers`
Sandbox	`POST` `https://api.sandbox.bvnk.com/api/platform/v1/customers`

curl --location 'https://api.sandbox.bvnk.com/api/platform/v1/customers' \
--header 'Content-Type: application/json' \
--header 'Authorization: Hawk id="vOjKT0txxpp6TMQP6QTQziyBjAiVnMGNH3dbFa0SGhK7OFsMD6lWFPaN8TXCqkXk", ts="1724851582", nonce="ToTqWt", mac="cX2SNYVllhPk4a0qPjVHV5gl8MTngnXfcMOxoidSUd0="' \
--data '{
    "type": "COMPANY",
    "company": {
        "name": "UK Ltd Version 2.0",
        "description": "Number 1 customer, be super nice.",
        "taxResidenceCountryCode": "DE",
        "registrationNumber": "1849203",
        "industryReference" : "56e65ebc-06fa-11ef-bbf8-02d3d923cf2b",
        "monthlyExpectedVolumesReference" : "a4318a0d-5316-11ef-9887-0289b1b0d83d",
        "address": {
            "address1": "Waterloo Bridge 13",
            "city": "London",
            "postalCode": "0000",
            "countryCode": "GB"
        },
        "representative": {
            "firstName": "Donald",
            "lastName": "Duck",
            "dateOfBirth": "1908-11-29",
            "address": {
                "countryCode": "DE"
            }
        }
    }
}'

The details supplied to the create customer request

Parameter	Type	Description
`type`	enum	COMPANY
`company.name`	varchar	Required
`company.description`	varchar	Optional field for description of customer
`company.monthlyExpectedVolumesReference`	varchar	Monthly expected volumes reference. Get the list here.
`company.industryReference`	varchar	Industry reference. Get the list here.
`company.taxResidenceCountryCode`	ISO 2-digit country code	Required
`company.RegistrationNumber`	varchar	Required, company registration number
`company.address`	object	Required, company address
`company.address.address1`	varchar	Required
`company.address.address2`	varchar	Optional
`company.address.city`	varchar	Required
`company.address.postalCode`	varchar	Required
`company.address.countryCode`	ISO 2-digit country code	Required
`company.representative`	object	Required
`company.representative.firstName`	varchar	Required
`company.representative.lastName`	varchar	Required
`company.representative.dateOfBirth`	date	Required
`company.representative.countryCode`	ISO 2-digit country code	Required

Response

HTTP 201 Created

{
    "reference": "6cabc548-2723-4623-a885-124e9c8644d0",
    "status": "PENDING"
}

HTTP 400 Bad Request

{
    "code": "ACCOUNTS-2000",
    "status": "BAD_REQUEST",
    "message": "Invalid request",
    "details": {
        "documentLink": null,
        "errors": {
            "monthlyExpectedVolumesReference": [
                "Monthly expected volumes with reference: a4318a0d-5316-11ef-9887-0289b1b0d83d does not exist"
            ],
            "industryReference": [
                "Industry with reference: 56e65ebc-06fa-11ef-bbf8-02d3d923cf2b does not exist"
            ]
        }
    }
}

🚧BETA Endpoints

Request

Response

🚧
BETA Endpoints