• Início
    • A Plataforma
    • Para customizar
      • Visão geral
      • Tutoriais
      • Github.com
      • Guia de contribuição
      • Tabela de compatibilidade
    • Para desenvolver
      • Visão geral
      • API – Guia de Estilo
      • UX – Guia de estilo
    • Para administrar
      • Documentação
  • APIs
  • Documentação
    • APIs Senior X
    • Tutoriais
  • Fórum
  • Community
  • Entrar
  • Cadastrar-se
  • Início
    • A Plataforma
    • Para customizar
      • Visão geral
      • Tutoriais
      • Github.com
      • Guia de contribuição
      • Tabela de compatibilidade
    • Para desenvolver
      • Visão geral
      • API – Guia de Estilo
      • UX – Guia de estilo
    • Para administrar
      • Documentação
  • APIs
  • Documentação
    • APIs Senior X
    • Tutoriais
  • Fórum
  • Community
  • Entrar
  • Cadastrar-se
home/APIs Privadas/flow/process_pdf
Mais pesquisados:Customização, Tutorial, Documentação

process_pdf

9 views 0 09/11/2026 integrador

2.0info: 1.3.0 process_pdf x-senior-domain: flow x-senior-domain-path: flow x-senior-service-path: process_pdf 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/flowsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /process_pdf/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 /process_pdf/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 /process_pdf/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 /process_pdf/actions/signWritePdf: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – envelopeId – documents – signers – notificationCallback properties: envelopeId: type: string description: Identificador do envelope documents: type: array items: type: object allOf: – #/definitions/signDocument minimum: 1 description: Informações dos documentos do envelope signers: type: array items: type: object allOf: – #/definitions/signer minimum: 1 description: Informações dos signatários notificationCallback: type: object allOf: – #/definitions/notificationCallback description: Configurações dos callbacks utilizados durante o processamento do PDF competence: type: string allOf: – #/definitions/competence description: Juridisdição do envelope retryCount: type: integer format: int64 description: Número da tentativa de processamento do envelope queueTaskId: type: string description: Identificador da tarefa da fila responsável por iniciar o processamento requesterName: type: string description: Nome de quem criou o envelope requesterEmail: type: string description: E-mail de quem criou o envelope responses: 200: description: Ok schema: type: object required: – documents properties: documents: type: array items: type: object allOf: – #/definitions/signDocumentResult minimum: 1 description: Documentos que foram assinados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_pdf/actions/preparePdf: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – envelopeId – documents – notificationCallback – signer properties: envelopeId: type: string description: Identificador do envelope documents: type: array items: type: object allOf: – #/definitions/documentToPdf minimum: 1 description: Informações dos documentos que será preenchidos notificationCallback: type: object allOf: – #/definitions/notificationCallback description: Configurações dos callbacks utilizados durante o processamento do PDF signer: type: object allOf: – #/definitions/signer description: Informação do signatário existsDeclinedSignature: type: boolean description: Se possui recusas de assinatura competence: type: string description: Juridisdição do envelope responses: 200: description: Ok schema: type: object required: – documents properties: documents: type: object allOf: – #/definitions/preparePdfResponse description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_pdf/events/writePdfFinished: post: description: Evento publicado ao término do processamento do PDF do envelope. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – envelopeId – status – documents properties: envelopeId: type: string description: Identificador do envelope status: type: string allOf: – #/definitions/writePdfStatus description: Status final do processamento do PDF documents: type: array items: type: object allOf: – #/definitions/signDocumentResult minimum: 1 description: Documentos processados com sucesso message: type: string description: Mensagem de erro quando o processamento falhar retryCount: type: integer format: int64 description: Número da tentativa de processamento do envelope queueTaskId: type: string description: Identificador da tarefa da fila responsável pelo processamento responses: 200: description: OK default: description: Error response schema: #/definitions/genericErrordefinitions: 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 signerStatus: type: string enum: – PENDING – SIGNED – DECLINED – DIGITAL_SIGNATURE – DIGITAL_DECLINE description: Status do Signatário: * `PENDING` – Pendente de assinatura * `SIGNED` – Assinado * `DECLINED` – Recusado * `DIGITAL_SIGNATURE` – Assinado com certificado digital * `DIGITAL_DECLINE` – Recusado utilizando certificado digital competence: type: string enum: – BRASIL – COLOMBIA description: Jurisdição do envelope: * `BRASIL` – Brasil * `COLOMBIA` – Colômbia authenticationType: type: string enum: – NOT_USED – LOGGED_USER – MANDATORY – DIGITAL_CERTIFICATE – FACIAL_RECOGNITION – DIGITAL_CERTIFICATE_A3 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 * `FACIAL_RECOGNITION` – Autenticado com reconhecimento facial * `DIGITAL_CERTIFICATE_A3` – Autenticado com certificado digital A3 healthcheckStatus: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Executando normalmente * `DOWN` – Com problemas writePdfStatus: type: string enum: – SUCCESS – FAILED 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 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 signDocument: description: type: object required: – versionId – location properties: versionId: type: string description: Id da versão do documento location: type: string description: Localização do documento no armazenamento preparedLocation: type: string description: Localização do documento preparado para assinatura A3 signDocumentResult: description: type: object required: – versionId – location – hash – signedLocation – signedHash properties: versionId: type: string description: Versão do documento assinado location: type: string description: Localização original do documento hash: type: string description: Hash do documento que foi realizado o upload signedLocation: type: string description: Localização do documento que foi assinado signedHash: type: string description: Hash do documento assinado resumeLocation: type: string description: Localização do resumo do documento signer: description: Informações do signatário type: object required: – name – email – signerType – status properties: name: type: string description: Nome do signatário email: type: string description: Email do signatário phone: type: string description: Número do telefone, apenas os números sem pontuações signerType: type: string allOf: – #/definitions/signerType description: Tipo do signatário status: type: string allOf: – #/definitions/signerStatus description: Status da assinatura desse usuário userSignatureDateTime: type: string format: date-time description: Data que o signatário assinou location: type: object allOf: – #/definitions/signerLocation description: Geolocalização do signatário, caso tenha sido informada na assinatura ip: type: string description: IP do usuário reason: type: string description: Motivo da recusa jobPosition: type: string description: Cargo/Função authenticationType: type: string allOf: – #/definitions/authenticationType description: Modo utilizado pelo signatário para autenticar a assinatura tokenType: type: string description: Tipo de utilização do token pelo signatário signerSubtype: type: string description: Subtipo do signatário mandatoryEmail: type: boolean description: Email obrigatório para assinatura certificateInfo: type: object allOf: – #/definitions/certificateInfo description: Dados do certificado utilizado signaturesDetached: type: array items: type: object allOf: – #/definitions/documentSignatureDetached description: Assinaturas A3 destacadas dos documentos do envelope recognizedPhoto: type: object allOf: – #/definitions/recognizedPhoto description: Foto utilizada no reconhecimento facial documentType: type: string description: Tipo do documento utilizado para identificação do signatário documentValue: type: string description: Número do documento utilizado para identificação do signatário username: type: string description: Login utilizado pelo signatário platform: type: string description: Sistema operacional do assinante userAgent: type: string description: Navegador do assinante recognizedPhoto: description: Informações da foto utilizada no reconhecimento facial type: object required: – photoUrl properties: photoUrl: type: string description: URL da foto utilizada no reconhecimento facial confidence: type: number format: double description: Percentual de confiança do reconhecimento documentSignatureDetached: description: Assinatura A3 produzida externamente para um documento preparado type: object required: – versionId – signatureContent – preparedLocation – byteRangeStart – byteRangeLength properties: versionId: type: string description: Id da versão do documento signatureContent: type: string description: Conteúdo CMS da assinatura em Base64 preparedLocation: type: string description: Localização do PDF preparado no armazenamento byteRangeStart: type: integer format: int64 description: Posição inicial do espaço reservado, incluindo o delimitador byteRangeLength: type: integer format: int64 description: Tamanho do espaço reservado, incluindo os delimitadores signerLocation: 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 certificateInfo: description: Informações do certificado digital utilizado na assinatura type: object required: – certificate properties: certificate: type: string format: byte description: Conteúdo do certificado digital password: type: string description: Senha do certificado digital notificationCallback: description: Configurações dos callbacks utilizados durante o processamento do PDF type: object required: – headers – payload – retrieveFormPdfConextUrl – deletePdfContextFields properties: headers: type: object allOf: – #/definitions/notificationHeaders description: Cabeçalhos enviados nas chamadas de callback payload: type: object allOf: – #/definitions/notificationPayload description: Payload base enviado nas chamadas de callback retrieveFormPdfConextUrl: type: string description: URL utilizada para recuperar os campos e valores do formulário PDF deletePdfContextFields: type: string description: URL utilizada para remover os valores dos campos de contexto após o processamento do PDF notificationHeaders: description: Cabeçalhos utilizados nas chamadas HTTP de callback type: object required: – xTenant – contentType properties: xTenant: type: string description: Identificador do tenant enviado nas chamadas HTTP contentType: type: string description: Tipo de conteúdo da requisição HTTP notificationPayload: description: Dados do envelope enviados para os endpoints de callback type: object required: – envelopeId properties: envelopeId: type: string description: Identificador do envelope documentToPdf: description: Dados do documento que será enviado para preenchimento do resumo type: object required: – documentVersionId – location properties: documentVersionId: type: string description: Id da versão do documento location: type: string description: Localização do documento hash: type: string description: Hash do documento preparedLocation: type: string description: Lugar preparado para o documento preparedHash: type: string description: Hash preparado para o documento resumeLocation: type: string description: Local do resumo preparePdfResponse: description: Retorno da primitiva preparePdf type: object required: – documents properties: documents: type: array items: type: object allOf: – #/definitions/documentResponse minimum: 1 description: Lista de documentos que foram editados documentResponse: description: documentResponse type: object required: – preparedLocation – versionId – location – bytesToSign – byteRangeStart – byteRangeLength – signerSlotIndex properties: preparedLocation: type: string description: Local no S3 onde está o documento preparado versionId: type: string description: Id da versão do documento location: type: string description: Local do documento bytesToSign: type: string description: Bytes da assinatura byteRangeStart: type: integer format: int64 description: Base64 de dados documento byteRangeLength: type: integer format: int64 description: Tamanho da quantidade de bytes do documento signerSlotIndex: type: integer format: int64 description: Index do assinante 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. 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ê?

Sim  Não
Leave A Comment Cancelar resposta

Você precisa fazer o login para publicar um comentário.

© 2022 Senior. Todos os direitos reservados.
Mais pesquisados:Customização, Tutorial, Documentação