> ## Documentation Index
> Fetch the complete documentation index at: https://docs-platform.services-valid.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Enviar Link de Onboarding

A rota `POST /messaging/api/v1/services/onboarding-link` envia à pessoa o seu link para ela completar a identificação. O envio pode ser por **WhatsApp**, **SMS** ou **e-mail**.

* A mensagem mostra o nome da sua empresa e leva a pessoa até o seu link.
* No WhatsApp, a pessoa abre o link por um botão na mensagem.
* O link enviado vale por **30 dias**.

A rota responde na hora e envia a mensagem logo depois.

## Request Body

<ParamField body="channel" type="string" required>
  Canal de envio: `whatsapp`, `sms` ou `email`.

  **Exemplo**: `whatsapp`
</ParamField>

<ParamField body="contact" type="string" required>
  Telefone da pessoa (canais `whatsapp` e `sms`), com o código do país e o DDD. Ou e-mail da pessoa (canal `email`), com até 254 caracteres.

  **Exemplo**: `+5511999999999`
</ParamField>

<ParamField body="companyName" type="string" required>
  Nome da sua empresa. Ele aparece na mensagem. Até 64 caracteres, sem link, quebra de linha, tab ou 4 espaços seguidos.

  **Exemplo**: `Banco X`
</ParamField>

<ParamField body="link" type="string" required>
  O seu link, para onde a pessoa vai. Só `https`, com até 2048 caracteres.

  **Exemplo**: `https://www.suaempresa.com.br/cadastro/12345`
</ParamField>

## Response

<ResponseField name="id" type="string">
  Identificador da mensagem.
</ResponseField>

<ResponseField name="status" type="string">
  `SENT`: a mensagem foi aceita para envio.
</ResponseField>

<ResponseExample>
  ```json 200 theme={"theme":"catppuccin-latte"}
  {
    "id": "01a150cd-3fbb-710e-889a-4de55ca8d739",
    "status": "SENT"
  }
  ```

  ```json 422 theme={"theme":"catppuccin-latte"}
  {
    "code": "VALIDATION_ERROR",
    "message": "Input validation failed",
    "details": [
      { "field": "link", "message": "link must be an https URL" }
    ]
  }
  ```

  ```json 401 theme={"theme":"catppuccin-latte"}
  {
    "code": "UNAUTHORIZED",
    "message": "Unauthorized"
  }
  ```
</ResponseExample>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.