Skip to main content
GET
/
customers
/
by-cpf
/
{cpf}
Search Customer by CPF
curl --request GET \
  --url https://webmaster.zupers.com.br/api/loyalty/v1/customers/by-cpf/{cpf}/ \
  --header 'Authorization: Bearer <token>'
{
  "id": "cust_1234567890",
  "card_number": "ZUP001234567",
  "user": {
    "name": "João Silva",
    "email": "[email protected]",
    "whatsapp_number": "+5511999999999",
    "cpf": "12345678901"
  },
  "points_balance": 1250,
  "points_earned": 5780,
  "points_spent": 4530,
  "tier": "Gold",
  "active": true,
  "created_at": "2023-11-07T05:31:56Z",
  "last_activity_date": "2023-11-07T05:31:56Z",
  "transaction_count": 47,
  "loyalty_program": {
    "program_name": "Miola Rewards",
    "currency_name": "ZupCoins",
    "currency_symbol": "ZC"
  }
}

Authorizations

​
Authorization
string
header
required

Use format: Bearer ZsCUqECc9aCQtN5z9z9sTs81933YnklP

Path Parameters

​
cpf
string
required

Customer's CPF (Brazilian tax ID) - 11 digits

Example:

"12345678901"

Response

Customer found successfully

​
id
string
Example:

"cust_1234567890"

​
card_number
string
Example:

"ZUP001234567"

​
user
object
​
points_balance
integer
Example:

1250

​
points_earned
integer
Example:

5780

​
points_spent
integer
Example:

4530

​
tier
string
Example:

"Gold"

​
active
boolean
Example:

true

​
created_at
string<date-time>
​
last_activity_date
string<date-time>
​
transaction_count
integer
Example:

47

​
loyalty_program
object

Basic loyalty program information