Skip to main content

Cria o evento de assinatura (Auth : x-api-token)​

Cria o evento de assinatura (Auth : x-api-token)

Request Body

Dados do Evento

    controlNumber string nullable

    Número de controle

    batchGroupName string nullable

    Nome do evento

    webhook object
    headerName string nullable

    Nome da Chave, exemplo: x-api-token

    headerValue string nullable

    Valor da chave

    webhookUrl string nullable

    Url do webhook

    documents object[] nullable

    Documentos para assinatura

  • Array [
    • eDocumentType int32

    Possible values: [1, 2, 3, 4, 5, 6, 99]

    Tipo de Documento 1 = Termo 2 = Contrato Mãe 3 = Duplicata 4 = Promissária 5 = CCB 6 = Contrato 99 = Outros

    documentName string nullable

    Nome do Documento

    path string nullable

    Path/Url

    identifier string nullable

    Identificador

    signers object[] nullable

    Dados de assinantes

  • Array [
    • email string nullable

    Email

    phoneNumber string nullable

    Número de telefone

    name string nullable

    Nome do assinante

    vatNumber string nullable

    CPF

    signType string nullable

    Tipo de Assinatura, exemplo: PROCURADOR, EMITENTE, GESTOR, REPRESENTANTE, ETC ...

  • ]
  • ]
    • batchGroupType int32

    Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 99]

Responses

Success

Schema
    success boolean
    errors object[] nullable
  • Array [
    • propertyName string nullable
    errorMessage string nullable
    attemptedValue nullable
    customState nullable
    severity int32

    Possible values: [0, 1, 2]

    errorCode string nullable
    formattedMessagePlaceholderValues object nullable
    nullable
  • ]
    • id nullable
    url string nullable
Loading...