Consulta de assinantes

Consulta paginada dos conjuntos de assinantes (signer_group_sets) vinculados ao cedente e às suas partes relacionadas. Retorna tanto os conjuntos padrão (main), gerados pela análise da Administradora, quanto os conjuntos customizados (custom) definidos pelo cliente.

Informação

Cada conjunto está vinculado a um proprietário (owner), que pode ser o cedente (assignor_registry), um avalista (guarantor) ou o cônjuge de um avalista pessoa física (spouse), e a um tipo de produto.

Para criar conjuntos customizados, consulte Definição de Assinantes.

---

Consulta Paginada de Conjuntos de Assinantes

Disponível em

Perfil	Host	Permissão exigida
Gestora	manager-api	Leitura
Consultoria	consultant-api	Ler Cedentes

URL base de cada host: Ambientes (Hosts).

Request

ENDPOINT

/assignor_registry/signer_group_sets

MÉTODO

GET

Query Parameters

Campo	Tipo	Descrição
limit	integer	Quantidade de itens por página (0 a 50). Padrão: 10.
page	integer	Página a ser consultada, iniciando em 0. Padrão: 0.
owner_key	string	Filtra pelo identificador do proprietário (cedente, avalista ou cônjuge). Ver Owner Type.
owner_type	string	Tipo do proprietário. Ver Owner Type.
owner_document_number	string	Documento do proprietário. Exige owner_type para ser utilizado.
product_type	string	Filtra por tipo de produto. Ver Product Type.
status	string	Filtra pelo status do conjunto. Ver Signer Group Set Status.

Dica

Para listar apenas os conjuntos que estão efetivamente sendo utilizados nas assinaturas, filtre por status=valid. Conjuntos em in_analysis ainda dependem da aprovação do cadastro e não são enviados para assinatura.

Response

STATUS

200

Response Body

{
  "data": [
    {
      "signer_group_set_key": "f2c1e4a8-91d2-4f10-8a3b-7e5c9b2d4a6e",
      "owner_key": "c4295375-4077-4092-a258-5bcdf8875907",
      "owner_type": "assignor_registry",
      "product_type": "assignment_contract",
      "signer_group_set_type": "custom",
      "status": "valid",
      "signer_groups": [
        {
          "minimum_required_signers": 2,
          "signers": [
            {
              "document_number": "123.456.789-09",
              "is_required_signer": true
            },
            {
              "document_number": "969.698.790-03",
              "is_required_signer": false
            }
          ]
        }
      ]
    }
  ],
  "limit": 10,
  "page": 0,
  "is_last_page": true
}

Campos de Paginação

Campo	Tipo	Descrição
data	array	Lista de conjuntos de assinantes da página atual. Ver Definição de Conjunto de Assinantes.
limit	integer	Quantidade de itens por página utilizada na consulta.
page	integer	Página retornada, iniciando em 0.
is_last_page	boolean	Indica se esta é a última página do resultado.

Erros

Status	Código	Quando acontece
400	ASR000121	owner_document_number enviado sem owner_type. Ao filtrar por owner_document_number, sempre informar também owner_type.
400	ASR000120	Valor de status inválido no filtro. Usar um valor válido para o filtro status (ver enum Signer Group Set Status).

Erros de autenticação, permissão e host: veja Erros da API.

---

Definições

Definição de Conjunto de Assinantes (Signer Group Set)

Campo	Tipo	Descrição	Caracteres
signer_group_set_key	string	Identificador único do conjunto.	36
owner_key	string	Identificador do proprietário, conforme o owner_type. Ver Owner Type.	36
owner_type	string	Tipo do proprietário.	Ver Owner Type.
product_type	string	Tipo de produto ao qual o conjunto está associado.	Ver Product Type.
signer_group_set_type	string	Tipo do conjunto (main ou custom).	Ver Signer Group Set Type.
status	string	Status do conjunto.	Ver Signer Group Set Status.
signer_groups	array	Lista de grupos de assinantes que compõem o conjunto.	Ver Definição de Grupo de Assinantes.

---

Definição de Grupo de Assinantes (Signer Group)

Campo	Tipo	Descrição	Caracteres
minimum_required_signers	number	Quantidade mínima de assinantes do grupo necessários para validar a assinatura.	Mínimo 1
signers	array	Lista de assinantes do grupo.	Ver Definição de Assinante.

A consulta não devolve expiration, e grupos já expirados não aparecem.

---

Definição de Assinante (Signer)

Campo	Tipo	Descrição	Caracteres
document_number	string	CPF do assinante no formato XXX.XXX.XXX-XX.	14
is_required_signer	boolean	Indica se o assinante é obrigatório no grupo.	-

---

Enumeradores

Owner Type

Enumerador	Descrição
assignor_registry	Conjunto do cedente. owner_key = assignor_registry_key.
guarantor	Conjunto de um avalista. owner_key = chave do avalista (guarantor_key).
spouse	Conjunto do cônjuge de um avalista pessoa física. owner_key = chave do cônjuge (representative_key em guarantor_representatives).

---

Product Type

Enumerador	Descrição
assignment_contract	Contrato de cessão (utilizado por padrão).
commercial_paper	Nota Comercial (Cadastro único com a plataforma de escrituração).

---

Signer Group Set Type

Enumerador	Descrição
main	Conjunto padrão, gerado da análise da Administradora.
custom	Conjunto customizado, criado pelo cliente sobrepondo o conjunto main.

---

Signer Group Set Status

Enumerador	Descrição
in_analysis	Conjunto enviado e atrelado à análise em aberto. Não é utilizado nas assinaturas.
valid	Conjunto vigente e utilizado nas assinaturas.
invalid	Conjunto substituído por um envio mais recente, ou descartado. Não é utilizado nas assinaturas.