Setup your Customers

Here, we’ll introduce you to the concept of a Customer on the Bud platform.

When we refer to a Customer, we’re talking about the end-user of yours and Bud’s technology. Customer entities in Bud have unique identifiers and this is used to store the customer data on the Bud platform.

Some examples of the type of data that can be stored against a customer record include:

• account information (accounts, balances, and transactions) that a customer has ingested through one of Bud’s aggregation services, e.g. Connect;
• enrichment and insight information that has been applied to, or identified from, a Customer’s financial data.

📘

Each customer record is stored encrypted-at-rest with an encryption key that is held only by you as the client

A Customer record can be simply created and deleted via the Customer API and you can see how many Customers are registered against your account in the Customers tab within the Bud Console (log in | info).

In the sandbox environment, you can create as many Customers as you like, free of charge, note however, that the sandbox only permits the use of dummy data.

👍

In the sandbox, you can create an unlimited number of Customers for free

Registering Customers

Register Customers on the Bud platform via the POST v2/customers endpoint (here) by requesting a unique customer_id and customer_secret.

Example request:

curl --location --request POST 'https://api-sandbox.thisisbud/v2/customers' \
--header 'X-Client-Id: 25a4011b-a923-46cd-95c4-16d01df45015' \
--header 'Content-Type: application/json' \
--header "Authorization: Bearer $TOKEN" \
--data-raw '{
  "number_of_customers": 1,
  "customer_context": {
    "type": "personal",
    "region": "GB",
    "locale": "en-GB"
  }
}'

Example response:

{
    "operation_id": "customers_create_v2",
    "data": [
        {
            "customer_id": "22a3cbe3-c2c5-49eb-a38d-e3c9a845100c",
            "customer_secret": "3cde59cb7635447fae26e139899bc4fe4f8d7caadc58da40127153bbf078fb4c3",
            "customer_context": {
                "type": "personal",
                "region": "GB",
                "locale": "en-GB"
            }
        }
    ],
    "metadata": {
        "results": 1
    }
}

The customer_id is used as a unique identifier for that Customer and is required in all API endpoints that relate to a given customer. Similarly, for API endpoints that return any Customer data, the customer_secret is also required in order to decrypt and return that data.

❗️

Please store the customer_id and customer_secret securely as Bud only provides the customer_secret once.

Alternatively you can register multiple Customers via the POST v2/customers endpoint (here). To use this endpoint you must specify a number_of_customers to register and the endpoint will return a collection (aka array) containing, foreach Customer, a customer_id, customer_secret, and customer_context.

📘

Reminder to note that the customer_secret is never stored by Bud, and as a result, customer data is completely inaccessible by Bud.

Removing Customers

Removing (or de-registering) a Customer can be simply achieved through the use of the DELETE /v1/customers/{customer_id} endpoint (here). As well as removing the Customer record, this will completely delete of all data related to that Customer.

Example request:

curl --location --request DELETE 'https://api-sandbox.thisisbud/v1/customers/238e6f4d-add6-436e-a9c7-0386d3a4ece3' \
--header 'X-Client-Id: 25a4011b-a923-46cd-95c4-16d01df45015' \
--header "Authorization: Bearer $TOKEN"

Customers and Payments

If you are only interested in Bud's payments product then you will not have to create customers.

If you have any questions, please contact us via the chatbot (bottom-right of screen 👉) or via a support request or check our FAQs.