UPP Docs
Customer

Create a customer

POST
/customers

Creates a customer for the merchant identified by the API key. A customer is an individual (individual) or an organization (organization); the type cannot be changed later. external_id (your own customer reference) must be unique per merchant.

Use the returned id (starts with cus_) in other endpoints, such as starting an identity verification.

Authorization

merchantApiKeymerchantTimestampmerchantNoncemerchantSignature
headerX-API-KEY<token>

Merchant API key (starts with upk_, also accepts api-key); signing headers are also required

headerX-Timestamp<token>

Unix timestamp in seconds, within 300 seconds of server time

headerX-Nonce<token>

Unique per request; cannot be reused with the same credential during the timestamp validity window

headerX-Signature<token>

Hex HMAC-SHA256 signature (either letter case) of the method, full path, timestamp, nonce and body digest

Request Body

application/json
  1. body
type*CustomerType

Customer type: individual or organization

Value in"individual""organization"
external_id*string

Your own customer reference, unique per merchant

Lengthlength <= 64
name?|

Customer name (person or company), for display only

Lengthlength <= 255
email?|
Formatemail
Lengthlength <= 255
phone?|

E.164 format, such as +14155550123

Match^\+[1-9]\d{6,14}$

Response Body

Customer created

application/json
  1. response
id*string

Customer ID (starts with cus_)

type*CustomerType

Customer type: individual or organization

Value in"individual""organization"
external_id*string
name*string|null
email*string|null
phone*string|null
created_at*string
Formatdate-time
Example Request
curl -X POST 'https://sandbox.getupp.net/api/v1/customers' \  -H 'Content-Type: application/json' \  -d '{  "type": "individual",  "external_id": "user-1001",  "name": "Jane Doe",  "email": "[email protected]",  "phone": "+14155550123"}'
Example Response
{  "id": "cus_01m5e92dnjw558gdb28ajbe26b",  "type": "individual",  "external_id": "user-1001",  "name": "Jane Doe",  "email": "[email protected]",  "phone": "+14155550123",  "created_at": "2026-10-21T03:46:23.000000Z"}