Sign in

Create customer

POST https://{organization}.myguper.com/api/register/customer

Creates a new customer (isCustomer = 1 in register.person). The name field is required; at least one of cellphone, email, or document must also be supplied so the record can be matched later (see matchPattern on the organization). The payload goes through Person\Sanitize — phone is normalized via libphonenumber, email is lower-cased, document keeps only alphanumerics and is lower-cased.

On success, the freshly created person is returned with the default Rookie tag already assigned and a history record (Create person) inserted.

Try-it values populated from environment ACME (Demo)


Authentication

Token

Send your user token in the x-guper-authorization header.

Headers

Name Type Description
x-guper-authorization * string User token issued by Guper.
Content-Type * string Always `application/json` for endpoints that accept a JSON body.

Request body

Content-Type: application/json

{
    "name": "Tintin",
    "entityType": "individual",                                 // optional
    "document": "32165987",                                     // optional
    "email": "tintim@guper.co",                                 // optional
    "countryCallingCode": 55,                                   // optional
    "cellphone": "19982456598",                                 // optional
    "dateOfBirth": "1989-03-29",                                // optional
    "postalCode": "13450000",                                   // optional
    "gender": "male",                                           // optional
    "language": "pt_BR",                                        // optional
    "optin": "2026-05-03T10:00:00-03:00",                       // optional
    "privacyAccepted": "2026-05-03T10:00:00-03:00"              // optional
}

Responses

{
    "id": 683752,
    "mainId": null,
    "entityType": "individual",
    "name": "Tintin",
    "email": "tintim@guper.co",
    "countryCallingCode": 55,
    "cellphone": "19982456598",
    "document": "32165987",
    "gender": "male",
    "postalCode": "13450000",
    "dateOfBirth": "1989-03-29",
    "language": "pt_BR",
    "createdAt": "2026-05-03T10:00:00-03:00",
    "updatedAt": "2026-05-03T10:00:00-03:00"
}
Copied to clipboard