sign

2.0info: 1.11.0 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/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 get: description: Verifica os ids dos envelopes passados, se todos signatários assinados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: envelopeIds description: Lista de identificadores de envelopes in: query required: true type: array items: type: string minimum: 1 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 get: description: Listagem de envelopes para controle interno tags: – Queries x-senior-visibility: PRIVATE parameters: – name: envelopeIds description: Lista de identificadores de envelopes in: query required: true type: array items: type: string minimum: 1 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/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/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/newEnvelope: post: description: Criação do envelope tags: – Actions 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 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: 401: description: Invalid Credentials 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/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/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/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/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/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/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: 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/envelopeSigner responses: 200: description: Ok 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: 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: 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/envelopeSigner responses: 200: description: Ok 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: 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: 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/envelopeSignerCertificate responses: 200: description: Ok 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: 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: 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/envelopeSignerCertificate responses: 200: description: Ok 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: 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: 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/envelopeDocument responses: 200: description: Ok 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: 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: 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/envelopeDocument responses: 200: description: Ok 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: 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/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: 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/envelope responses: 200: description: Ok 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: 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: 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/lambdaLog responses: 200: description: Ok 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: 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: 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/lambdaLog responses: 200: description: Ok 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: 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: 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/envelopeTenant responses: 200: description: Ok 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: 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/genericErrordefinitions: signerType: description: Tipo do signatário type: string enum: – MANDATORY – RECEIVE_COPY – RECEIVE_COPY_BEFORE_SIGN – PIONEER signerSubType: description: Subtipo do signatário type: string enum: – SIGN – SIGN_LEGAL_REPRESENTATIVE – SIGN_ATTESTANT – SIGN_VALIDATOR signerStatus: description: Status da assinatura por usuário type: string enum: – PENDING – SIGNED – EXPIRED – REMOVED – DECLINED – DIGITAL_SIGNATURE – DIGITAL_DECLINE envelopeStatus: description: Status do envelope type: string enum: – PENDING – FAILED_TO_LOAD – FAILED_TO_WRITE_PDF – WAITING_DOCUMENTS – COMPLETED – CANCELED healthcheckStatus: description: Status do healthcheck type: string enum: – UP – DOWN signatureErrorType: description: Códigos de erro durante a assinatura 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 lambdaLogStatus: description: Status de log da lambda type: string enum: – SUCCESSFULLY – NO_RESPONSE – ERROR_ON_LAMBDA – ERROR_ON_INVOKE tokenType: description: Tipo de utilização do token pelo signatário type: string enum: – NOT_USED – LOGGED_USER – MANDATORY authenticationType: description: Modo de autenticação utilizado pelo signatário type: string enum: – NOT_USED – LOGGED_USER – MANDATORY – DIGITAL_CERTIFICATE envelopeCompetence: description: Indica a jurisdição que o envelope pertence type: string enum: – BRASIL – COLOMBIA userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_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 – 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 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 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: email: type: string description: phone: type: string description: token: type: string description: status: type: string allOf: – #/definitions/signerStatus description: 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 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 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: 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: 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 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: envelope: description: Informações do envelope type: object required: – requestedSignatures – signatures – status 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 lambdaLog: type: array items: type: object allOf: – #/definitions/lambdaLog description: Log de lambdas do envelope pathLocation: type: string description: Caminho para armazenamento no storage competence: type: string allOf: – #/definitions/envelopeCompetence description: Jurisdiçã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: 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: 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: 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 description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE