Mais pesquisados:Customização, Tutorial, Documentação

sign

605 views 0 05/06/2024 Atualizado em 15/10/2025 integrador

2.0info: 2.4.1 sign description: Serviço de assinatura eletrônica e digital x-senior-domain: platform x-senior-domain-path: platform x-senior-service-path: sign contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/platformsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /sign/queries/listEnvelopes: post: description: Lista os envelopes e rascunhos do usuário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – status properties: offset: type: integer format: int64 description: Índice da página a ser retornada. Padrão 0. default: 0 limit: type: integer format: int64 description: Quantidade de itens que serão exibidos por página. Padrão 10. default: 10 envelopeName: type: string description: Nome do envelope a ser utilizado no filtro status: type: array items: type: string allOf: – #/definitions/envelopeStatus minimum: 1 description: Situação do envelope a ser utilizado no filtro createdDate: type: string description: Data de criação do envelope a ser utilizado no filtro orderByField: type: string allOf: – #/definitions/orderByFieldListEnvelopes description: Indica por qual campo os dados serão ordenados order: type: string allOf: – #/definitions/orderType description: Tipo da ordenação responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: type: array items: type: object allOf: – #/definitions/envelopeDTO minimum: 1 description: Lista de envelopes encontrados totalElements: type: integer format: int64 description: Total de envelopes encontrados totalPages: type: integer format: int64 description: Total de páginas disponíveis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/queries/countListEnvelopes: post: description: Lista os envelopes e rascunhos do usuário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: envelopeName: type: string description: Nome do envelope createdDate: type: string description: Data de criação responses: 200: description: Ok schema: type: object required: – pending – failedToLoad – failedToWritePdf – waitingDocuments – completed – canceled – draft – expired – total properties: pending: type: integer format: int64 description: Quantidade com status pendente failedToLoad: type: integer format: int64 description: Quantidade com falha ao enviar documentos failedToWritePdf: type: integer format: int64 description: Quantidade com falha ao finalizar o envelope e escrever PDF waitingDocuments: type: integer format: int64 description: Quantidade esperando envio de documentos completed: type: integer format: int64 description: Quantidade com status completo canceled: type: integer format: int64 description: Quantidade com status cancelado draft: type: integer format: int64 description: Quantidade com status em rascunho expired: type: integer format: int64 description: Quantidade com status expirado total: type: integer format: int64 description: Quantidade total 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista os envelopes e rascunhos do usuário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: envelopeName description: Nome do envelope in: query type: string – name: createdDate description: Data de criação in: query type: string responses: 200: description: Ok schema: type: object required: – pending – failedToLoad – failedToWritePdf – waitingDocuments – completed – canceled – draft – expired – total properties: pending: type: integer format: int64 description: Quantidade com status pendente failedToLoad: type: integer format: int64 description: Quantidade com falha ao enviar documentos failedToWritePdf: type: integer format: int64 description: Quantidade com falha ao finalizar o envelope e escrever PDF waitingDocuments: type: integer format: int64 description: Quantidade esperando envio de documentos completed: type: integer format: int64 description: Quantidade com status completo canceled: type: integer format: int64 description: Quantidade com status cancelado draft: type: integer format: int64 description: Quantidade com status em rascunho expired: type: integer format: int64 description: Quantidade com status expirado total: type: integer format: int64 description: Quantidade total 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/queries/getEnvelopeInfo: post: description: Retorna as informações um envelope pelo Id tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – envelopeId properties: envelopeId: type: string description: Id do envelope responses: 200: description: Ok schema: type: object required: – envelope properties: envelope: type: object allOf: – #/definitions/envelopeDTO description: Informações do envelope 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações um envelope pelo Id tags: – Queries x-senior-visibility: PRIVATE parameters: – name: envelopeId description: Id do envelope in: query required: true type: string responses: 200: description: Ok schema: type: object required: – envelope properties: envelope: type: object allOf: – #/definitions/envelopeDTO description: Informações do envelope 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/queries/getEnvelope: post: description: Buscar informações do envelope pelo Id tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – envelopeId properties: envelopeId: type: string description: Id do envelope responses: 200: description: Ok schema: type: object required: – envelope properties: envelope: type: object allOf: – #/definitions/envelope description: Informações do envelope 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Buscar informações do envelope pelo Id tags: – Queries x-senior-visibility: PRIVATE parameters: – name: envelopeId description: Id do envelope in: query required: true type: string responses: 200: description: Ok schema: type: object required: – envelope properties: envelope: type: object allOf: – #/definitions/envelope description: Informações do envelope 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/queries/checkEnvelopeAllSigned: post: description: Verifica os ids dos envelopes passados, se todos signatários assinados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – envelopeIds properties: envelopeIds: type: array items: type: string minimum: 1 description: Lista de identificadores de envelopes responses: 200: description: Ok schema: type: object required: – envelopes properties: envelopes: type: array items: type: string minimum: 1 description: Lista de envelopes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/queries/healthcheck: post: description: Endpoint para verificação da saúde do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckStatus description: Status geral do healthcheck checks: type: array items: type: object allOf: – #/definitions/healthcheckItem minimum: 1 description: Itens verificados no healthcheck 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Endpoint para verificação da saúde do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckStatus description: Status geral do healthcheck checks: type: array items: type: object allOf: – #/definitions/healthcheckItem minimum: 1 description: Itens verificados no healthcheck 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/queries/getEnvelopeTenant: post: description: Consulta o tenant de um envelope tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – envelopeId properties: envelopeId: type: string description: Id do processo de assinatura responses: 200: description: Ok schema: type: object properties: tenant: type: string description: Tenant do Envelope default: description: Error response schema: #/definitions/genericError get: description: Consulta o tenant de um envelope tags: – Queries x-senior-visibility: PRIVATE parameters: – name: envelopeId description: Id do processo de assinatura in: query required: true type: string responses: 200: description: Ok schema: type: object properties: tenant: type: string description: Tenant do Envelope default: description: Error response schema: #/definitions/genericError /sign/queries/listInternalEnvelopes: post: description: Listagem de envelopes para controle interno tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – envelopeIds properties: envelopeIds: type: array items: type: string minimum: 1 description: Lista de identificadores de envelopes responses: 200: description: Ok schema: type: object required: – envelopes properties: envelopes: type: array items: type: object allOf: – #/definitions/internalEnvelope minimum: 1 description: Lista de envelopes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/queries/exportEnvelopeSigner: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/queries/exportEnvelopeSignerCertificate: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/queries/exportEnvelopeDocument: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/queries/exportEnvelopePermission: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/queries/exportEnvelope: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/queries/exportLambdaLog: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/queries/exportEnvelopeTenant: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/queries/exportEnvelopeTemplatePermission: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/queries/exportEnvelopeTemplate: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/queries/exportEnvelopeTimeline: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/queries/exportEnvelopeBatch: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/queries/exportEnvelopeBatchDocument: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/queries/exportNotificationLog: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/queries/exportConectorEnvelope: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/queries/exportConectorEnvelopeInput: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/actions/doSign: post: description: Realiza a assinatura do signatário informado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – signature properties: signature: type: object allOf: – #/definitions/signature description: Dados para realizar a assinatura de um envelope responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/actions/doSignCertificate: post: description: Realiza a assinatura do signatário informado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – signature – certificate properties: signature: type: object allOf: – #/definitions/signature description: Dados para realizar a assinatura de um envelope certificate: type: object allOf: – #/definitions/certificate description: Conteúdo e senha do Certificado responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/actions/cancelEnvelope: post: description: Realiza o cancelamento de um envelope em progresso tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – envelopeId properties: envelopeId: type: string description: Id do envelope responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/actions/cancelEnvelope__2: post: description: Realiza o cancelamento de um envelope em progresso tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – envelopeId properties: envelopeId: type: string description: Id do envelope reason: type: string description: Motivo do cancelamento responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/actions/newEnvelope: post: description: API DEPRECIADA: Usar newEnvelope na versão 2 | DATA: 2025-09-12 | Criação do envelope tags: – Actions deprecated : true x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – signers – documentsVersionIds – requestedSignatures properties: signers: type: array items: type: object allOf: – #/definitions/signer minimum: 1 description: Informações dos signatários documentsVersionIds: type: array items: type: string minimum: 1 description: Documentos enviados para assinatura requestedSignatures: type: integer format: int64 description: Quantidade de assinaturas requisitadas minimum: 1 competence: type: string allOf: – #/definitions/envelopeCompetence description: Jurisdição do envelope envelopeName: type: string description: Nome do envelope responses: 200: description: Ok schema: type: object required: – envelopeId properties: envelopeId: type: string description: Id do envelope 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/actions/newEnvelope__2: post: description: Criação do envelope tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – configuration – signers properties: id: type: string description: Identificador do envelope configuration: type: object allOf: – #/definitions/envelopeConfiguration description: Configurações do Envelope signers: type: array items: type: object allOf: – #/definitions/signer minimum: 1 description: Informações dos signatários documentsVersions: type: array items: type: object allOf: – #/definitions/documentVersion description: Documentos do GED enviados para assinatura permissions: type: array items: type: object allOf: – #/definitions/permission description: Permissões do envelope conectors: type: array items: type: object allOf: – #/definitions/conector description: Conectores envelopeBatchId: type: string description: Id do envelope em lote notificationTemplateId: type: string description: Template de Notificação draft: type: boolean description: Informar se o envelope é rascunho ou não default: true responses: 200: description: Ok schema: type: object required: – envelopeId properties: envelopeId: type: string description: Id do envelope 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/actions/editEnvelope: post: description: Edição do envelope tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – envelopeId – signers – documentsVersionIds – requestedSignatures properties: envelopeId: type: string description: Id do envelope signers: type: array items: type: object allOf: – #/definitions/signer minimum: 1 description: Novos signatários a serem adicionados documentsVersionIds: type: array items: type: string minimum: 1 description: Documentos enviados para assinatura requestedSignatures: type: integer format: int64 description: Quantidade de assinaturas requisitadas minimum: 1 competence: type: string allOf: – #/definitions/envelopeCompetence description: Jurisdição do envelope responses: 200: description: Ok schema: type: object required: – envelopeId properties: envelopeId: type: string description: Id do envelope 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/actions/editEnvelope__2: post: description: Edição do envelope já enviado para assinatura tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador do envelope daysToExpire: type: integer format: int64 description: Prazo para expiração do envelope minimum: 1 maximum: 240 default: 120 signersToAdd: type: array items: type: object allOf: – #/definitions/signer description: Signatários a serem adicionados signersToRemove: type: array items: type: string description: Identificadores de Signatários a serem removidos documentsToAdd: type: array items: type: object allOf: – #/definitions/documentVersion description: Documentos a serem adicionados documentsToRemove: type: array items: type: string description: Identificadores de DocumentVersion a serem removidos permissionsToAdd: type: array items: type: object allOf: – #/definitions/permission description: Permissões a serem adicionadas permissionsToRemove: type: array items: type: string description: Identificadores de Permissões a serem removidas responses: 200: description: Ok schema: type: object required: – envelopeId properties: envelopeId: type: string description: Id do envelope 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/actions/duplicateEnvelope: post: description: Duplicar envelope tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – sourceEnvelopeId properties: sourceEnvelopeId: type: string description: Identificador do envelope original a ser duplicado includeDocuments: type: boolean description: Define se os documentos vinculados ao envelope original também devem ser duplicados default: false responses: 200: description: Ok schema: type: object required: – duplicatedEnvelopeId properties: duplicatedEnvelopeId: type: string description: Identificador do envelope criado a partir da duplicação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/actions/editDaysToExpire: post: description: Editar os dias de expiração de um envelope com status Expirado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – envelopeIds – daysToExpire properties: envelopeIds: type: array items: type: string minimum: 1 description: Id(s) dos envelope(s) que será(s) editado(s) daysToExpire: type: integer format: int64 description: Nova quantidade de dias para expirar minimum: 1 maximum: 240 responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada, verifique as permissões do rascunho de envelope 404: description: Nenhuma instância de entidade foi encontrada default: description: Error response schema: #/definitions/genericError /sign/actions/generateMfaToken: post: description: Geração do Token MFA para assinatura ou recusa tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – envelopeId – email properties: envelopeId: type: string description: Id do envelope email: type: string description: Email do signatário responses: 200: description: Ok schema: type: object required: – token properties: token: type: string description: Token gerado, usado para realizar assinatura 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/actions/sendEnvelopeDraftToSign: post: description: Enviar envelope em rascunho para assinatura tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – envelopeId – documentVersions properties: envelopeId: type: string description: Id do envelope documentVersions: type: array items: type: object allOf: – #/definitions/documentVersion minimum: 1 description: Informações dos signatários responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/actions/importEnvelopeSigner: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/actions/importEnvelopeSignerCertificate: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/actions/importEnvelopeDocument: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/actions/importEnvelopePermission: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/actions/importEnvelope: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/actions/importLambdaLog: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/actions/importEnvelopeTenant: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/actions/importEnvelopeTemplatePermission: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/actions/importEnvelopeTemplate: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/actions/importEnvelopeTimeline: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/actions/importEnvelopeBatch: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/actions/importEnvelopeBatchDocument: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/actions/importNotificationLog: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/actions/importConectorEnvelope: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/actions/importConectorEnvelopeInput: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/signals/retryFinishEnvelope: post: description: Signal para retry da finalização do Envelope tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – envelopeId properties: envelopeId: type: string description: Id do Envelope responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /sign/signals/retryFinishEnvelopeCallback: post: description: Signal para retry do callback de finalização do Envelope no GED tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – envelopes properties: envelopes: type: array items: type: string minimum: 1 description: Lista com os Ids dos envelopes responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /sign/signals/retryEnvelopeDocuments: post: description: Reenvia os documentos de um envelope para assinatura tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – envelopeId – documentsVersionIds properties: envelopeId: type: string description: Id do Envelope documentsVersionIds: type: array items: type: string minimum: 1 description: Documentos enviados para assinatura responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /sign/signals/updateExpiredEnvelopeStatus: post: description: Signal que realiza a atualização do status dos envelopes em processo de assinatura que já passaram do prazo para o status EXPIRED. tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /sign/events/envelopeFinished: post: description: Evento disparado ao finalizar a assinatura de um documento x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – envelopeId properties: envelopeId: type: string description: Id do envelope de assinatura documents: type: array items: type: object allOf: – #/definitions/documentEnvelopeSigned description: Documentos que foram assinados responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /sign/events/envelopeSigned: post: description: Evento disparado quando um signatário assina ou recusa um envelope x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – envelopeId properties: envelopeId: type: string description: Id do envelope de assinatura documentVersionIds: type: array items: type: string description: Lista de ids de versões de documentos documentUploadIds: type: array items: type: string description: Lista de ids de upload de documentos email: type: string description: Email do signatário status: type: string allOf: – #/definitions/signerStatus description: Status da assinatura responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /sign/events/envelopeCreated: post: description: Evento disparado quando um envelope é criado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – envelope properties: envelope: type: object allOf: – #/definitions/envelope description: Envelope criado message: type: string description: Mensagem de retorno do evento documentVersionIds: type: array items: type: string description: Lista de ids de versões de documentos responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /sign/events/envelopeEdited: post: description: Evento disparado quando um envelope é editado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – envelopeId properties: envelopeId: type: string description: Identificador do envelope editado signersEmailsToNotify: type: array items: type: string description: Lista de signatários editados a serem notificados responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /sign/events/envelopeCanceled: post: description: Evento disparado quando um envelope é cancelado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – envelopeId properties: envelopeId: type: string description: Identificador do envelope cancelado cancellationReason: type: string description: Motivo do cancelamento responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /sign/events/expiredEnvelopes: post: description: Quando um envelope tem seu status alterado para Expired x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – envelopeIds – documentVersionIds properties: envelopeIds: type: array items: type: string minimum: 1 description: Lista de identificadores de envelopes documentVersionIds: type: array items: type: string minimum: 1 description: Lista de identificadores de documentVersions dos envelopes expirados responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /sign/events/daysToExpireEdited: post: description: Evento disparado quando alterado data de expiração de um ou mais envelope(s) x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – envelopeId – daysToExpire properties: envelopeId: type: array items: type: string minimum: 1 description: Id do envelope editado daysToExpire: type: integer format: int64 description: Prazo para expiração do envelope responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /sign/events/importEnvelopeSignerEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /sign/events/exportEnvelopeSignerEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /sign/events/importEnvelopeSignerCertificateEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /sign/events/exportEnvelopeSignerCertificateEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /sign/events/importEnvelopeDocumentEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /sign/events/exportEnvelopeDocumentEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /sign/events/importEnvelopePermissionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /sign/events/exportEnvelopePermissionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /sign/events/importEnvelopeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /sign/events/exportEnvelopeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /sign/events/importLambdaLogEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /sign/events/exportLambdaLogEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /sign/events/importEnvelopeTenantEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /sign/events/exportEnvelopeTenantEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /sign/events/importEnvelopeTemplatePermissionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /sign/events/exportEnvelopeTemplatePermissionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /sign/events/importEnvelopeTemplateEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /sign/events/exportEnvelopeTemplateEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /sign/events/importEnvelopeTimelineEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /sign/events/exportEnvelopeTimelineEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /sign/events/importEnvelopeBatchEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /sign/events/exportEnvelopeBatchEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /sign/events/importEnvelopeBatchDocumentEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /sign/events/exportEnvelopeBatchDocumentEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /sign/events/importNotificationLogEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /sign/events/exportNotificationLogEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /sign/events/importConectorEnvelopeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /sign/events/exportConectorEnvelopeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /sign/events/importConectorEnvelopeInputEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /sign/events/exportConectorEnvelopeInputEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /sign/entities/envelopeSigner: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelopeSigner responses: 200: description: The created resource schema: #/definitions/envelopeSigner 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelopeSigner responses: 200: description: The created resource schema: #/definitions/envelopeSigner 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/envelopeSigner 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/entities/envelopeSigner/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEnvelopeSigner responses: 200: description: Ok schema: #/definitions/editEnvelopeSigner 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/envelopeSigner responses: 200: description: Ok schema: #/definitions/envelopeSigner 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/envelopeSigner 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/entities/envelope/{parentId}/envelopeSigner: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/envelopeSigner responses: 200: description: The created resources schema: type: array items: #/definitions/envelopeSigner 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/envelopeSigner responses: 200: description: The created resources schema: type: array items: #/definitions/envelopeSigner 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/envelopeSigner 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/entities/envelope/{parentId}/envelopeSigner/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEnvelopeSigner responses: 200: description: Ok schema: #/definitions/editEnvelopeSigner 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/envelopeSigner responses: 200: description: Ok schema: #/definitions/envelopeSigner 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/envelopeSigner 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/entities/envelopeSigner/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/envelopeSigner responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/entities/envelopeSignerCertificate: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelopeSignerCertificate responses: 200: description: The created resource schema: #/definitions/envelopeSignerCertificate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelopeSignerCertificate responses: 200: description: The created resource schema: #/definitions/envelopeSignerCertificate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/envelopeSignerCertificate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/entities/envelopeSignerCertificate/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEnvelopeSignerCertificate responses: 200: description: Ok schema: #/definitions/editEnvelopeSignerCertificate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/envelopeSignerCertificate responses: 200: description: Ok schema: #/definitions/envelopeSignerCertificate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/envelopeSignerCertificate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/entities/envelopeSigner/{parentId}/envelopeSignerCertificate: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelopeSignerCertificate responses: 200: description: The created resource schema: #/definitions/envelopeSignerCertificate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelopeSignerCertificate responses: 200: description: The created resource schema: #/definitions/envelopeSignerCertificate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/envelopeSignerCertificate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/entities/envelopeSigner/{parentId}/envelopeSignerCertificate/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEnvelopeSignerCertificate responses: 200: description: Ok schema: #/definitions/editEnvelopeSignerCertificate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/envelopeSignerCertificate responses: 200: description: Ok schema: #/definitions/envelopeSignerCertificate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/envelopeSignerCertificate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/entities/envelopeSignerCertificate/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/envelopeSignerCertificate responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/entities/envelopeDocument: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelopeDocument responses: 200: description: The created resource schema: #/definitions/envelopeDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelopeDocument responses: 200: description: The created resource schema: #/definitions/envelopeDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/envelopeDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/entities/envelopeDocument/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEnvelopeDocument responses: 200: description: Ok schema: #/definitions/editEnvelopeDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/envelopeDocument responses: 200: description: Ok schema: #/definitions/envelopeDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/envelopeDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/entities/envelope/{parentId}/envelopeDocument: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/envelopeDocument responses: 200: description: The created resources schema: type: array items: #/definitions/envelopeDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/envelopeDocument responses: 200: description: The created resources schema: type: array items: #/definitions/envelopeDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/envelopeDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/entities/envelope/{parentId}/envelopeDocument/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEnvelopeDocument responses: 200: description: Ok schema: #/definitions/editEnvelopeDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/envelopeDocument responses: 200: description: Ok schema: #/definitions/envelopeDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/envelopeDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/entities/envelopeDocument/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/envelopeDocument responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/entities/envelopePermission: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelopePermission responses: 200: description: The created resource schema: #/definitions/envelopePermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelopePermission responses: 200: description: The created resource schema: #/definitions/envelopePermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/envelopePermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/entities/envelopePermission/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEnvelopePermission responses: 200: description: Ok schema: #/definitions/editEnvelopePermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/envelopePermission responses: 200: description: Ok schema: #/definitions/envelopePermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/envelopePermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/entities/envelope/{parentId}/envelopePermission: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/envelopePermission responses: 200: description: The created resources schema: type: array items: #/definitions/envelopePermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/envelopePermission responses: 200: description: The created resources schema: type: array items: #/definitions/envelopePermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/envelopePermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/entities/envelope/{parentId}/envelopePermission/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEnvelopePermission responses: 200: description: Ok schema: #/definitions/editEnvelopePermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/envelopePermission responses: 200: description: Ok schema: #/definitions/envelopePermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/envelopePermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/entities/envelopePermission/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/envelopePermission responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/entities/envelope: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelope responses: 200: description: The created resource schema: #/definitions/envelope 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelope responses: 200: description: The created resource schema: #/definitions/envelope 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/envelope 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/entities/envelope/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEnvelope responses: 200: description: Ok schema: #/definitions/editEnvelope 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/envelope responses: 200: description: Ok schema: #/definitions/envelope 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/envelope 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/entities/envelope/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/envelope responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/entities/lambdaLog: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/lambdaLog responses: 200: description: The created resource schema: #/definitions/lambdaLog 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/lambdaLog responses: 200: description: The created resource schema: #/definitions/lambdaLog 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/lambdaLog 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/entities/lambdaLog/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editLambdaLog responses: 200: description: Ok schema: #/definitions/editLambdaLog 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/lambdaLog responses: 200: description: Ok schema: #/definitions/lambdaLog 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/lambdaLog 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/entities/envelope/{parentId}/lambdaLog: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/lambdaLog responses: 200: description: The created resources schema: type: array items: #/definitions/lambdaLog 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/lambdaLog responses: 200: description: The created resources schema: type: array items: #/definitions/lambdaLog 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/lambdaLog 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/entities/envelope/{parentId}/lambdaLog/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editLambdaLog responses: 200: description: Ok schema: #/definitions/editLambdaLog 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/lambdaLog responses: 200: description: Ok schema: #/definitions/lambdaLog 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/lambdaLog 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/entities/lambdaLog/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/lambdaLog responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/entities/envelopeTenant: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelopeTenant responses: 200: description: The created resource schema: #/definitions/envelopeTenant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelopeTenant responses: 200: description: The created resource schema: #/definitions/envelopeTenant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/envelopeTenant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/entities/envelopeTenant/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEnvelopeTenant responses: 200: description: Ok schema: #/definitions/editEnvelopeTenant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/envelopeTenant responses: 200: description: Ok schema: #/definitions/envelopeTenant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/envelopeTenant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/entities/envelopeTenant/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/envelopeTenant responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/entities/envelopeTemplatePermission: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelopeTemplatePermission responses: 200: description: The created resource schema: #/definitions/envelopeTemplatePermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelopeTemplatePermission responses: 200: description: The created resource schema: #/definitions/envelopeTemplatePermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/envelopeTemplatePermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/entities/envelopeTemplatePermission/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEnvelopeTemplatePermission responses: 200: description: Ok schema: #/definitions/editEnvelopeTemplatePermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/envelopeTemplatePermission responses: 200: description: Ok schema: #/definitions/envelopeTemplatePermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/envelopeTemplatePermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/entities/envelopeTemplate/{parentId}/permissions: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/envelopeTemplatePermission responses: 200: description: The created resources schema: type: array items: #/definitions/envelopeTemplatePermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/envelopeTemplatePermission responses: 200: description: The created resources schema: type: array items: #/definitions/envelopeTemplatePermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/envelopeTemplatePermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/entities/envelopeTemplate/{parentId}/permissions/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEnvelopeTemplatePermission responses: 200: description: Ok schema: #/definitions/editEnvelopeTemplatePermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/envelopeTemplatePermission responses: 200: description: Ok schema: #/definitions/envelopeTemplatePermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/envelopeTemplatePermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/entities/envelopeTemplatePermission/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/envelopeTemplatePermission responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/entities/envelopeTemplate: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelopeTemplate responses: 200: description: The created resource schema: #/definitions/envelopeTemplate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelopeTemplate responses: 200: description: The created resource schema: #/definitions/envelopeTemplate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/envelopeTemplate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/entities/envelopeTemplate/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEnvelopeTemplate responses: 200: description: Ok schema: #/definitions/editEnvelopeTemplate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/envelopeTemplate responses: 200: description: Ok schema: #/definitions/envelopeTemplate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/envelopeTemplate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/entities/envelopeTemplate/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/envelopeTemplate responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/entities/envelopeBatch: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelopeBatch responses: 200: description: The created resource schema: #/definitions/envelopeBatch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelopeBatch responses: 200: description: The created resource schema: #/definitions/envelopeBatch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/envelopeBatch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/entities/envelopeBatch/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEnvelopeBatch responses: 200: description: Ok schema: #/definitions/editEnvelopeBatch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/envelopeBatch responses: 200: description: Ok schema: #/definitions/envelopeBatch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/envelopeBatch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/entities/envelopeBatch/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/envelopeBatch responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/entities/envelopeBatchDocument: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelopeBatchDocument responses: 200: description: The created resource schema: #/definitions/envelopeBatchDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelopeBatchDocument responses: 200: description: The created resource schema: #/definitions/envelopeBatchDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/envelopeBatchDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/entities/envelopeBatchDocument/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEnvelopeBatchDocument responses: 200: description: Ok schema: #/definitions/editEnvelopeBatchDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/envelopeBatchDocument responses: 200: description: Ok schema: #/definitions/envelopeBatchDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/envelopeBatchDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/entities/envelopeBatchDocument/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/envelopeBatchDocument responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/entities/envelope/{parentId}/conectorEnvelope: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/conectorEnvelope responses: 200: description: The created resources schema: type: array items: #/definitions/conectorEnvelope 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/conectorEnvelope responses: 200: description: The created resources schema: type: array items: #/definitions/conectorEnvelope 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/conectorEnvelope 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/entities/envelope/{parentId}/conectorEnvelope/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editConectorEnvelope responses: 200: description: Ok schema: #/definitions/editConectorEnvelope 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/conectorEnvelope responses: 200: description: Ok schema: #/definitions/conectorEnvelope 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/conectorEnvelope 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/entities/conectorEnvelope/{parentId}/conectorEnvelopeInput: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/conectorEnvelopeInput responses: 200: description: The created resources schema: type: array items: #/definitions/conectorEnvelopeInput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/conectorEnvelopeInput responses: 200: description: The created resources schema: type: array items: #/definitions/conectorEnvelopeInput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/conectorEnvelopeInput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sign/entities/conectorEnvelope/{parentId}/conectorEnvelopeInput/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editConectorEnvelopeInput responses: 200: description: Ok schema: #/definitions/editConectorEnvelopeInput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/conectorEnvelopeInput responses: 200: description: Ok schema: #/definitions/conectorEnvelopeInput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/conectorEnvelopeInput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: signerType: type: string enum: – MANDATORY – RECEIVE_COPY – RECEIVE_COPY_BEFORE_SIGN – PIONEER description: Tipo do signatário: * `MANDATORY` – Assinatura obrigatória * `RECEIVE_COPY` – Recebe uma cópia ao final do processo * `RECEIVE_COPY_BEFORE_SIGN` – Receber em cópia – Antes de Assinar * `PIONEER` – Assinatura pioneira signerSubType: type: string enum: – SIGN – SIGN_LEGAL_REPRESENTATIVE – SIGN_ATTESTANT – SIGN_VALIDATOR description: Subtipo do signatário: * `SIGN` – Assinar * `SIGN_LEGAL_REPRESENTATIVE` – Assinar como representante legal * `SIGN_ATTESTANT` – Assinar como testemunha * `SIGN_VALIDATOR` – Assinar como validador signerStatus: type: string enum: – PENDING – SIGNED – EXPIRED – REMOVED – DECLINED – DIGITAL_SIGNATURE – DIGITAL_DECLINE description: Status da assinatura por usuário: * `PENDING` – Assinatura pendente * `SIGNED` – Documento assinado * `EXPIRED` – Assinatura expirada * `REMOVED` – Assinatura removida do envelope * `DECLINED` – Recusa de assinatura * `DIGITAL_SIGNATURE` – Documento assinado com certificado digital * `DIGITAL_DECLINE` – Recusa de assinatura com certificado digital envelopeStatus: type: string enum: – PENDING – FAILED_TO_LOAD – FAILED_TO_WRITE_PDF – WAITING_DOCUMENTS – COMPLETED – CANCELED – DRAFT – EXPIRED description: Status do envelope: * `PENDING` – Envelope pendente * `FAILED_TO_LOAD` – Falha ao enviar documentos * `FAILED_TO_WRITE_PDF` – Falha ao finalizar o envelope e escrever PDF * `WAITING_DOCUMENTS` – Esperando envio dos documentos * `COMPLETED` – Envelope completo * `CANCELED` – Envelope cancelado * `DRAFT` – Envelope em rascunho * `EXPIRED` – Envelope expirado healthcheckStatus: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Executando normalmente * `DOWN` – Com problemas signatureErrorType: type: string enum: – BAD_REQUEST – REQUEST_TOKEN – SIGN_DOCUMENT – REQUEST_SIGNATURE – INVALID_ORDER_SIGN – USER_ALREADY_SIGNED – FORM_IS_REQUIRED – USER_CANT_SIGN – DIGITAL_CERTIFICATE_DISABLED description: Códigos de erro durante a assinatura: * `BAD_REQUEST` – Requisição inválida * `REQUEST_TOKEN` – Não foi possível enviar o token * `SIGN_DOCUMENT` – Não foi possível assinar o documento * `REQUEST_SIGNATURE` – Solicitação de assinatura * `INVALID_ORDER_SIGN` – Ordem de assinatura inválida * `USER_ALREADY_SIGNED` – Usuário já efetuou a assinatura * `FORM_IS_REQUIRED` – Formulário requerido * `USER_CANT_SIGN` – Usuário não pode assinar * `DIGITAL_CERTIFICATE_DISABLED` – Certificado Digital Desabilitado lambdaLogStatus: type: string enum: – SUCCESSFULLY – NO_RESPONSE – ERROR_ON_LAMBDA – ERROR_ON_INVOKE description: Status de log da lambda: * `SUCCESSFULLY` – Successfully * `NO_RESPONSE` – Sem resposta ao invocar a lambda * `ERROR_ON_LAMBDA` – Erro no processamento da lambda * `ERROR_ON_INVOKE` – Erro na invocação da lambda tokenType: type: string enum: – NOT_USED – LOGGED_USER – MANDATORY description: Tipo de utilização do token pelo signatário: * `NOT_USED` – Não utilizado * `LOGGED_USER` – Utiliza o token do signatário logado na plataforma * `MANDATORY` – Obrigatório informar o token authenticationType: type: string enum: – NOT_USED – LOGGED_USER – MANDATORY – DIGITAL_CERTIFICATE description: Modo de autenticação utilizado pelo signatário: * `NOT_USED` – Não utilizado * `LOGGED_USER` – Usuário logado na plataforma * `MANDATORY` – Token informado pelo signatário * `DIGITAL_CERTIFICATE` – Autenticado com certificado digital envelopeCompetence: type: string enum: – BRASIL – COLOMBIA description: Indica qual jurisdição o envelope pertence: * `BRASIL` – Brasil * `COLOMBIA` – Colômbia digitalCertificateOption: type: string enum: – DISABLED – OPTIONAL – MANDATORY description: Opções para Certificado Digital: * `DISABLED` – Desabilitado * `OPTIONAL` – Opcional * `MANDATORY` – Obrigatório signatureType: type: string enum: – DIGITAL – ELECTRONIC – OPTIONAL description: Tipos de assinatura do usuário: * `DIGITAL` – Tipo assinatura digital * `ELECTRONIC` – Tipo assinatura eletrônica * `OPTIONAL` – Tipo assinatura opcional subjectType: type: string enum: – USER – ROLE – GROUP description: Tipos de sujeitos: * `USER` – Usuário * `ROLE` – Papel * `GROUP` – Grupo askGeolocation: type: string enum: – DONT_ASK_LOCATION – ASK_LOCATION – REQUIRED_LOCATION description: Opções para geolocalização na assinatura: * `DONT_ASK_LOCATION` – Não pedir a localização * `ASK_LOCATION` – Pedir a localização mas não obrigar * `REQUIRED_LOCATION` – Obrigar usuário a informar a localização envelopeBatchStatus: type: string enum: – WAITING_INTEGRATION – FINISH – ERROR description: Status do envelope em lote: * `WAITING_INTEGRATION` – Aguardando integração com o Conector * `FINISH` – Integrado com o Conector * `ERROR` – Erro na integração com o Conector communicationChannelType: type: string enum: – EMAIL – PLATFORM – WHATSAPP – SMS description: Canal de comunicação: * `EMAIL` – E-mail * `PLATFORM` – Notificação na plataforma SeniorX * `WHATSAPP` – Whatsapp * `SMS` – SMS envelopeTimelineKind: type: string enum: – ADD_SIGNER – REMOVE_SIGNER – ADD_DOCUMENT – REMOVE_DOCUMENT – RESEND_DOCUMENT – LINK_SIGN_VISITED – ENVELOPE_CREATED – NOTIFY_EMAIL – NOTIFY_WHATSAPP – NOTIFY_SMS – NOTIFY_CONECTOR – AWAITING_SIGNATURE – SIGNATURE_COMPLETED – ACCEPT_TERMS – SIGNATURE_DECLINE – ENVELOPE_COMPLETED – DOCUMENT_VIEWED – DAYS_TO_EXPIRE – NOTIFY_EMAIL_MANUALLY – NOTIFY_EMAIL_AUTOMATIC – NOTIFY_PLATFORM_AUTOMATIC – NOTIFY_PLATFORM_MANUALLY – NOTIFY_SMS_AUTOMATIC – NOTIFY_SMS_MANUALLY – NOTIFY_WHATSAPP_AUTOMATIC – NOTIFY_WHATSAPP_MANUALLY – NOTIFY_CONECTOR_AUTOMATIC – NOTIFY_CONECTOR_MANUALLY description: Tipo da Linha de Envelope: * `ADD_SIGNER` – Adicionar Signatário * `REMOVE_SIGNER` – Remover Signatário * `ADD_DOCUMENT` – Adicionar Documento * `REMOVE_DOCUMENT` – Remover Documento * `RESEND_DOCUMENT` – Reenviar Documento para Assinatura * `LINK_SIGN_VISITED` – Link de assinatura visualizado * `ENVELOPE_CREATED` – Envelope criado * `NOTIFY_EMAIL` – Notificação por e-mail * `NOTIFY_WHATSAPP` – Notificação por Whatsapp * `NOTIFY_SMS` – Notificação por SMS * `NOTIFY_CONECTOR` – Notificação por Conector * `AWAITING_SIGNATURE` – Aguardando assinatura * `SIGNATURE_COMPLETED` – Assinatura Realizada * `ACCEPT_TERMS` – Aceite dos Termos * `SIGNATURE_DECLINE` – Assinatura Recusadas * `ENVELOPE_COMPLETED` – Envelope Concluído * `DOCUMENT_VIEWED` – Documento Visualizado * `DAYS_TO_EXPIRE` – Prazo de dias para expirar o envelope * `NOTIFY_EMAIL_MANUALLY` – Notificação por e-mail manual * `NOTIFY_EMAIL_AUTOMATIC` – Notificação por e-mail automático * `NOTIFY_PLATFORM_AUTOMATIC` – Notificação pela plataforma automático * `NOTIFY_PLATFORM_MANUALLY` – Notificação pela plataforma manual * `NOTIFY_SMS_AUTOMATIC` – Notificação por SMS automática * `NOTIFY_SMS_MANUALLY` – Notificação por SMS manual * `NOTIFY_WHATSAPP_AUTOMATIC` – Notificação por Whatsapp automática * `NOTIFY_WHATSAPP_MANUALLY` – Notificação por Whatsapp manual * `NOTIFY_CONECTOR_AUTOMATIC` – Notificação por Conector automática * `NOTIFY_CONECTOR_MANUALLY` – Notificação por Conector manual orderByFieldListEnvelopes: type: string enum: – NAME – CREATED_BY – CREATED_DATE – SUBMISSION_DATE – EXPIRATION_DATE description: Campo usado na ordenação de Listagem de Envelopes: * `NAME` – Nome do envelope * `CREATED_BY` – Criador do Envelope * `CREATED_DATE` – Data de criação do envelope * `SUBMISSION_DATE` – Data de Envio do Envelope para Assinatura * `EXPIRATION_DATE` – Data de expiração do envelope orderType: type: string enum: – ASC – DESC description: Tipo da ordenação: * `ASC` – Crescente * `DESC` – Decrescente userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error signature: description: Payload utilizado quando um signatário solicitar a assinatura eletrônica no envelope/processo type: object required: – envelopeId – email properties: envelopeId: type: string description: Identificador do processo/envelope de assinatura email: type: string description: Email do signatário token: type: string description: Token MFA informado pelo signatário geolocation: type: string description: Localização geodésica de onde o documento está sendo assinado phone: type: string description: Telefone do signatário name: type: string description: Nome do signatário ip: type: string description: Endereço de IP de onde o signatário está assinando o documento incrementSignature: type: boolean description: Determina se o signatário irá incrementar ou não o contador de assinaturas do documento default: true reason: type: string description: Motivo da recusa da assinatura platform: type: string description: Sistema operacional do assinante userAgent: type: string description: Navegador do assinante authenticationType: type: string allOf: – #/definitions/authenticationType description: Modo utilizado pelo signatário para autenticar a assinatura certificate: description: Informações do certificado e da senha type: object required: – certificate properties: certificate: type: string format: byte description: Conteúdo do certificado password: type: string description: Senha do certificado location: description: Contém a localização para assinar um processo/envelope type: object required: – latitude – longitude properties: latitude: type: number format: double description: Latitude longitude: type: number format: double description: Longitude queryUrlParams: description: Parametros a serem enviados nos query-params da url pre-assinada type: object required: – key – value properties: key: type: string description: Chave do parametro value: type: string description: Valor do parametro signer: description: Informações do signatário type: object required: – name – signerType properties: name: type: string description: Nome do signatário email: type: string description: Email do signatário phoneNumber: type: string maxLength: 255 description: Número do telefone, apenas os números sem pontuações username: type: string maxLength: 255 description: Caso seja usuário da plataforma para poder assinar sem token. Ex: username@domain askGeolocation: type: string allOf: – #/definitions/askGeolocation description: Solicitar Geolocalização signerType: type: string allOf: – #/definitions/signerType description: Tipo do signatário signerSubtype: type: string allOf: – #/definitions/signerSubType description: Subtipo do signatário jobPosition: type: string description: Cargo/Função tokenType: type: string allOf: – #/definitions/tokenType description: Tipo de utilização do token pelo signatário mandatoryEmail: type: boolean description: Email obrigatório para assinatura default: true signerStatus: type: string description: Status da assinatura desse usuário communicationChannel: type: object allOf: – #/definitions/communicationChannel description: Canal que será utilizado para comunicação com o signatário authenticationTypeChannel: type: object allOf: – #/definitions/authenticationTypeChannel description: Modo(s) de autenticação disponível(is) para o signatário orderSign: type: integer format: int64 description: Ordem do assinante no fluxo de assinaturas minimum: 1 default: 1 digitalCertificate: type: string allOf: – #/definitions/digitalCertificateOption description: Certificado Digital contactId: type: string description: Identificador do Contato cpf: type: string description: CPF do signatário birthday: type: string format: date description: Data de nascimento envelopeSignerDTO: description: Informações do signatário para listagem de envelopes type: object required: – name – email – signerType properties: name: type: string description: Nome do signatário email: type: string description: Email do signatário signerType: type: string allOf: – #/definitions/signerType description: Tipo do signatário signerSubtype: type: string allOf: – #/definitions/signerSubType description: Subtipo do signatário tokenType: type: string allOf: – #/definitions/tokenType description: Tipo de utilização do token pelo signatário mandatoryEmail: type: boolean description: Email obrigatório para assinatura default: true reason: type: string description: Motivo do cancelamento status: type: string allOf: – #/definitions/signerStatus description: Status do signatário orderSign: type: integer format: int64 description: Ordem do assinante minimum: 1 default: 1 phoneNumber: type: string maxLength: 255 description: Número de telefone, apenas os números sem pontuações geolocation: type: string description: Geolocalização do signatário, caso tenha sido informada na assinatura digitalCertificate: type: string allOf: – #/definitions/digitalCertificateOption description: Certificado digital username: type: string maxLength: 255 description: Caso seja usuário da plataforma. Ex: username@domain communicationChannel: type: string allOf: – #/definitions/communicationChannelType description: Canal que será usado para comunicação com o signatário envelopeDocumentDTO: description: Informações do documento type: object properties: documentVersionId: type: string description: Versão do documento originalFilename: type: string description: Nome original do documento documentSignedHash: type: string description: Localização do documento que foi realizado o upload envelopePosition: type: integer format: int64 description: Posição do documento no envelope envelopePermissionDTO: description: Informações das permissões de um envelope type: object properties: id: type: string description: Identificação envelopeId: type: string description: Identificador do envelope subject: type: string description: Sujeito que possui as permissões type: type: string allOf: – #/definitions/subjectType description: Tipo de permisão do sujeito healthcheckItem: description: Item verificado no healthcheck type: object required: – name – status properties: name: type: string description: Nome do item status: type: string allOf: – #/definitions/healthcheckStatus description: Status da saúde internalEnvelope: description: Record do envelope interno type: object required: – envelopeId – envelopeStatus properties: envelopeId: type: string description: Identificador do envelope envelopeStatus: type: string description: Status Envelope signers: type: array items: type: object allOf: – #/definitions/internalSigner description: Informações do signatário internalSigner: description: Record do signatário interno type: object required: – name – email – phone – status properties: name: type: string description: Nome do signatário email: type: string description: Email do signatário phone: type: string description: Telefone do signatário token: type: string description: Token de assinatura status: type: string allOf: – #/definitions/signerStatus description: Status de assinatura do signatário conector: description: Conector model type: object required: – id – inputs properties: id: type: string description: ID inputs: type: array items: type: object allOf: – #/definitions/conectorInput minimum: 1 description: Parâmetros de entrada conectorName: type: string description: Nome do conector conectorTitle: type: string description: Título do conector conectorDescription: type: string description: Descrição do conector conectorInput: description: Parâmetros de entrada do conector type: object required: – id – inputParameter – inputValue properties: id: type: string description: ID inputParameter: type: string description: Parâmetro de entrada inputValue: type: string description: Valor configurado communicationChannel: description: Canais de comunicação utilizados com o signatário type: object properties: email: type: boolean description: E-mail default: false platform: type: boolean description: Notificação na plataforma SeniorX default: false whatsapp: type: boolean description: Whatsapp default: false sms: type: boolean description: SMS default: false authenticationTypeChannel: description: Tipos de autenticação disponíveis para o signatário type: object properties: token: type: boolean description: Token informdo pelo signatário default: false platform: type: boolean description: Usuário logado na plataforma default: false digitalCertificateMandatory: type: boolean description: Certificado digital obrigatório default: false digitalCertificateOptional: type: boolean description: Certificado digital opcional default: false facialRecognition: type: boolean description: Reconhecimento Facial default: false envelopeConfiguration: description: Informações Gerais do envelope type: object required: – name properties: name: type: string maxLength: 255 description: Nome do envelope instructionsToSigner: type: string description: Um texto com instruções para o assinante askGeolocation: type: string allOf: – #/definitions/askGeolocation description: Solicitar Geolocalização recurrentNotificationIntervalDays: type: integer format: int64 description: Quantidade de dias para notificar de maneira recorrente caso a assinatura esteja pendente minimum: 0 maximum: 239 default: 0 daysToExpire: type: integer format: int64 description: Prazo para expiração do envelope minimum: 1 maximum: 240 default: 120 mandatoryView: type: boolean description: Visualização obrigatória default: false notificateAuthor: type: boolean description: Notificar autor default: false competence: type: string allOf: – #/definitions/envelopeCompetence description: Jurisprudência do envelope documentVersion: description: Informações do documento vindo do GED type: object required: – documentVersionId – envelopePosition – documentVersionUrl properties: documentVersionId: type: string description: Versão do Documento envelopePosition: type: integer format: int64 description: Posição no envelope minimum: 1 documentVersionUrl: type: string description: URL para download do documento originalFileName: type: string description: Nome original do documento signerToEdit: description: Signatário a ser editado no envelope type: object required: – signer properties: signer: type: object allOf: – #/definitions/signer description: Signatário markToRemove: type: boolean description: Remover ou não o signatário default: false permission: description: Permissão do envelope type: object required: – subject – type properties: subject: type: string description: Sujeito type: type: string allOf: – #/definitions/subjectType description: Tipo do sujeito documentEnvelopeSigned: description: Record do documento assinado type: object required: – documentSignedUrl properties: documentVersionId: type: string description: Id da versão do documento documentSignedUrl: type: string description: URL para o documento assinado envelopeDTO: description: Dados de um envelope type: object required: – id – name – totalSigners – totalSignersCompleted – totalDocuments – totalPermissions – createdDate – createdBy – version properties: id: type: string description: Identificação askGeolocation: type: string allOf: – #/definitions/askGeolocation description: Solicitar Geolocalização name: type: string description: Nome do Envelope instructionsToSigner: type: string maxLength: 1000 description: Um texto com instruções para o assinante signers: type: array items: type: object allOf: – #/definitions/envelopeSignerDTO description: Signatários do envelope totalSigners: type: integer format: int64 description: Total Assinantes do envelope totalSignersCompleted: type: integer format: int64 description: Total de signatários que já assinaram documents: type: array items: type: object allOf: – #/definitions/envelopeDocumentDTO description: Documentos do envelope totalDocuments: type: integer format: int64 description: Total de documentos do envelope permissions: type: array items: type: object allOf: – #/definitions/envelopePermissionDTO description: Solicitante Solidário (primeira permissão diferente do autor) totalPermissions: type: integer format: int64 description: Total de permissões status: type: string allOf: – #/definitions/envelopeStatus description: Status do envelope createdDate: type: string format: date-time description: Data de criação createdBy: type: string description: Autor do envelope recurrentNotificationIntervalDays: type: integer format: int64 description: Quantidade de dias para notificar de maneira recorrente caso a assinatura esteja pendente daysToNotify: type: integer format: int64 description: Quantidade de dias para notificar caso a assinatura esteja pendente daysToExpire: type: integer format: int64 description: Prazo para expiração do envelope expirationDate: type: string format: date-time description: Data de expiração do envelope mandatoryView: type: boolean description: Visualização obrigatória default: false notificateAuthor: type: boolean description: Notificar autor default: false lastSignDate: type: string format: date-time description: Data da última assinatura submissionDatetime: type: string format: date-time description: Data de envio para assinatura cancellationReason: type: string description: Motivo do cancelamento type: integer format: int64 description: Versão do envelope envelopeSigner: description: Informações do signatário type: object required: – email – name – signerType – status properties: id: type: string format: uuid description: Id do signatário envelope: type: object allOf: – #/definitions/envelope description: Informações do envelope email: type: string description: Email do signatário name: type: string description: Nome do signatário ip: type: string description: Endereço de IP de onde o signatário está assinando o documento geolocation: type: string description: Localização geodésica de onde o documento está sendo assinado phone: type: string description: Telefone do signatário token: type: string description: Último token MFA gerado para o signatário signerType: type: string allOf: – #/definitions/signerType description: Tipo do signatário signerSubType: type: string allOf: – #/definitions/signerSubType description: Subtipo do signatário reason: type: string description: Motivo da recusa tokenExpireDatetime: type: string format: date-time description: Data/hora de expiração do token gerado userSignatureDatetime: type: string format: date-time description: Data que o signatário assinou status: type: string allOf: – #/definitions/signerStatus description: Situação do Assinante envelopeSignerCertificate: type: object allOf: – #/definitions/envelopeSignerCertificate description: Informações do Certificado jobPosition: type: string description: Cargo/Função tokenType: type: string allOf: – #/definitions/tokenType description: Tipo de utilização do token pelo signatário platform: type: string description: Sistema operacional do assinante userAgent: type: string description: Navegador do assinante communicationChannel: type: string description: Canal que será utilizado para comunicação com o signatário authenticationTypeChannel: type: string description: Modo(s) de autenticação disponível(is) para o signatário authenticationType: type: string allOf: – #/definitions/authenticationType description: Modo utilizado pelo signatário para autenticar a assinatura mandatoryEmail: type: boolean description: Email obrigatório para assinatura default: true contactId: type: string format: uuid description: Identificador do Contato cpf: type: string description: CPF do signatário birthday: type: string format: date description: Data de nascimento orderSign: type: integer format: int64 description: Ordem do assinante no fluxo de assinaturas minimum: 1 default: 1 digitalCertificate: type: string allOf: – #/definitions/digitalCertificateOption description: Certificado Digital requerido firstNotifiedSignature: type: boolean description: Notificação da primeira assinatura enviada por email signatureType: type: string allOf: – #/definitions/signatureType description: Tipo da assinatura do signatário username: type: string description: Nome de usuário do signatário na plataforma, caso exista askGeolocation: type: string allOf: – #/definitions/askGeolocation description: Solicitar Geolocalização createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEnvelopeSigner: type: object required: – id allOf: – #/definitions/envelopeSigner envelopeSignerCertificate: description: Informações do certificado digital informado pelo signatário type: object required: – certificate properties: id: type: string format: uuid description: Identificador certificate: type: string format: byte description: Informações do certificado password: type: string description: Senha do certificado createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEnvelopeSignerCertificate: type: object required: – id allOf: – #/definitions/envelopeSignerCertificate envelopeDocument: description: Informações do documento type: object required: – documentVersionId properties: id: type: string format: uuid description: Id do documento documentVersionId: type: string format: uuid description: Versão do documento documentVersionUploadId: type: string format: uuid description: Identificador do upload originalFilename: type: string description: Nome original do documento envelope: type: object allOf: – #/definitions/envelope description: Informações do envelope documentHash: type: string description: Hash do documento que foi realizado o upload documentLocation: type: string description: Localização do documento que foi realizado o upload documentSignedHash: type: string description: Hash do documento assinado documentSignedLocation: type: string description: Localização do documento que foi assinado envelopePosition: type: integer format: int64 description: Posição do documento no envelope minimum: 1 default: 1 documentDownloadUrl: type: string description: URL para download do documento createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEnvelopeDocument: type: object required: – id allOf: – #/definitions/envelopeDocument envelopePermission: description: Entidade para manter as permissões dos envelopes type: object properties: id: type: string format: uuid description: Identificação envelope: type: object allOf: – #/definitions/envelope description: Identificador do envelope subject: type: string description: Sujeito que possui as permissões type: type: string allOf: – #/definitions/subjectType description: Tipo de permisão do sujeito createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEnvelopePermission: type: object required: – id allOf: – #/definitions/envelopePermission envelope: description: Informações do envelope type: object required: – requestedSignatures – signatures – status – version properties: id: type: string format: uuid description: Envelope Id processDatetime: type: string format: date-time description: Data de criação do envelope requestedSignatures: type: integer format: int64 description: Número de assinaturas requisitadas signatureDatetime: type: string format: date-time description: Data da assinatura signatures: type: integer format: int64 description: Número de assinaturas atuais status: type: string allOf: – #/definitions/envelopeStatus description: Status da assinatura envelopeSigner: type: array items: type: object allOf: – #/definitions/envelopeSigner description: Informações dos signatários envelopeDocument: type: array items: type: object allOf: – #/definitions/envelopeDocument description: Informações dos documentos envelopePermission: type: array items: type: object allOf: – #/definitions/envelopePermission description: Informações de permissões do envelope lambdaLog: type: array items: type: object allOf: – #/definitions/lambdaLog description: Log de lambdas do envelope conectorEnvelope: type: array items: type: object allOf: – #/definitions/conectorEnvelope description: Informações dos conectores do envelope pathLocation: type: string description: Caminho para armazenamento no storage askGeolocation: type: string allOf: – #/definitions/askGeolocation description: Solicitar Geolocalização instructionsToSigner: type: string maxLength: 1000 description: Um texto com instruções para o assinante isFinished: type: boolean description: Se o processo foi finalizado default: false isNotifyUser: type: boolean description: Notificar usuário na plataforma default: false isSendEmail: type: boolean description: Enviar e-mail para usuário com link para assinar documentos default: true name: type: string description: Nome do envelope daysToNotify: type: integer format: int64 description: Quantidade de dias para notificar caso a assinatura esteja pendente recurrentNotificationIntervalDays: type: integer format: int64 description: Quantidade de dias para notificar de maneira recorrente caso a assinatura esteja pendente minimum: 0 maximum: 239 default: 0 daysToExpire: type: integer format: int64 description: Prazo para expiração do envelope expirationDate: type: string format: date-time description: Data de expiração do envelope envelopeBatchId: type: string format: uuid description: Id do envelope em lote mandatoryView: type: boolean description: Visualização obrigatória default: false notificateAuthor: type: boolean description: Notificar autor default: false notificationTemplate: type: string format: uuid description: Template de Notificação currentOrder: type: integer format: int64 description: Ordem atual de assinatura default: 0 competence: type: string allOf: – #/definitions/envelopeCompetence description: Jurisprudência do envelope submissionDatetime: type: string format: date-time description: Data de envio para assinatura cancellationReason: type: string description: Motivo do cancelamento type: integer format: int64 description: Versão do envelope createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEnvelope: type: object required: – id allOf: – #/definitions/envelope lambdaLog: description: Log de invocação de lambdas type: object required: – name – status properties: id: type: string format: uuid description: Identificador envelope: type: object allOf: – #/definitions/envelope description: Informação do Envelope name: type: string description: Nome da lambda invocada status: type: string allOf: – #/definitions/lambdaLogStatus description: Status de retorno errorTrace: type: string description: Mensagem de erro de execução da lambda createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editLambdaLog: type: object required: – id allOf: – #/definitions/lambdaLog envelopeTenant: description: Relação entre envelopes e tenants type: object required: – envelope – tenant properties: id: type: string format: uuid description: Identificador envelope: type: string description: Informação do Envelope tenant: type: string description: Nome do tenant createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEnvelopeTenant: type: object required: – id allOf: – #/definitions/envelopeTenant envelopeTemplatePermission: description: Entidade para manter as permissões do template de envelope type: object properties: id: type: string format: uuid description: Identificação envelopeTemplate: type: object allOf: – #/definitions/envelopeTemplate description: Identificador do template que foi adicionado as permissões. subject: type: string description: Sujeito que possui as permissões type: type: string allOf: – #/definitions/subjectType description: Tipo de permisão do sujeito createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEnvelopeTemplatePermission: type: object required: – id allOf: – #/definitions/envelopeTemplatePermission envelopeTemplate: description: Entidade para salvar os templates de envelopes type: object required: – templateName – name properties: id: type: string format: uuid description: Identificação templateName: type: string maxLength: 255 description: Nome do template defaultTemplate: type: boolean description: Define o template como padrão a ser utilizado default: false name: type: string maxLength: 255 description: Nome do envelope instructionsToSigner: type: string maxLength: 1000 description: Um texto com instruções para o assinante askGeolocation: type: string allOf: – #/definitions/askGeolocation description: Solicitar Geolocalização permissions: type: array items: type: object allOf: – #/definitions/envelopeTemplatePermission description: Permissões do envelope daysToNotify: type: integer format: int64 description: Quantidade de dias para notificar caso a assinatura esteja pendente minimum: 0 default: 0 recurrentNotificationIntervalDays: type: integer format: int64 description: Quantidade de dias para notificar de maneira recorrente caso a assinatura esteja pendente minimum: 0 maximum: 239 default: 0 daysToExpire: type: integer format: int64 description: Prazo para expiração do envelope minimum: 1 maximum: 240 default: 120 mandatoryView: type: boolean description: Visualização obrigatória default: false notificateAuthor: type: boolean description: Notificar autor default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEnvelopeTemplate: type: object required: – id allOf: – #/definitions/envelopeTemplate envelopeTimeline: description: Timeline do envelope type: object required: – envelope – kind properties: id: type: string format: uuid description: ID envelope: type: string format: uuid description: Identificador do envelope kind: type: string allOf: – #/definitions/envelopeTimelineKind description: Tipo da timeline note: type: string description: Anotação sobre o envelope ip: type: string description: IP do usuário createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: envelopeBatch: description: Envelope em lote type: object required: – envelopeBatchName – prefixEnvelopeName – conectorId – assignmentId – conectorInputs properties: id: type: string format: uuid description: Identificação envelopeBatchName: type: string description: Nome do envelope em lote prefixEnvelopeName: type: string description: Prefixo do nome do envelope conectorId: type: string format: uuid description: Conector assignmentId: type: string format: uuid description: Atribuidor do conector envelopeTemplate: type: string format: uuid description: Template de envelope documentQuantity: type: integer format: int64 description: Quantidade de arquivos no envelope em lote default: 0 conectorInputs: type: string description: inputs do plugin envelopeBatchStatus: type: string allOf: – #/definitions/envelopeBatchStatus description: Status createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEnvelopeBatch: type: object required: – id allOf: – #/definitions/envelopeBatch envelopeBatchDocument: description: Entidade para manter os arquivos processados em lote type: object properties: id: type: string format: uuid description: Identificação envelopeBatchId: type: string format: uuid description: identificador do envelope em lote documentId: type: string format: uuid description: Identificador do documento documentTitle: type: string description: Título do documento documentVersionId: type: string format: uuid description: Versão do documento documentVersionName: type: string description: Versão do documento errorLog: type: string description: Erro na criação do envelope conectorScheduleId: type: string format: uuid description: Id do agendamento do conector createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEnvelopeBatchDocument: type: object required: – id allOf: – #/definitions/envelopeBatchDocument notificationLog: description: Entidade para manter os logs das notificações type: object required: – id – communicationChannel – signerName – notificationInfo properties: id: type: string format: uuid description: Identificação envelope: type: string format: uuid description: Id do envelope communicationChannel: type: string allOf: – #/definitions/communicationChannelType description: tipo do canal de comunicação signerName: type: string description: Nome do signatário notificationInfo: type: string description: Atributo para onde é enviada a notificação notificationAction: type: string description: Momento em que ocorreu o envio da notificação notificationId: type: string description: Id retornado ao enviar a notificação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: conectorEnvelope: description: Relação de conectores com envelope type: object required: – conectorId properties: id: type: string format: uuid description: ID conectorId: type: string format: uuid description: Conector id envelope: type: object allOf: – #/definitions/envelope description: Identificador do envelope conectorEnvelopeInput: type: array items: type: object allOf: – #/definitions/conectorEnvelopeInput description: Parâmetros de entrada do conector createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editConectorEnvelope: type: object required: – id allOf: – #/definitions/conectorEnvelope conectorEnvelopeInput: description: Parâmetros de entrada do conector type: object required: – conectorInputParameter – conectorInputValue properties: id: type: string format: uuid description: ID conectorEnvelopeId: type: object allOf: – #/definitions/conectorEnvelope description: ID do conector conectorInputParameter: type: string description: Parâmetro de entrada conectorInputValue: type: string maxLength: 1000 description: Valor configurado createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editConectorEnvelopeInput: type: object required: – id allOf: – #/definitions/conectorEnvelopeInput notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage

Este artigo foi útil para você?

 
Leave A Comment
Mais pesquisados:Customização, Tutorial, Documentação