Entrar

Criar pessoa

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

Cria um registro em register.person sem marcar como cliente, usuário ou colaborador (nenhum dos campos isCustomer/isUser/isCollaborator é setado). Use quando você só quer uma identidade genérica no diretório; para registros de cliente, use POST /api/register/customer.

name é obrigatório e ao menos um entre cellphone, email ou document deve ser informado. O payload passa por Person\Sanitize (telefone via libphonenumber, e-mail em minúsculas, documento apenas alfanuméricos).

Try-it values populated from environment ACME (Demo)


Autenticação

Token

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

Cabeçalhos

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.

Corpo da requisição

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
}

Respostas

{
    "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