--- title: "Inclusão de novos assinantes para assinatura" method: POST path: "/api/service/sign/v1/signatures/{request_id}/signers" tags: ["Gestão"] --- # Inclusão de novos assinantes para assinatura `POST /api/service/sign/v1/signatures/{request_id}/signers` ## Request - Base URL: `https://cloud-hom.bry.com.br` - URL: `https://cloud-hom.bry.com.br/api/service/sign/v1/signatures/{request_id}/signers` - Auth: HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) Efetua a inclusão de novos assinantes para assinatura em uma determinado envio de assinaturas. ## Request body - object[] - `signerNonce` string: Valor nonce único para identificação do assinante. Caso não seja enviado, seu valor será igual ao identificador único gerado para o assinante. - `name` string, required: Nome do assinante dentro do envio a ser gerado. - `email` string: E-mail do assinante dentro do envio a ser gerado. - `phone` string: Telefone do assinante dentro do envio a ser gerado. Deve estar no formato E.164. - `personal_identifier` string: Identificador pessoal único do assinante. - `personal_identifier_type` string: Tipo da identificação enviada em 'personal_identifier'. - `language` 'pt-br' | 'en-us' | 'es-cl': Linguagem que será utilizada como padrão na comunicação com signatário para página de assinatura, e-mail e/ou sms. Caso não informada, utiliza a linguagem do envelope. - `positioningMode` 'CREATOR' | 'PRESET' | 'SIGNEE': Modo de aposição da rúbrica visível. CREATOR - A definição da imagem e posição de assinatura são configuradas pelo criador do envelope, no momento de criação, não sendo possível sua alteração por parte do assinante. PRESET - A definição da imagem de assinatura fica a cargo do assinante. A posição em que cada imagem é inserida deve ser configurada no momento de criação do envelope. SIGNEE - A definição da imagem de assinatura e sua posição fica a cargo do assinante. - `signInBatch` boolean: Permite que este envelope seja assinado em lote pelo signatário, caso haja outros envelopes pendentes - `groupNonce` string: Grupo ao qual este signatário pertence. Caso esteja vazio, o signatário não será adicionado a nenhum grupo. - `purpose` string: Papel do signatário dentro do envelope. Caso esteja vazio, não será adicionado nenhum papel ao signatário. - `authenticationOptions` string[]: Objeto JSON Array, com todos os tipos de evidências que devem ser coletadas na tela de assinatura pelo signatário. GEOLOCATION - Define se utilizará as coordenadas geográficas do signatário. IP - Define se utilizará endereço ip do signatário. OTP_PHONE - Define se a confirmação OTP será enviada ao telefone do signatário por SMS. Caso verdadeiro, o número de telefone do signatário deve ser informado. OTP_EMAIL - Define se a confirmação OTP será enviada ao email do signatário. Caso verdadeiro, o email do signatário deve ser informado. OTP_WHATSAPP - Define se a confirmação OTP será enviada ao telefone do signatário por WhatsApp. Caso verdadeiro, o número de telefone do signatário deve ser informado. SELFIE - Define se será tirada Foto do usuário no momento da assinatura. DRIVER_LICENSE - Define se será solicitado foto ou PDF da carteira de motorista do usuário no momento da assinatura. Se definido também o parâmetro SELFIE, será realizada a verificação de similaridade entre a foto do usuário e do documento. Caso formato PDF e definição do parâmtro SELFIE, será aceito exclusivamente o documento emitido pelo aplicativo Carteira Digital de Trânsito. DATAVALID - Define se a Foto do usuário será validada na base do governo. Caso verdadeiro, o CPF do signatário deve ser informado pelo parâmetro 'personal_identifier', utilizando `CPF` como `personal_identifier_type`. Adiciona nível de segurança `SELFIE`. É possível definir o nível mínimo de similaridade aceito utilizando o parâmetro `biometricOptions` de cada signatário. LIVENESS - Define se será verificado vivacidade do signatário. Adiciona nível de segurança SELFIE. É possível definir os valores mínimos de vivacidade aceitos utilizando o parâmetro biometricOptions de cada signatário. PERSONAL_IDENTIFIER - Define se será solicitado a confirmação do 'personal_identifier' do signatário na tela de assinaturas. A confirmação será realizada utilizando apenas os caracteres alpha-numéricos do campo (ex: os valores 12345632151 e 123.456.321-51 serão considerados iguais). VIEW_DOCUMENTS - Define se o signatário deverá visualizar todas as páginas dos documentos antes de seguir com a assinatura - `signatureConfig` SignatureConfig: Configurações de assinatura para determinado assinante. Define o modo de assinatura (SIMPLE, ADVANCED, QUALIFIED) e as propriedades deste modo. - `mode` 'SIMPLE' | 'ADVANCED' | 'QUALIFIED', required: Modalidade da assinatura deste assinante dentro da requisição de envio a ser gerado. SIMPLE - Assinatura eletrônica com coleta de evidências; ADVANCED - Assinatura eletrônica com coleta de evidências e certificado digital; QUALIFIED - Assinatura eletrônica com coleta de evidências e certificado digital ICP-Brasil. - `hashAlgorithm` string: Algoritmo de hash para este assinante dentro do envio a ser gerado. Disponível somente para modos ADVANCED e QUALIFIED. - `profile` string: Perfil de assinatura deste assinante dentro do envio a ser gerado. Disponível somente para modos ADVANCED e QUALIFIED. Valores disponíveis ['BASIC', 'TIMESTAMP', 'COMPLETE', 'ADRB', 'ADRT', 'ADRC', 'ETSI_B', 'ETSI_T', 'ETSI_LT'] - `typeMessaging` string[]: Canal de retorno do link de acesso a tela de assinaturas para cada assinante. LINK - Retorno das informações na(s) resposta(s) da API. EMAIL - Envia o link de acesso para o email do signatário. WHATSAPP - Envia o link de acesso para o whatsapp do signatário. - `typeReport` string[]: Tipo de mensagem de finalização que será enviada para o signatário. REPORT - Envia o(s) relatório(s) de validação dos documentos. DOCUMENT - Envia o(s) documento(s) assinados. REPORT_UNIFIED - Envia o(s) relatório(s) unificado(s) do processo de assinatura. - `typeReportNotify` string[]: Modo de como a mensagem de finalização será enviada para o signatário. Caso não definido na requisição, será utilizado o tipo EMAIL. EMAIL - Envia a(s) mensagem(ns) para o email do signatário. Caso os documentos sejam muito grandes, envia um link para download. SMS - Envia um link de acesso a(s) mensagem(ns) para o telefone do signatário através de um SMS - `biometricOptions` BiometricOptions: Configurações de biometria para assinatura. - `similarity` number: Grau de similaridade entre foto do assinante e documento de identificação. Porcentagem deve ser enviada como valores entre 0 e 1. O valor mínimo permitido é 0.75. Somente utilizado quando ambas autenticações SELFIE e DRIVER_LICENSE são enviadas. - `datavalid` number: Grau de similaridade entre foto do assinante e base do governo. Porcentagem deve ser enviada como valores entre 0 e 1. O valor mínimo permitido é 0.75. - `livenessCaptureProbability` number: Probabilidade de captura da imagem ter sido feita com uma câmera real e sem manipulação. Porcentagem deve ser enviada como valores entre 0 e 1. O valor mínimo permitido é 0.5. - `livenessCaptureScore` number: Nota referente a captura da imagem utilizada. O valor mínimo permitido é 0.5. - `livenessFaceProbability` number: Probabilidade de ser uma pessoa ao vivo na frente da câmera. Porcentagem deve ser enviada como valores entre 0 e 1. O valor mínimo permitido é 0.5. - `metadata` object: Metadados do assinante que serão adicionados aos documentos assinados. Disponível somente para assinaturas em modos ADVANCED e QUALIFIED. Deve ser informado no formato JSON, contendo os metadados no formato chave-valor. - `signaturePositions` SignaturePosition[] - `imageNonce` string: Nonce da imagem relacionada a posição de assinatura. Para não associar imagem a assinatura, enviar valor vazio. - `x` integer, required: Coordenada X (descolamento horizontal, em mm) na qual imagem será inserida. A origem da coordenada é o canto esquerdo do arquivo. - `y` integer, required: Coordenada Y (deslocamento vertical, em mm) na qual imagem será inserida. A origem da coordenada é o canto inferior do arquivo. - `width` integer, required: Largura (em mm) da imagem que será inserida. - `height` integer, required: Altura (em mm) da imagem que será inserida. - `page` string, required: Página na qual imagem será inserida. É possível utilizar valores numéricos ou as constantes [FIRST e LAST]. FIRST - Insere a rúbrica visível na primeira página. LAST - Insere a rúbrica visível na última página. ## Response `200` Retorno das informações relacionadas aos novos assinantes adicionados ao envio - SignerResponse[] - `signerNonce` string: Valor nonce do assinante, definido pelo usuário ou gerado pelo backend - `signerUuid` string: Valor UUID do assinante, gerado pelo backend - `name` string: Nome do assinante - `email` string: E-mail do assinante dentro do envio a ser gerado. - `phone` string: Telefone do assinante dentro do envio a ser gerado. - `personal_identifier` string: Identificador pessoal único do assinante. - `personal_identifier_type` string: Tipo da identificação enviada em 'personal_identifier'. - `language` 'pt-br' | 'en-us' | 'es-cl': Linguagem que será utilizada como padrão na comunicação com signatário para página de assinatura, e-mail e/ou sms. Caso não informada, utiliza a linguagem do envelope. - `positioningMode` 'CREATOR' | 'PRESET' | 'SIGNEE': Modo de aposição da rúbrica visível. CREATOR - Posição e imagem definidas apenas pelo criador das assinaturas. PRESET - Posição e imagem iniciais definidas pelo criador das assinaturas com possibilidade da definição da imagem de assinaura pelo assinante. SIGNEE - Posição e imagem iniciais definidas pelo criador das assinaturas com possibilidade da definição da posição e imagem de assinatura pelo assinante. - `signInBatch` boolean: Permite que este envelope seja assinado em lote pelo signatário, caso haja outros envelopes pendentes - `canSign` boolean: Se assinante pode assinar o envio - `status` 'PENDING' | 'SIGNED' | 'REFUSED': Status da assinatura deste assinante. PENDING - Assinatura ainda não foi realizada; SIGNED - Assinatura realizada; REFUSED - Assinatura recusada. - `groupNonce` string: Grupo ao qual este signatário pertence. Valor não é retornado caso signatário não pertença a nehum grupo. - `evidenceDate` string: Unix timestamp da assinatura do assinante, caso assinatura tenha sido realizada - `purpose` string: Papel do signatário dentro do envelope - `signatureConfig` object: Configurações da assinatura deste assinante - `mode` string - `hashAlgorithm` string - `profile` string - `signatureOrder` integer - `authentications` string[]: Objeto JSON Array, com todos os tipos de evidências que devem ser coletadas na tela de assinatura pelo signatário. GEOLOCATION - Define se utilizará as coordenadas geográficas do signatário. IP - Define se utilizará endereço ip do signatário. OTP_PHONE - Define se a confirmação OTP será enviada ao telefone do signatário por SMS. Caso verdadeiro, o número de telefone do signatário deve ser informado. OTP_EMAIL - Define se a confirmação OTP será enviada ao email do signatário. Caso verdadeiro, o email do signatário deve ser informado. OTP_WHATSAPP - Define se a confirmação OTP será enviada ao telefone do signatário por WhatsApp. Caso verdadeiro, o número de telefone do signatário deve ser informado. SELFIE - Define se será tirada Foto do usuário no momento da assinatura. DRIVER_LICENSE - Define se será solicitado foto ou PDF da carteira de motorista do usuário no momento da assinatura. Se definido também o parâmetro SELFIE, será realizada a verificação de similaridade entre a foto do usuário e do documento. Caso formato PDF e definição do parâmtro SELFIE, será aceito exclusivamente o documento emitido pelo aplicativo Carteira Digital de Trânsito. DATAVALID - Define se a Foto do usuário será validada na base do governo. Caso verdadeiro, o CPF do signatário deve ser informado pelo parâmetro 'personal_identifier', utilizando `CPF` como `personal_identifier_type`. Adiciona nível de segurança `SELFIE`. É possível definir o nível mínimo de similaridade aceito utilizando o parâmetro `biometricOptions` de cada signatário. LIVENESS - Define se será verificado vivacidade do signatário. Adiciona nível de segurança SELFIE. É possível definir os valores mínimos de vivacidade aceitos utilizando o parâmetro biometricOptions de cada signatário. PERSONAL_IDENTIFIER - Define se será solicitado a confirmação do 'personal_identifier' do signatário na tela de assinaturas. A confirmação será realizada utilizando apenas os caracteres alpha-numéricos do campo (ex: os valores 12345632151 e 123.456.321-51 serão considerados iguais). VIEW_DOCUMENTS - Define se o signatário deverá visualizar todas as páginas dos documentos antes de seguir com a assinatura - `link` object: Link para acesso a página de assinatura - `href` string - `iframe` object: Link para acesso a página de assinatura utilizando IFrame - `href` string - `typeMessaging` string[]: Canal de retorno do link de acesso a tela de assinaturas para cada assinante. LINK - Retorno das informações na(s) resposta(s) da API. EMAIL - Envia o link de acesso para o email do signatário. WHATSAPP - Envia o link de acesso para o whatsapp do signatário. - `typeReport` string[]: Tipo de mensagem de finalização que será enviada para o signatário. REPORT - Envia o(s) relatório(s) de validação dos documentos. DOCUMENT - Envia o(s) documento(s) assinados. REPORT_UNIFIED - Envia o(s) relatório(s) unificado(s) do processo de assinatura. - `typeReportNotify` string[]: Modo de como a mensagem de finalização será enviada para o signatário. Caso não definido na requisição, será utilizado o tipo EMAIL. EMAIL - Envia a(s) mensagem(ns) para o email do signatário. Caso os documentos sejam muito grandes, envia um link para download. SMS - Envia um link de acesso a(s) mensagem(ns) para o telefone do signatário através de um SMS - `biometricOptions` BiometricOptions: Configurações de biometria para assinatura. - `similarity` number: Grau de similaridade entre foto do assinante e documento de identificação. Porcentagem deve ser enviada como valores entre 0 e 1. O valor mínimo permitido é 0.75. Somente utilizado quando ambas autenticações SELFIE e DRIVER_LICENSE são enviadas. - `datavalid` number: Grau de similaridade entre foto do assinante e base do governo. Porcentagem deve ser enviada como valores entre 0 e 1. O valor mínimo permitido é 0.75. - `livenessCaptureProbability` number: Probabilidade de captura da imagem ter sido feita com uma câmera real e sem manipulação. Porcentagem deve ser enviada como valores entre 0 e 1. O valor mínimo permitido é 0.5. - `livenessCaptureScore` number: Nota referente a captura da imagem utilizada. O valor mínimo permitido é 0.5. - `livenessFaceProbability` number: Probabilidade de ser uma pessoa ao vivo na frente da câmera. Porcentagem deve ser enviada como valores entre 0 e 1. O valor mínimo permitido é 0.5. - `metadata` object: Metadados do assinante que serão adicionados aos documentos assinados. --- [API](https://skmtc.dev/bry/apis/bry-easy-sign-api-rest.md) - [All operations](https://skmtc.dev/bry/apis/bry-easy-sign-api-rest/llms.txt) - [OpenAPI document](https://skmtc.dev/bry/apis/bry-easy-sign-api-rest/revisions/c87e026e87ac?raw)