Sign in

Create person

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

Creates a record in register.person without flagging it as customer, user or collaborator (none of isCustomer/isUser/isCollaborator is set). Use this when you just want a generic identity in the directory; for customer-only rows use POST /api/register/customer instead.

name is required and at least one of cellphone, email or document must be supplied. The payload goes through Person\Sanitize (phone via libphonenumber, email lower-cased, document stripped to alphanumerics).

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
}

Responses

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