2.0info: 2.9.3 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: api.senior.com.br /platform/signsecurityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonparameters: clientId: name: client_id type: string in: header required: true description: Identificação da aplicação cadastrada no portal do desenvolvedor (api.xplatform.com.br)paths: /anonymous/getSignatureEnvelopeConfiguration: post: description: x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object required: – envelopeId – signerEmail properties: envelopeId: type: string description: Id do envelope de assinatura signerEmail: type: string description: Email do assinante responses: 200: description: Ok schema: type: object required: – documents – askGeolocation – instructionsToSigner – createdBy – createdDate – signerType – signerSubType – name – status – expirationDate properties: documents: #/definitions/envelopeDocumentDTO askGeolocation: #/definitions/askGeolocation instructionsToSigner: type: string description: Um texto com instruções para o assinante createdBy: type: string description: Quem criou a solicitação de assinatura createdDate: type: string description: Data de criação da solicitação de assinatura digitalCertificate: #/definitions/digitalCertificateOption mandatoryView: type: boolean description: Visualização obrigatória notificateAuthor: type: boolean description: Notificar autor signerType: #/definitions/signerType signerSubType: #/definitions/signerSubType name: type: string description: Nome do envelope status: type: string description: Status do envelope expirationDate: type: string description: Data de expiração authorEmail: type: string description: Email do solicitante competence: #/definitions/envelopeCompetence signerId: type: string description: id so signatário contactUserId: type: string description: Id do contato do signatário authenticationTypeChannel: type: string description: Tipo de autenticação do signatário default: description: Error response schema: #/definitions/genericError get: description: x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object required: – envelopeId – signerEmail properties: envelopeId: type: string description: Id do envelope de assinatura signerEmail: type: string description: Email do assinante responses: 200: description: Ok schema: type: object required: – documents – askGeolocation – instructionsToSigner – createdBy – createdDate – signerType – signerSubType – name – status – expirationDate properties: documents: #/definitions/envelopeDocumentDTO askGeolocation: #/definitions/askGeolocation instructionsToSigner: type: string description: Um texto com instruções para o assinante createdBy: type: string description: Quem criou a solicitação de assinatura createdDate: type: string description: Data de criação da solicitação de assinatura digitalCertificate: #/definitions/digitalCertificateOption mandatoryView: type: boolean description: Visualização obrigatória notificateAuthor: type: boolean description: Notificar autor signerType: #/definitions/signerType signerSubType: #/definitions/signerSubType name: type: string description: Nome do envelope status: type: string description: Status do envelope expirationDate: type: string description: Data de expiração authorEmail: type: string description: Email do solicitante competence: #/definitions/envelopeCompetence signerId: type: string description: id so signatário contactUserId: type: string description: Id do contato do signatário authenticationTypeChannel: type: string description: Tipo de autenticação do signatário default: description: Error response schema: #/definitions/genericErrordefinitions: signerType: type: string enum: – MANDATORY – RECEIVE_COPY – RECEIVE_COPY_BEFORE_SIGN – PIONEER signerSubType: type: string enum: – SIGN – SIGN_LEGAL_REPRESENTATIVE – SIGN_ATTESTANT – SIGN_VALIDATOR envelopeCompetence: type: string enum: – BRASIL – COLOMBIA digitalCertificateOption: type: string enum: – DISABLED – OPTIONAL – MANDATORY askGeolocation: type: string enum: – DONT_ASK_LOCATION – ASK_LOCATION – REQUIRED_LOCATION envelopeDocumentDTO: type: object properties: id: type: string description: Identificador documentVersionId: type: string description: Versão do documento originalFilename: type: string description: Nome original do documento documentSignedHash: type: string description: Localização do documento que foi realizado o upload envelopePosition: type: integer description: Posição do documento no envelope 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