Sign in

Create invite

GET https://{organization}.myguper.com/api/register/person/invite/{idPerson}

Issues an invite token for an existing person so they can later create Connect login credentials. This is the first step of the user-onboarding flow:

  1. The person already exists in Register (created via Create Person or imported from a customer feed).
  2. An admin calls this endpoint with the person's idPerson and receives an inviteToken.
  3. The token is delivered to the new user (e-mail link, magic link, QR code, etc.).
  4. The user submits the token plus their chosen login and password to Connect · Create User.
  5. Connect decrypts the token, verifies the organization + personId, and writes the User record.

The token is URL-encoded (so it can ride in a query string) and RSA-encrypted with Connect's public key — only Connect can decrypt it, and only for the organization the token was issued under. It's single-use: once a User is created, the token can't be redeemed again.

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.

Path parameters

Name Type Description
idPerson * integer Internal Guper person ID (returned by [Create Person](/docs/{lang}/api-reference/register/person/create) or any feed/lookup endpoint).

Responses

{
    "inviteToken": "MAjLGiKVeKFG97TaYTDwmcEgOvrICbdAgo7t%2BytNC%2FV6hJ3fSBKbLh%2F7Oju3wHli4ELaOUH0AsyWlEs%2B4hzccAZmhnG0mmLmayN2VZCQmLZbLSYVwOfW14xJ9nof5LWmHWLeazwby%2BJuYkei8Poh04Eune00pIHAvWU6Vlr3Rbk%3D",
    "dateTime":    "2026-05-01T12:34:56-03:00"
}

Related

Copied to clipboard