POST
/
v1
/
account
Create Bolt Account
curl --request POST \
  --url https://api.bolt.com/v1/account \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "profile": {
    "email": "alan.watts@example.com",
    "first_name": "Alan",
    "last_name": "Watts",
    "metadata": {
      "customer_id": 234
    },
    "phone": "+12125550199"
  },
  "addresses": [
    {
      "country_code": "US",
      "email": "alan.watts@example.com",
      "first_name": "Alan",
      "last_name": "Watts",
      "locality": "Brooklyn",
      "postal_code": "10044",
      "region": "NY",
      "street_address1": "888 main street",
      "company": "Bolt",
      "country": "United States",
      "default": true,
      "door_code": "123456",
      "name": "Alan Watts",
      "phone": "+12125550199",
      "region_code": "NY",
      "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": {
        "country_code": "US",
        "email": "alan.watts@example.com",
        "first_name": "Alan",
        "last_name": "Watts",
        "locality": "Brooklyn",
        "postal_code": "10044",
        "region": "NY",
        "street_address1": "888 main street",
        "company": "Bolt",
        "country": "United States",
        "default": true,
        "door_code": "123456",
        "name": "Alan Watts",
        "phone": "+12125550199",
        "region_code": "NY",
        "street_address2": "apt 3021",
        "street_address3": "c/o Alicia Watts",
        "street_address4": "Bridge Street Apartment Building B"
      },
      "expiration": "2025-11",
      "token": "a1B2c3D4e5F6G7H8i9J0k1L2m3N4o5P6Q7r8S9t0",
      "billing_address_id": null,
      "bin": 411111,
      "cryptogram": "<string>",
      "eci": "<string>",
      "last4": "1234",
      "metadata": {
        "customer_id": 234
      },
      "number": "<string>",
      "postal_code": "10044",
      "save": true,
      "token_type": "bolt",
      "default": true
    }
  ]
}
'
{
  "addresses": [
    {
      "company": "Bolt",
      "country": "United States",
      "country_code": "US",
      "door_code": "123456",
      "email_address": "alan.watts@example.com",
      "first_name": "Alan",
      "id": "<string>",
      "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",
      "default": true,
      "metadata": {
        "customer_id": 234
      }
    }
  ],
  "has_bolt_account": true,
  "payment_methods": [
    {
      "billing_address": {
        "company": "Bolt",
        "country": "United States",
        "country_code": "US",
        "door_code": "123456",
        "email_address": "alan.watts@example.com",
        "first_name": "Alan",
        "id": "<string>",
        "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"
      },
      "id": "<string>",
      "last4": "4021",
      "exp_month": 11,
      "exp_year": 2024,
      "network": "visa",
      "default": true,
      "description": "<string>",
      "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"
  }
}

Authorizations

X-API-Key
string
header
required

Admins and Developers can obtain their Bolt API key from the Bolt Merchant Dashboard.

Headers

X-Publishable-Key
string

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-Key
string

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

Body

application/json

The details needed to create a Bolt account.

profile
object
required

The first name, last name, email address, and phone number of a shopper.

addresses
object[]

A list of physical shipping addresses associated with this account.

payment_methods
object[]

A list of payment methods associated with this account.

Response

200 - application/json

Account Created

addresses
object[]

A list of all addresses associated to the shopper's account.

has_bolt_account
boolean

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

payment_methods
object[]

A list of all payment methods associated to the shopper's account.

Saved Credit Card Detail

profile
object

The shopper's account profile.