---
title: "Status das assinaturas"
method: GET
path: "/api/service/sign/v1/signatures/{request_id}/status"
tags: ["Informação"]
---

# Status das assinaturas

`GET /api/service/sign/v1/signatures/{request_id}/status`

## Request

- Base URL: `https://cloud-hom.bry.com.br`
- URL: `https://cloud-hom.bry.com.br/api/service/sign/v1/signatures/{request_id}/status`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/bry/apis/bry-easy-sign-api-rest/docs/api/service/sign/v1/signatures/:request_id/status/get.ts> (a function with typed inputs; its response is checked against the schema)

Devolve um relatório sobre o processo de assinaturas.

## Path parameters

- `request_id` string, uuid, required

## Response `200`

Retorno das informações de um envio para Assinatura

- CollectResponse
  - `uuid` string: Request_id criado para o envio
  - `name` string: Nome atribuído ao envio e exibido para o assinante
  - `clientName` string: Nome atribuído ao criador do envio e exibido para o assinante
  - `accessPassword` string: Senha de acesso ao(s) relatório(s) de assinaturas, criada para o envio
  - `language` 'pt-br' | 'en-us' | 'es-cl': Linguagem padrão do envelope. Define a linguagem para os signatários que não a definirem.
  - `status` 'DRAFT' | 'CREATED' | 'ONGOING' | 'FINISHED' | 'EXPIRED' | 'DELETED': Status atual deste envio. CREATED - Envio de assinatura foi gerado; ONGOING - Assinaturas do envio foram inicializadas; FINISHED - Todas as assinaturas definidas no envio foram realizadas; EXPIRED - Tempo de expiração do envio chegou ao fim sem que todas as assinaturas tenham sido realizadas; DELETED - Envio foi deletado sem que todas as assinaturas tenham sido realizadas; DRAFT - Envelope está em estado de rascunho, signatários ainda não podem realizar assinaturas;
  - `signatureOrder` 'UNORDERED' | 'ORDERED' | 'GROUPED': Modo de ordenação das assinaturas deste envio
  - `expiration` string: Unix timestamp de expiração do envio
  - `creation` string: Unix timestamp de criação do envio
  - `deletion` string: Unix timestamp de deleção do envio, caso envio tenha sido deletado
  - `keepDocument` boolean: Define se os documentos assinados serão mantidos após a expiração do envelope
  - `linkMark` LinkMark: Marcas de referência adicionadas aos documentos
    - `id` object: Marca de referência do identificador de cada documento. Não é possível adicionar em documentos já assinados. Caso o documento original esteja assinado, o comportamento do id é definido pelo parâmetro `required`.
      - `required` boolean, required: Define se a presença da marca é requerida para todos os documentos. 'false': a marca não será adicionada a documentos que já possuam assinaturas. 'true': a requisição irá falhar caso algum documento possua assinaturas.

## Other responses

- `4XX`: Retorno de erro da aplicação
- `5XX`: Retorno de erro da aplicação

---

[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)