Signers Query

Paginated query of the signer group sets (signer_group_sets) linked to the assignor and its related parties. It returns both the default sets (main), generated by the Administrator's analysis, and the custom sets (custom) defined by the client.

Information

Each set is linked to an owner (owner), which can be the assignor (assignor_registry) or an analysis related party (analysis_related_party, for guarantors), and to a product type.

To create custom sets, see Signers Definition.

---

Paginated Signer Group Sets Query

Request

ENDPOINT

/assignor_registry/signer_group_sets

METHOD

GET

Query Parameters

Field	Type	Description
limit	integer	Number of items per page (0 to 50). Default: 10.
page	integer	Page to be queried, starting at 0. Default: 0.
owner_key	string	Filters by the owner's identifier (assignor or related party).
owner_type	string	Owner type. See Owner Type.
owner_document_number	string	Owner's document. Requires owner_type in order to be used.
product_type	string	Filters by product type. See Product Type.
status	string	Filters by the set's status. See Signer Group Set Status.

Tip

To list only the sets that are actually being used in signatures, filter by status=valid. Sets in in_analysis still depend on the registration being approved and are not sent for signature.

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": "883.512.866-80",
              "is_required_signer": true
            },
            {
              "document_number": "802.834.257-41",
              "is_required_signer": false
            }
          ],
          "expiration": null
        }
      ]
    }
  ],
  "limit": 10,
  "page": 0,
  "is_last_page": true
}

Pagination Fields

Field	Type	Description
data	array	List of signer group sets on the current page. See Signer Group Set Definition.
limit	integer	Number of items per page used in the query.
page	integer	Page returned, starting at 0.
is_last_page	boolean	Indicates whether this is the last page of the result.

Treatable Errors

Code	HTTP	Cause	How to resolve
ASR000121	400	owner_document_number sent without owner_type.	When filtering by owner_document_number, always provide owner_type as well.
ASR000120	400	Invalid status value in the filter.	Use a valid value for the status filter (see the Signer Group Set Status enum).

---

Definitions

Signer Group Set Definition

Field	Type	Description	Characters
signer_group_set_key	string	Unique identifier of the set.	36
owner_key	string	Owner's identifier. May be assignor_registry_key or analysis_related_party_key.	36
owner_type	string	Owner type.	See Owner Type.
product_type	string	Product type the set is associated with.	See Product Type.
signer_group_set_type	string	Set type (main or custom).	See Signer Group Set Type.
status	string	Set status.	See Signer Group Set Status.
signer_groups	array	List of signer groups that make up the set.	See Signer Group Definition.

---

Signer Group Definition

Field	Type	Description	Characters
minimum_required_signers	number	Minimum number of signers in the group required to validate the signature.	Minimum 1
signers	array	List of signers in the group.	See Signer Definition.
expiration	string	Group expiration date in the YYYY-MM-DD format. Returns null when the group does not expire.	10

---

Signer Definition

Field	Type	Description	Characters
document_number	string	Signer's CPF in the XXX.XXX.XXX-XX format.	14
is_required_signer	boolean	Indicates whether the signer is required in the group.	-

---

Enumerators

Owner Type

Enumerator	Description
assignor_registry	Set linked to the assignor.
analysis_related_party	Set linked to an analysis related party (guarantors).

---

Product Type

Enumerator	Description
assignment_contract	Assignment contract (used by default).
commercial_paper	Commercial Paper (single registration with the bookkeeping platform).

---

Signer Group Set Type

Enumerator	Description
main	Default set, generated from the Administrator's analysis.
custom	Custom set, created by the client, overriding the main set.

---

Signer Group Set Status

Enumerator	Description
in_analysis	Set submitted and attached to the open analysis. Not used in signatures.
valid	Set in force and used in signatures.
inactive	Set replaced by a more recent version, or deactivated.