Skip to content

Onboarding a Self-Employed Individual

Method for onboarding a self-employed individual in the system and sending an invitation to the FNS (Federal Tax Service).

URL

Method: POST

  • Production: https://api.baas.kvell.group/v1/smz/clients
  • Stage: https://api.baas.stage.kvell.group/v1/smz/clients

Request parameters

Name Data type Required Description
inn string Yes Self-employed individual's INN
first_name string Yes Self-employed individual's first name
last_name string Yes Self-employed individual's last name
second_name string No Self-employed individual's middle name (patronymic)
email string Yes Self-employed individual's email
phone string Yes Self-employed individual's phone number. Digits only.

Example request

{
  "inn": "230900456295",
  "first_name" : "Иван",
  "last_name": "Иванов",
  "second_name": null,
  "phone": "79991111111",
  "email": "i.ivanov@mail.mail"
}

Request headers

Name Data type Required Description
X-Api-Key string Yes Unique shop identifier
X-Signature string Yes Signature

The X-Signature signature is built by concatenating X-Api-Key, inn, first_name, last_name, email, phone, and secret_key. It's then run through sha256:

sha256({X-Api-Key}{inn}{first_name}{last_name}{email}{phone}{secret_key})

where secret_key is the secret key found in the merchant's shop settings.

Request response

Example response

{
  "id": 0,
  "inn": "string",
  "first_name" : "string",
  "second_name" : "string",
  "last_name" : "string",
  "phone": "string",
  "email": "string",
  "created_at": "2024-07-10T18:18:46.472Z"
}

{
  "errors": [
    {
      "code": 4,
      "message": "A contractor with this phone number already exists"
    }
  ]
}

Note

A 200 response means the invitation was sent to the self-employed individual's phone, and you should wait for registration confirmation by calling the self-employed INN check method.