cURL
curl --request GET \ --url https://api.bonifiq.com.br/v1/pvt/Customer/{id} \ --header 'Authorization: Basic <encoded-value>'
{ "ErrorMessage": "<string>", "ErrorCode": 123, "Result": { "OriginalId": "<string>", "PublicId": "<string>", "Name": "<string>", "Email": "<string>", "Phone": "<string>", "BirthdayDate": "2023-11-07T05:31:56Z", "SignupDate": "2023-11-07T05:31:56Z", "Document": "<string>", "IsEnrolled": true, "ReferralURL": "<string>", "WhatsappReferralUrl": "<string>", "CurrentTier": { "Name": "<string>", "Color": "<string>", "IconUrl": "<string>" } }, "HasError": true }
Use API Basic Auth Keys
Id from the client`s store, usually email address
Error message or description
Optional error code, if available
Show child attributes
This is the Id in the client store.
Bonifiq Plubic Id
Customer name.
Customer email.
Customer Contact Phone.
Customer Birthdate.
Date when the customer made the register on client store.
Some document number from the customer, accepts any string.
If true the customer is participating on the points plan from the store.
Customer`s Referral URL. Will be null if the Referral Objective is not active.
Customer`s Referral URL for sharing in Whatsapp. Will be null if Referral Objective is not active
If the customer is in a Tier returns it. Otherwise returns null
If true the request had an error.
Was this page helpful?