Skip to main content
POST
/
consumers
Create a consumer
curl --request POST \
  --url https://vvdufluovypptsnkihyv.supabase.co/functions/v1/consumers \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "first_name": "Jane",
  "last_name": "Doe",
  "date_of_birth": "1990-05-15",
  "ssn": "123-45-6789",
  "phone": "+15551234567",
  "email": "jane.doe@example.com",
  "address": {
    "street": "123 Main St",
    "city": "Austin",
    "state": "TX",
    "postal_code": "73301",
    "country": "US"
  },
  "external_id": "sp-user-001"
}
'
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "first_name": "Jane",
  "last_name": "Doe",
  "middle_name": null,
  "date_of_birth": "1990-05-15",
  "phone": "+15551234567",
  "email": "jane.doe@example.com",
  "address": {
    "street": "123 Main St",
    "city": "Austin",
    "state": "TX",
    "postal_code": "73301",
    "country": "US"
  },
  "external_id": "sp-user-001",
  "created_at": "2026-02-16T06:16:47.385Z",
  "updated_at": "2026-02-16T06:16:47.385Z"
}

Authorizations

​
x-api-key
string
header
required

API key in the format sk_live_<token> (production) or sk_test_<token> (sandbox). Contact Cove to obtain your API key.

Body

application/json
​
first_name
string
required
Required string length: 1 - 25
​
last_name
string
required
Required string length: 1 - 25
​
date_of_birth
string<date>
required

YYYY-MM-DD

​
phone
string
required

E.164 format

Pattern: ^\+\d{10,15}$
​
email
string<email>
required
​
address
object
required
​
middle_name
string | null
Maximum string length: 25
​
ssn
string | null

SSN (XXX-XX-XXXX or XXXXXXXXX). Encrypted at rest, never returned.

Pattern: ^\d{3}-?\d{2}-?\d{4}$
​
external_id
string | null

Your internal ID for this consumer

Maximum string length: 255

Response

Consumer created

​
id
string<uuid>
​
first_name
string
​
last_name
string
​
middle_name
string | null
​
date_of_birth
string<date>
​
phone
string
​
email
string
​
address
object
​
external_id
string | null
​
created_at
string<date-time>
​
updated_at
string<date-time>