Skip to main content

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), a guarantor (guarantor) or the spouse of a natural person guarantor (spouse), and to a product type.

To create custom sets, see Signers Definition.


Paginated Signer Group Sets Query​

Available on
ProfileHostRequired permission
Managermanager-apiRead
Consultantconsultant-apiView Assignors

Base URL for each host: Environments (Hosts).

Request​

ENDPOINT
/assignor_registry/signer_group_sets
METHOD
GET

Query Parameters​

FieldTypeDescription
limitintegerNumber of items per page (0 to 50). Default: 10.
pageintegerPage to be queried, starting at 0. Default: 0.
owner_keystringFilters by the owner's identifier (assignor, guarantor or spouse). See Owner Type.
owner_typestringOwner type. See Owner Type.
owner_document_numberstringOwner's document. Requires owner_type in order to be used.
product_typestringFilters by product type. See Product Type.
statusstringFilters 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": "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
}

Pagination Fields​

FieldTypeDescription
dataarrayList of signer group sets on the current page. See Signer Group Set Definition.
limitintegerNumber of items per page used in the query.
pageintegerPage returned, starting at 0.
is_last_pagebooleanIndicates whether this is the last page of the result.

Errors​

StatusCodeWhen it happens
400ASR000121owner_document_number sent without owner_type. When filtering by owner_document_number, always provide owner_type as well.
400ASR000120Invalid status value in the filter. Use a valid value for the status filter (see the Signer Group Set Status enum).

Authentication, permission and host errors: see API errors.


Definitions​

Signer Group Set Definition​

FieldTypeDescriptionCharacters
signer_group_set_keystringUnique identifier of the set.36
owner_keystringOwner's identifier, according to the owner_type. See Owner Type.36
owner_typestringOwner type.See Owner Type.
product_typestringProduct type the set is associated with.See Product Type.
signer_group_set_typestringSet type (main or custom).See Signer Group Set Type.
statusstringSet status.See Signer Group Set Status.
signer_groupsarrayList of signer groups that make up the set.See Signer Group Definition.

Signer Group Definition​

FieldTypeDescriptionCharacters
minimum_required_signersnumberMinimum number of signers in the group required to validate the signature.Minimum 1
signersarrayList of signers in the group.See Signer Definition.

The query does not return expiration, and groups that have already expired are not returned.


Signer Definition​

FieldTypeDescriptionCharacters
document_numberstringSigner's CPF in the XXX.XXX.XXX-XX format.14
is_required_signerbooleanIndicates whether the signer is required in the group.-

Enumerators​

Owner Type​

EnumeratorDescription
assignor_registryAssignor's set. owner_key = assignor_registry_key.
guarantorA guarantor's set. owner_key = the guarantor's key (guarantor_key).
spouseSet of the spouse of a natural person guarantor. owner_key = the spouse's key (representative_key in guarantor_representatives).

Product Type​

EnumeratorDescription
assignment_contractAssignment contract (used by default).
commercial_paperCommercial Paper (single registration with the bookkeeping platform).

Signer Group Set Type​

EnumeratorDescription
mainDefault set, generated from the Administrator's analysis.
customCustom set, created by the client, overriding the main set.

Signer Group Set Status​

EnumeratorDescription
in_analysisSet submitted and attached to the open analysis. Not used in signatures.
validSet in force and used in signatures.
invalidSet replaced by a more recent submission, or discarded. Not used in signatures.