v2

latestOpenAPI 3.0.02026-07-3139594346.4 KB
Account

Create Bolt Account

Create a Bolt shopping account.

post/v1/account

Headers

X-Publishable-Keystring

The publicly viewable identifier used to identify a merchant division. This key is found in the Developer > API section of the Bolt Merchant Dashboard [RECOMMENDED].

Idempotency-Keystring

A key created by merchants that ensures POST and PATCH requests are only performed once. Read more about Idempotent Requests here.

Request body

Example request

{
  "addresses": [
    {
      "company": "Bolt",
      "country": "United States",
      "country_code": "US",
      "default": true,
      "door_code": "123456",
      "email": "alan.watts@example.com",
      "first_name": "Alan",
      "last_name": "Watts",
      "locality": "Brooklyn",
      "name": "Alan Watts",
      "phone": "+12125550199",
      "postal_code": "10044",
      "region": "NY",
      "region_code": "NY",
      "street_address1": "888 main street",
      "street_address2": "apt 3021",
      "street_address3": "c/o Alicia Watts",
      "street_address4": "Bridge Street Apartment Building B",
      "metadata": {
        "customer_id": 234
      }
    }
  ],
  "payment_methods": [
    {
      "billing_address": {
        "company": "Bolt",
        "country": "United States",
        "country_code": "US",
        "default": true,
        "door_code": "123456",
        "email": "alan.watts@example.com",
        "first_name": "Alan",
        "last_name": "Watts",
        "locality": "Brooklyn",
        "name": "Alan Watts",
        "phone": "+12125550199",
        "postal_code": "10044",
        "region": "NY",
        "region_code": "NY",
        "street_address1": "888 main street",
        "street_address2": "apt 3021",
        "street_address3": "c/o Alicia Watts",
        "street_address4": "Bridge Street Apartment Building B"
      },
      "expiration": "2025-11",
      "last4": "1234",
      "metadata": {
        "customer_id": 234
      },
      "postal_code": "10044",
      "token": "a1B2c3D4e5F6G7H8i9J0k1L2m3N4o5P6Q7r8S9t0",
      "token_type": "bolt"
    }
  ],
  "profile": {
    "email": "alan.watts@example.com",
    "first_name": "Alan",
    "last_name": "Watts",
    "metadata": {
      "customer_id": 234
    },
    "phone": "+12125550199"
  }
}

Response

Account Created

has_bolt_accountboolean

Used to determine whether a Bolt Account exists with this shopper's account details.

Example response

{
  "addresses": [
    {
      "company": "Bolt",
      "country": "United States",
      "country_code": "US",
      "door_code": "123456",
      "email_address": "alan.watts@example.com",
      "first_name": "Alan",
      "last_name": "Watts",
      "locality": "Brooklyn",
      "name": "Alan Watts",
      "phone_number": "+12125550199",
      "postal_code": "10044",
      "priority": "primary",
      "region": "NY",
      "region_code": "NY",
      "street_address1": "888 main street",
      "street_address2": "apt 3021",
      "street_address3": "c/o Alicia Watts",
      "street_address4": "Bridge Street Apartment Building B",
      "metadata": {
        "customer_id": 234
      }
    }
  ],
  "payment_methods": [
    {
      "billing_address": {
        "company": "Bolt",
        "country": "United States",
        "country_code": "US",
        "door_code": "123456",
        "email_address": "alan.watts@example.com",
        "first_name": "Alan",
        "last_name": "Watts",
        "locality": "Brooklyn",
        "name": "Alan Watts",
        "phone_number": "+12125550199",
        "postal_code": "10044",
        "priority": "primary",
        "region": "NY",
        "region_code": "NY",
        "street_address1": "888 main street",
        "street_address2": "apt 3021",
        "street_address3": "c/o Alicia Watts",
        "street_address4": "Bridge Street Apartment Building B"
      },
      "last4": "4021",
      "exp_month": 11,
      "exp_year": 2024,
      "network": "visa",
      "metadata": {
        "customer_id": 234
      }
    }
  ],
  "profile": {
    "email": "alan.watts@example.com",
    "first_name": "Alan",
    "last_name": "Watts",
    "metadata": {
      "customer_id": 234
    },
    "name": "Alan Watts",
    "phone": "+12125550199"
  }
}