v1

latestOpenAPI 3.1.02026-08-041120270.3 KB

/v1/contatos

endpoint para cadastrar um novo contato na agenda do usuário logado.

post/v1/contatos

Request body

nomeCompletostring required

Nome que será exibido para o contato

emailstring required

e-mail do contato a ser cadastrado

acaointeger

0 = assinar, 1= validar, 2= testemunhar, 3= Observar, 4 = Assinar com certificado (A1/A3)

idGrupointeger

Id do grupo que o contato será adicionado

papelAssinantestring

Papel na assinatura. Ex: "como locatário", "como fiador" etc...

tipoAutenticacaointeger

1 - Login no sistema | 2 - Via envio de código por e-mail

tipoIdentificacaostring

1 = Brasil (CPF ou CNPJ) | 2 = (Id Internacional) | 3 = Não possui (Não solicitar)

identificacaostring

Identificacao de acordo com o que foi definido no "tipoIdentificacao"

tipoEnvioDocumentointeger

1 - Email | 2 - WhatsApp | 3 - Sms

tipoEnvioCodigointeger

1 - Email | 2 - WhatsApp | 3 - Sms

telefonestring

Telefone do usuário para caso o tipo envio seja WhatsApp ou Sms

Response

201

codeinteger

successboolean

{"stackTrail":"paths:/v1/contatos:post:responses:201:content:application/json:schema:properties:errors","oasType":"schema","type":"unknown"}

Example response

{
  "code": 201,
  "success": true,
  "data": {
    "id": 354998,
    "nomeCompleto": "string",
    "email": "tstestes@asdasd.com",
    "papelAssinante": "string",
    "tipoAutenticacao": 1,
    "tipoIdentificacao": 1,
    "tipoEnvioDocumento": 1
  }
}