Signers definition
After submitting the assignor's registration, it is optionally possible to define custom signer sets for the operation. These sets determine which related parties (of the assignor or of guarantors) must sign each document type, with the possibility of rules per product type.
If no custom set is submitted, the system uses the default sets defined by the administrator.
Signer group sets (signer_group_sets) represent groups of signers linked to an owner (owner), which can be the assignor (assignor_registry), a guarantor (guarantor) or the spouse of a natural person guarantor (spouse).
The custom definition allows you, for example, to require multiple signers, or to restrict who can sign a given product.
Custom sets must be defined before the Submission for Analysis stage. After submission for analysis, the sets then in force will be used in the assignment contract signatures.
Defining a Custom Set for the Assignor
Allows the client to replace the assignor's default signer set with one or more custom sets, organized by product. The signers provided must correspond to related parties previously registered as representatives of the assignor.
| Profile | Host | Required permission |
|---|---|---|
| Manager | manager-api | Write |
| Consultant | consultant-api | Register Assignor |
Base URL for each host: Environments (Hosts).
Request
{
"signer_group_sets": [
{
"product": "assignment_contract",
"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
}
],
"expiration": "2026-12-31"
}
]
},
{
"product": "commercial_paper",
"signer_groups": [
{
"minimum_required_signers": 1,
"signers": [
{
"document_number": "123.456.789-09",
"is_required_signer": true
}
],
"expiration": "2026-12-31"
}
]
}
]
}
Response
No content in the response body.
Creating a custom set for the assignor replaces the main (default) set in force for the product provided. Only sets with status equal to valid are used in signatures.
On submission, the signer group starts in the in_analysis status. Signer group sets in this status are not sent for signature. Once the registration is approved, the group moves to the valid status, and only then is it used for signatures, taking precedence over the main signer group.
If the custom signer group submitted is less restrictive than the one validated by the Administrator, the analysis will be denied.
Errors
| Status | Code | When it happens |
|---|---|---|
| 404 | ASR000004 | Assignor not found for the assignor_registry_key provided. Check whether the assignor_registry_key is correct. |
| 404 | ASR000033 | Analysis not found for the analysis_key provided. Check whether the analysis_key is correct. |
| 400 | ASR000066 | The analysis status does not allow custom groups to be defined. The analysis must be in pending_documents to receive custom groups. |
| 404 | ASR000109 | Invalid product type. Use a valid value for product (see the Product Type enum). |
| 400 | ASR000118 | Invalid signer. The document_number sent in signers must correspond to a representative already registered for the assignor, with is_representative=true. |
Authentication, permission and host errors: see API Errors.
Defining a Custom Set for a Related Party
Allows you to define custom sets for a guarantor or for the spouse of a natural person guarantor, using the analysis_related_party_key returned when the analysis was created.
This endpoint customizes the signers of a guarantor or of the spouse of a natural person guarantor, identified by the analysis_related_party_key. For the assignor's own representatives, use the assignor custom set endpoint above. For other related parties, the call does not create a set.
| Profile | Host | Required permission |
|---|---|---|
| Manager | manager-api | Write |
| Consultant | consultant-api | Register Assignor |
Base URL for each host: Environments (Hosts).
Request
{
"signer_group_sets": [
{
"product": "assignment_contract",
"signer_groups": [
{
"minimum_required_signers": 1,
"signers": [
{
"document_number": "111.444.777-35",
"is_required_signer": true
}
],
"expiration": "2026-12-31"
}
]
}
]
}
Response
No content in the response body.
On submission, the signer group starts in the in_analysis status. Signer group sets in this status are not sent for signature. Once the registration is approved, the group moves to the valid status, and only then is it used for signatures, taking precedence over the main signer group.
If the custom signer group submitted is less restrictive than the one validated by the Administrator, the analysis will be denied.
Errors
| Status | Code | When it happens |
|---|---|---|
| 404 | ASR000004 | Assignor not found for the assignor_registry_key provided. Check whether the assignor_registry_key is correct. |
| 404 | ASR000033 | Analysis not found for the analysis_key provided. Check whether the analysis_key is correct. |
| 404 | ASR000035 | Analysis related party not found for the analysis_related_party_key provided. Check whether the analysis_related_party_key corresponds to a guarantor or a guarantor's spouse in the analysis. |
| 400 | ASR000066 | The analysis status does not allow custom groups to be defined. The analysis must be in pending_documents to receive custom groups. |
| 404 | ASR000109 | Invalid product type. Use a valid value for product (see the Product Type enum). |
| 400 | ASR000118 | Invalid signer. The document_number sent in signers must correspond to a representative already registered for the related party (guarantor or guarantor representative). |
Authentication, permission and host errors: see API Errors.
Signer Group Sets Query
To query the sets in force (default and custom) and obtain the signer_group_set_key, use the Signers Query. The owner_type, product_type, signer_group_set_type and status enumerators are documented on that page.
Definitions
Submission Item Definition (Signer Group Set Item)
Structure used in the body of the requests that create custom sets.
| Field | Type | Description | Characters |
|---|---|---|---|
product * | string | Product type the set will be associated with. | See Product Type. |
signer_groups * | array | List of signer groups (minimum 1). | See Signer Group Definition. |
*Required fields.
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 (minimum 1). | See Signer Definition. |
expiration | string | Group expiration date in the YYYY-MM-DD format. Accepted on submission; in the query, expired groups are not returned. | 10 |
*Required fields.
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. | - |
*Required fields.
The document_number values submitted must correspond to related parties (assignor representatives, or representatives of the guarantor in question) present in the assignor's registration. Documents that are not associated with the assignor will be rejected.