Partner

Cadastrar cliente via parceiro

Registra um cliente enviado por um sistema parceiro (ex: BeePay). A senha é derivada automaticamente da data de nascimento no formato DDMMYYYY. Ignora restrição link_only — cadastros via parceiro são sempre autorizados. Autenticação: header X-API-Key com o valor configurado para o espaço no painel de administração.

post/api/v1/partner/register

Request

  • Base URL: http://localhost:3000
  • URL: http://localhost:3000/api/v1/partner/register
  • Auth: API key in header X-API-Key

Request body

tenantSlugstring required

Slug do espaco/tenant

namestring required

Nome completo do cliente

emailstring email required

E-mail do cliente

phonestring required

Telefone (com DDD)

cpfstring

CPF (apenas dígitos, opcional)

dateOfBirthstring required

Data de nascimento (YYYY-MM-DD). Usada para derivar a senha (DDMMYYYY).

accessType'permanent' | 'temporary' | 'single_use'

Tipo de acesso

metadataobject

Dados adicionais em formato livre

photoBase64string required

Foto facial em base64 (JPEG ou PNG)

Example request

{
  "tenantSlug": "meu-condominio",
  "name": "João Silva",
  "email": "joao@email.com",
  "phone": "11999990000",
  "cpf": "12345678901",
  "dateOfBirth": "1990-05-20",
  "accessType": "permanent"
}

Response

Cliente cadastrado com sucesso

clientobject required

Dados do cliente cadastrado

Changes

No recorded changes to this operation across all 1 revision of this API.