Creating an Individual Customer

This endpoint enables you to easily create a individual entity customer within the system.

🚧
Early Access
The Fiat endpoints are currently in early access and may change as we continue to improve and refine their functionality.

📘
Prerequisites
You will need to collect information about the customer before proceeding with the request to create one.

📘
Idempotency supported endpoint
This means you can retry a request without worrying about it being processed multiple times.
To use this feature, add the X-Idempotency-Key header with a unique value (a UUID). This ensures the request is only processed once, even if it's sent multiple times.

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

Create Customer Request

curl --location 'https://api.sandbox.bvnk.com/platform/v1/customer' \
--header 'X-Idempotency-Key: 0b3ed172-e24f-43f5-a901-4f7b6d138ebe' \
--header 'Content-Type: application/json' \
--header 'Authorization: Hawk id="vbfc61D890wg6LAAVbkR11qP9O6cXeMNmKWgcUNZaOHPiQeebp9cl6h02tWv84R8", ts="1728655954", nonce="MdPBLt", mac="jGEwZvz7rVO3lM3Ose8Ww1PtgnsHBe7eFph3Nzj5H6Y="' \
--data '{
    "type": "INDIVIDUAL",
    "individual": {
          "firstName": "Donald",
          "lastName": "Duck",
          "dateOfBirth": "1908-11-29",
          "birthCountryCode": "DE",
          "documentNumber": "A942819",
          "address": {
              "addressLine1": "Majaka 47-10",
              "city": "Xiao",
              "postCode": "0000",
              "countryCode": "EE"
          }
      }
}'

The details supplied to the create an Individual entity customer

Attribute	Type	Required	Description
`type`	String	Yes	The type of entity. E.g., "INDIVIDUAL".
`individual`	Object	Yes	Details of the individual.
`individual.firstName`	String	Yes	The first name of the individual.
`individual.lastName`	String	Yes	The last name of the individual.
`individual.dateOfBirth`	String (Date)	Yes	The date of birth of the individual (YYYY-MM-DD).
`individual.birthCountryCode`	String (ISO 2-digit country code)	Yes	The ISO 3166-1 alpha-2 country code of birth.
`individual.documentNumber`	String	Yes	The identification document number.
`individual.address`	Object	Yes	The address details of the individual.
`individual.address.addressLine1`	String	Yes	The first line of the address.
`individual.address.city`	String	Yes	The city of the address.
`individual.address.postCode`	String	Yes	The postal code of the address.
`individual.address.countryCode`	String (ISO 2-digit country code)	Yes	The ISO 3166-1 alpha-2 country code of the address.

Response

Response Code	Description
202	Successful operation.
400	Bad request.

{
    "reference": "a7e21c62-27b8-4b3b-b51e-eb10edeb1731",
    "status": "PENDING"
}

Attribute	Type	Description
reference	string	A unique identifier for the customer.
status	string	The current status of the customer. Possible values include: `PENDING` - customer is pending verification, `VERIFIED` - customer has been verified, `REJECTED` - customer has been rejected during verification.

Attribute

Type

Description

reference

string

A unique identifier for the customer.

status

string

The current status of the customer.
Possible values include:

PENDING - customer is pending verification,
VERIFIED - customer has been verified,
REJECTED - customer has been rejected during verification.