Search for customers
curl --request POST \
--url https://dev.sbx.imprint.co/v2/customers \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"partner_customer_id": "<string>",
"ssn": "123456789",
"date_of_birth": {
"year": 1990,
"month": 1,
"day": 1
},
"limit": 10,
"starting_after": "<string>"
}
'import requests
url = "https://dev.sbx.imprint.co/v2/customers"
payload = {
"partner_customer_id": "<string>",
"ssn": "123456789",
"date_of_birth": {
"year": 1990,
"month": 1,
"day": 1
},
"limit": 10,
"starting_after": "<string>"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
partner_customer_id: '<string>',
ssn: '123456789',
date_of_birth: {year: 1990, month: 1, day: 1},
limit: 10,
starting_after: '<string>'
})
};
fetch('https://dev.sbx.imprint.co/v2/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://dev.sbx.imprint.co/v2/customers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'partner_customer_id' => '<string>',
'ssn' => '123456789',
'date_of_birth' => [
'year' => 1990,
'month' => 1,
'day' => 1
],
'limit' => 10,
'starting_after' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://dev.sbx.imprint.co/v2/customers"
payload := strings.NewReader("{\n \"partner_customer_id\": \"<string>\",\n \"ssn\": \"123456789\",\n \"date_of_birth\": {\n \"year\": 1990,\n \"month\": 1,\n \"day\": 1\n },\n \"limit\": 10,\n \"starting_after\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://dev.sbx.imprint.co/v2/customers")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"partner_customer_id\": \"<string>\",\n \"ssn\": \"123456789\",\n \"date_of_birth\": {\n \"year\": 1990,\n \"month\": 1,\n \"day\": 1\n },\n \"limit\": 10,\n \"starting_after\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://dev.sbx.imprint.co/v2/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"partner_customer_id\": \"<string>\",\n \"ssn\": \"123456789\",\n \"date_of_birth\": {\n \"year\": 1990,\n \"month\": 1,\n \"day\": 1\n },\n \"limit\": 10,\n \"starting_after\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "9B5E1EE0-2E1C-46E7-81B9-3C3917204BE4",
"email": "customer@example.com",
"phone": "+14155552671",
"statuses": {
"Card Program Name": "OPEN"
},
"first_name": "John",
"last_name": "Doe",
"preferred_language": "en",
"ssn4": "1234",
"date_of_birth": {
"year": 1990,
"month": 1,
"day": 1
},
"address": {
"street_line1": "123 Main St",
"street_line2": "Apt 4B",
"city": "San Francisco",
"state": "CA",
"postal_code": "94105",
"country": "USA"
},
"partner_customer_id": "PARTNER_USER_456",
"metadata": {
"preferred_language": "en"
},
"created_at": "2025-02-13T19:08:07.000Z",
"updated_at": "2025-02-13T19:08:07.000Z"
}
],
"has_more": true,
"total": 123
}Customers
Search for customers
POST
/
v2
/
customers
Search for customers
curl --request POST \
--url https://dev.sbx.imprint.co/v2/customers \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"partner_customer_id": "<string>",
"ssn": "123456789",
"date_of_birth": {
"year": 1990,
"month": 1,
"day": 1
},
"limit": 10,
"starting_after": "<string>"
}
'import requests
url = "https://dev.sbx.imprint.co/v2/customers"
payload = {
"partner_customer_id": "<string>",
"ssn": "123456789",
"date_of_birth": {
"year": 1990,
"month": 1,
"day": 1
},
"limit": 10,
"starting_after": "<string>"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
partner_customer_id: '<string>',
ssn: '123456789',
date_of_birth: {year: 1990, month: 1, day: 1},
limit: 10,
starting_after: '<string>'
})
};
fetch('https://dev.sbx.imprint.co/v2/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://dev.sbx.imprint.co/v2/customers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'partner_customer_id' => '<string>',
'ssn' => '123456789',
'date_of_birth' => [
'year' => 1990,
'month' => 1,
'day' => 1
],
'limit' => 10,
'starting_after' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://dev.sbx.imprint.co/v2/customers"
payload := strings.NewReader("{\n \"partner_customer_id\": \"<string>\",\n \"ssn\": \"123456789\",\n \"date_of_birth\": {\n \"year\": 1990,\n \"month\": 1,\n \"day\": 1\n },\n \"limit\": 10,\n \"starting_after\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://dev.sbx.imprint.co/v2/customers")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"partner_customer_id\": \"<string>\",\n \"ssn\": \"123456789\",\n \"date_of_birth\": {\n \"year\": 1990,\n \"month\": 1,\n \"day\": 1\n },\n \"limit\": 10,\n \"starting_after\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://dev.sbx.imprint.co/v2/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"partner_customer_id\": \"<string>\",\n \"ssn\": \"123456789\",\n \"date_of_birth\": {\n \"year\": 1990,\n \"month\": 1,\n \"day\": 1\n },\n \"limit\": 10,\n \"starting_after\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "9B5E1EE0-2E1C-46E7-81B9-3C3917204BE4",
"email": "customer@example.com",
"phone": "+14155552671",
"statuses": {
"Card Program Name": "OPEN"
},
"first_name": "John",
"last_name": "Doe",
"preferred_language": "en",
"ssn4": "1234",
"date_of_birth": {
"year": 1990,
"month": 1,
"day": 1
},
"address": {
"street_line1": "123 Main St",
"street_line2": "Apt 4B",
"city": "San Francisco",
"state": "CA",
"postal_code": "94105",
"country": "USA"
},
"partner_customer_id": "PARTNER_USER_456",
"metadata": {
"preferred_language": "en"
},
"created_at": "2025-02-13T19:08:07.000Z",
"updated_at": "2025-02-13T19:08:07.000Z"
}
],
"has_more": true,
"total": 123
}Authorizations
basicAuthbearerAuth
Basic HTTP authentication. Allowed headers-- Authorization: Basic <base64(api_key_id:api_key_secret)>
Body
application/json
The unique identifier for the customer in the partner's system
The ssn of the customer without hyphens
Example:
"123456789"
Customer's date of birth
Show child attributes
Show child attributes
Limits the number of returned results
Required range:
x >= 1A cursor for use in pagination. An id that defines your place in the list.
⌘I