v1

latestOpenAPI 3.1.02026-08-041120270.3 KB

/v1/verification-codes/send

endpoint para solicitar o envio de um código de autenticação por e-mail para participantes sem cadastro

post/v1/verification-codes/send

Query parameters

resendboolean

Solicita o reenvio de um código para o destinatário sem cadastro

Headers

x-application-idstring required

Para utilizar as Assinaturas Simplificadas pelas integrações é necessário realizar um cadastro. Configura no link https://totvs-sign.readme.io/reference/gettings-started no bloco de Cadastro de ApplicationId

Request body

publicKeystring required

Chave pública de um destinatário que o autor definiu como autenticação por código via e-mail

Response

200

codeinteger

successboolean

{"stackTrail":"paths:/v1/verification-codes/send:post:responses:200:content:application/json:schema:properties:errors","oasType":"schema","type":"unknown"}

Example response

{
  "code": 201,
  "success": true,
  "data": {
    "phoneNumber": "+5531999999999",
    "sendType": 2,
    "jsonData": {
      "idDocumento": 1122162,
      "email": "marcos.semcad@totvs.com.br"
    }
  }
}